WP_REST_Term_Meta_Fields
Core class used to manage meta values for terms via the REST API.
Description
See also
Source
File: wp-includes/rest-api/fields/class-wp-rest-term-meta-fields.php
class WP_REST_Term_Meta_Fields extends WP_REST_Meta_Fields {
/**
* Taxonomy to register fields for.
*
* @since WP-4.7.0
* @var string
*/
protected $taxonomy;
/**
* Constructor.
*
* @since WP-4.7.0
*
* @param string $taxonomy Taxonomy to register fields for.
*/
public function __construct( $taxonomy ) {
$this->taxonomy = $taxonomy;
}
/**
* Retrieves the object meta type.
*
* @since WP-4.7.0
*
* @return string The meta type.
*/
protected function get_meta_type() {
return 'term';
}
/**
* Retrieves the object meta subtype.
*
* @since WP-4.9.8
*
* @return string Subtype for the meta type, or empty string if no specific subtype.
*/
protected function get_meta_subtype() {
return $this->taxonomy;
}
/**
* Retrieves the type for register_rest_field().
*
* @since WP-4.7.0
*
* @return string The REST field type.
*/
public function get_rest_field_type() {
return 'post_tag' === $this->taxonomy ? 'tag' : $this->taxonomy;
}
}
Methods
- __construct — Constructor.
- get_meta_subtype — Retrieves the object meta subtype.
- get_meta_type — Retrieves the object meta type.
- get_rest_field_type — Retrieves the type for register_rest_field().
Changelog
Version | Description |
---|---|
WP-4.7.0 | Introduced. |