Docs: Add much more complete and syntactically correct documentation throughout the `WP_REST_Term_Meta_Fields` class.

Props Soean, mrahmadawais, flixos90.
See #38398.

Built from https://develop.svn.wordpress.org/trunk@39032


git-svn-id: http://core.svn.wordpress.org/trunk@38974 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-10-30 18:09:32 +00:00
parent 7d7d0c8599
commit b71e62b9eb
2 changed files with 30 additions and 6 deletions

View File

@ -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;

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.7-beta1-39031';
$wp_version = '4.7-beta1-39032';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.