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

Props Soean, mrahmadawais, flixos90.
See #38398.


git-svn-id: https://develop.svn.wordpress.org/trunk@39023 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-10-30 16:35:30 +00:00
parent 79ed959c30
commit bc917ac0c7
1 changed files with 32 additions and 4 deletions

View File

@ -1,9 +1,26 @@
<?php
/**
* REST API: WP_REST_Post_Meta_Fields class
*
* @package WordPress
* @subpackage REST_API
* @since 4.7.0
*/
/**
* Core class used to manage meta values for posts via the REST API.
*
* @since 4.7.0
*
* @see WP_REST_Meta_Fields
*/
class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {
/**
* Post type to register fields for.
*
* @since 4.7.0
* @access protected
* @var string
*/
protected $post_type;
@ -11,6 +28,9 @@ class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {
/**
* Constructor.
*
* @since 4.7.0
* @access public
*
* @param string $post_type Post type to register fields for.
*/
public function __construct( $post_type ) {
@ -18,18 +38,26 @@ class WP_REST_Post_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 'post';
}
/**
* Get the type for `register_rest_field`.
* Retrieves the type for register_rest_field().
*
* @return string Custom post type slug.
* @since 4.7.0
* @access public
*
* @see register_rest_field()
*
* @return string The REST field type.
*/
public function get_rest_field_type() {
return $this->post_type;