WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

register_term_meta()

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

In this article

Back to top

Registers a meta key for terms.

Parameters

$taxonomystringrequired
Taxonomy to register a meta key for. Pass an empty string to register the meta key across all existing taxonomies.
$meta_keystringrequired
The meta key to register.
$argsarrayrequired
Data used to describe the meta key when registered. See register_meta() for a list of supported arguments.

Return

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

Source

function register_term_meta( $taxonomy, $meta_key, array $args ) {
	$args['object_subtype'] = $taxonomy;

	return register_meta( 'term', $meta_key, $args );
}

View all references View on Trac View on GitHub

UsesDescription
register_meta()wp-includes/meta.php

Registers a meta key.

Changelog

VersionDescription
4.9.8Introduced.

User Contributed Notes

  1. Skip to note 3 content
    tzkmx
    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

    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.