Docs: Add much more complete and syntactically correct documentation throughout the WP_REST_Term_Meta_Fields
class.
Props Soean, mrahmadawais, flixos90. See #38398. git-svn-id: https://develop.svn.wordpress.org/trunk@39032 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
b3bb03b33a
commit
75a1951892
@ -1,18 +1,36 @@
|
||||
<?php
|
||||
/**
|
||||
* REST API: WP_REST_Term_Meta_Fields class
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage REST_API
|
||||
* @since 4.7.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Manage meta values for terms.
|
||||
* Core class used to manage meta values for terms via the REST API.
|
||||
*
|
||||
* @since 4.7.0
|
||||
*
|
||||
* @see WP_REST_Meta_Fields
|
||||
*/
|
||||
class WP_REST_Term_Meta_Fields extends WP_REST_Meta_Fields {
|
||||
|
||||
/**
|
||||
* Taxonomy to register fields for.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access protected
|
||||
* @var string
|
||||
*/
|
||||
protected $taxonomy;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $taxonomy Taxonomy to register fields for.
|
||||
*/
|
||||
public function __construct( $taxonomy ) {
|
||||
@ -20,18 +38,24 @@ class WP_REST_Term_Meta_Fields extends WP_REST_Meta_Fields {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the object type for meta.
|
||||
* Retrieves the object meta type.
|
||||
*
|
||||
* @return string
|
||||
* @since 4.7.0
|
||||
* @access protected
|
||||
*
|
||||
* @return string The meta type.
|
||||
*/
|
||||
protected function get_meta_type() {
|
||||
return 'term';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the type for `register_rest_field`.
|
||||
* Retrieves the type for register_rest_field().
|
||||
*
|
||||
* @return string
|
||||
* @since 4.7.0
|
||||
* @access public
|
||||
*
|
||||
* @return string The REST field type.
|
||||
*/
|
||||
public function get_rest_field_type() {
|
||||
return 'post_tag' === $this->taxonomy ? 'tag' : $this->taxonomy;
|
||||
|
Loading…
Reference in New Issue
Block a user