register_term_meta() WordPress Function
The register_term_meta() function is used to register metadata for terms in a taxonomy. This function can be used to store information about a term, such as an image or description. The register_term_meta() function takes two arguments: the taxonomy name and an array of metadata fields. The array of metadata fields must include at least one field with the 'type' key set to 'string'.
register_term_meta( string $taxonomy, string $meta_key, array $args ) #
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.
Return
(bool) True if the meta key was successfully registered, false if not.
Source
File: wp-includes/taxonomy.php
function register_term_meta( $taxonomy, $meta_key, array $args ) {
$args['object_subtype'] = $taxonomy;
return register_meta( 'term', $meta_key, $args );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.9.8 | Introduced. |