register_term_meta( string $taxonomy, string $meta_key, array $args ): bool

Registers a meta key for terms.

Contents

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 string
    A 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 string
    The type of data associated with this meta key.
    Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'.
  • description string
    A description of the data attached to this meta key.
  • single bool
    Whether the meta key has one value per object, or an array of values per object.
  • default mixed
    The 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 to false, the default value given here will be wrapped in an array.
  • sanitize_callback callable
    A function or method to call when sanitizing $meta_key data.
  • auth_callback callable
    Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks.
  • show_in_rest bool|array
    Whether 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.

Top ↑

Return

bool True if the meta key was successfully registered, false if not.

Top ↑

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 );
}

View on Trac View on GitHub

Top ↑

Top ↑

Changelog

Changelog
Version Description
4.9.8 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by tzkmx —

    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.

    register_term_meta( 'replica', 'nice_field', array(
    'type' => 'string',
    'description' => 'a nice description',
    'single' => true,
    'show_in_rest' => array(
        'schema' => array(
            'type' => 'string',
            'format' => 'url',
            'context' => array( 'view', 'edit' ),
            'readonly' => true,
       )
    ),
) );

    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

You must log in before being able to contribute a note or feedback.