WordPress.org

Make WordPress Core

Changeset 39023


Ignore:
Timestamp:
10/30/2016 04:35:30 PM (4 years ago)
Author:
DrewAPicture
Message:

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

Props Soean, mrahmadawais, flixos90.
See #38398.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/rest-api/fields/class-wp-rest-post-meta-fields.php

    r38832 r39023  
    11<?php
     2/**
     3 * REST API: WP_REST_Post_Meta_Fields class
     4 *
     5 * @package WordPress
     6 * @subpackage REST_API
     7 * @since 4.7.0
     8 */
    29
     10/**
     11 * Core class used to manage meta values for posts via the REST API.
     12 *
     13 * @since 4.7.0
     14 *
     15 * @see WP_REST_Meta_Fields
     16 */
    317class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {
     18
    419    /**
    520     * Post type to register fields for.
    621     *
     22     * @since 4.7.0
     23     * @access protected
    724     * @var string
    825     */
     
    1128    /**
    1229     * Constructor.
     30     *
     31     * @since 4.7.0
     32     * @access public
    1333     *
    1434     * @param string $post_type Post type to register fields for.
     
    1939
    2040    /**
    21      * Get the object type for meta.
     41     * Retrieves the object meta type.
    2242     *
    23      * @return string
     43     * @since 4.7.0
     44     * @access protected
     45     *
     46     * @return string The meta type.
    2447     */
    2548    protected function get_meta_type() {
     
    2851
    2952    /**
    30      * Get the type for `register_rest_field`.
     53     * Retrieves the type for register_rest_field().
    3154     *
    32      * @return string Custom post type slug.
     55     * @since 4.7.0
     56     * @access public
     57     *
     58     * @see register_rest_field()
     59     *
     60     * @return string The REST field type.
    3361     */
    3462    public function get_rest_field_type() {
Note: See TracChangeset for help on using the changeset viewer.