WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (9 years ago)
Author:
DrewAPicture
Message:

Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the @access notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

    r39436 r41162  
    1919     *
    2020     * @since 4.7.0
    21      * @access protected
    2221     *
    2322     * @return string One of 'post', 'comment', 'term', 'user', or anything
    … …  
    3029     *
    3130     * @since 4.7.0
    32      * @access protected
    3331     *
    3432     * @return string The REST field type, such as post type name, taxonomy name, 'comment', or `user`.
    … …  
    4038     *
    4139     * @since 4.7.0
    42      * @access public
    4340     *
    4441     * @see register_rest_field()
    … …  
    5653     *
    5754     * @since 4.7.0
    58      * @access public
    5955     *
    6056     * @param int             $object_id Object ID to fetch meta for.
    … …  
    9793     *
    9894     * @since 4.7.0
    99      * @access protected
    10095     *
    10196     * @param mixed           $value   Meta value to prepare.
    … …  
    116111     *
    117112     * @since 4.7.0
    118      * @access public
    119113     *
    120114     * @param array           $meta      Array of meta parsed from the request.
    … …  
    168162     *
    169163     * @since 4.7.0
    170      * @access protected
    171164     *
    172165     * @param int    $object_id Object ID the field belongs to.
    … …  
    203196     *
    204197     * @since 4.7.0
    205      * @access protected
    206198     *
    207199     * @param int    $object_id Object ID to update.
    … …  
    275267     *
    276268     * @since 4.7.0
    277      * @access protected
    278269     *
    279270     * @param int    $object_id Object ID to update.
    … …  
    321312     *
    322313     * @since 4.7.0
    323      * @access protected
    324314     *
    325315     * @return array Registered fields.
    … …  
    380370     *
    381371     * @since 4.7.0
    382      * @access protected
    383372     *
    384373     * @return array Field schema data.
    … …  
    412401     *
    413402     * @since 4.7.0
    414      * @access public
    415403     *
    416404     * @param mixed           $value   Meta value from the database.
    … …  
    454442     *
    455443     * @since 4.7.0
    456      * @access public
    457444     *
    458445     * @param  mixed           $value   The meta value submitted in the request.
Note: See TracChangeset for help on using the changeset viewer.