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

Props Soean, mrahmadawais, flixos90.
See #38398.


git-svn-id: https://develop.svn.wordpress.org/trunk@39014 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-10-30 06:33:34 +00:00
parent fff3c88cb1
commit 6b4e878a0d

View File

@ -1,19 +1,40 @@
<?php
/**
* REST API: WP_REST_Comment_Meta_Fields class
*
* @package WordPress
* @subpackage REST_API
* @since 4.7.0
*/
/**
* Core class to manage comment meta via the REST API.
*
* @since 4.7.0
*
* @see WP_REST_Meta_Fields
*/
class WP_REST_Comment_Meta_Fields extends WP_REST_Meta_Fields {
/**
* Get the object type for meta.
* Retrieves the object type for comment meta.
*
* @return string
* @since 4.7.0
* @access protected
*
* @return string The meta type.
*/
protected function get_meta_type() {
return 'comment';
}
/**
* Get the type for `register_rest_field`.
* Retrieves the type for register_rest_field() in the context of comments.
*
* @return string
* @since 4.7.0
* @access public
*
* @return string The REST field type.
*/
public function get_rest_field_type() {
return 'comment';