register_term_meta( string $taxonomy, string $meta_key, array $args ): bool
Registers a meta key for terms.
Parameters
-
$taxonomy
string Required -
Taxonomy to register a meta key for. Pass an empty string to register the meta key across all existing taxonomies.
-
$meta_key
string Required -
The meta key to register.
-
$args
array Required -
Data used to describe the meta key when registered. See register_meta() for a list of supported arguments.
More Arguments from register_meta( ... $args )
Data used to describe the meta key when registered.
object_subtype
stringA subtype; e.g. if the object type is "post", the post type. If left empty, the meta key will be registered on the entire object type. Default empty.type
stringThe type of data associated with this meta key.
Valid values are'string'
,'boolean'
,'integer'
,'number'
,'array'
, and'object'
.description
stringA description of the data attached to this meta key.single
boolWhether the meta key has one value per object, or an array of values per object.default
mixedThe default value returned from get_metadata() if no value has been set yet.
When using a non-single meta key, the default value is for the first entry.
In other words, when calling get_metadata() with$single
set tofalse
, the default value given here will be wrapped in an array.sanitize_callback
callableA function or method to call when sanitizing$meta_key
data.auth_callback
callableOptional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks.show_in_rest
bool|arrayWhether data associated with this meta key can be considered public and should be accessible via the REST API. A custom post type must also declare support for custom fields for registered meta to be accessible via REST.
When registering complex meta values this argument may optionally be an array with'schema'
or'prepare_callback'
keys instead of a boolean.
Return
bool True if the meta key was successfully registered, false if not.
Source
File: wp-includes/taxonomy.php
.
View all references
function register_term_meta( $taxonomy, $meta_key, array $args ) {
$args['object_subtype'] = $taxonomy;
return register_meta( 'term', $meta_key, $args );
}
Changelog
Version | Description |
---|---|
4.9.8 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Using this function with a specified schema makes its value available both in queries to get the value on the taxonomy and in the schema available through a request with OPTIONS method to the same endpoint.
Notes:
– It is currently documented only for non scalar values (array and objects), but it’s valid using it for single values also.
– It is available from version version 4.9.8
In WP Core, `register_meta()` is only used by `register_post_meta` and `register_term_meta()`, and otherwise none of these functions are used in Core.
Jetpack uses `register_post_meta()`, and `register_meta()` for ‘post’ and ‘user’, but not `register_term_meta()`.