Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (7 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/class-wp-rest-response.php

    r37674 r41162  
    2121     *
    2222     * @since 4.4.0
    23      * @access protected
    2423     * @var array
    2524     */
     
    3029     *
    3130     * @since 4.4.0
    32      * @access protected
    3331     * @var string
    3432     */
     
    3937     *
    4038     * @since 4.4.0
    41      * @access protected
    4239     * @var null|array
    4340     */
     
    5047     *
    5148     * @since 4.4.0
    52      * @access public
    5349     *
    5450     * @link https://tools.ietf.org/html/rfc5988
     
    8076     *
    8177     * @since 4.4.0
    82      * @access public
    8378     *
    8479     * @param  string $rel  Link relation. Either an IANA registered type, or an absolute URL.
     
    111106     *
    112107     * @since 4.4.0
    113      * @access public
    114108     *
    115109     * @param array $links Map of link relation to list of links.
     
    132126     *
    133127     * @since 4.4.0
    134      * @access public
    135128     *
    136129     * @return array List of links.
     
    146139     *
    147140     * @since 4.4.0
    148      * @access public
    149141     *
    150142     * @link https://tools.ietf.org/html/rfc5988
     
    172164     *
    173165     * @since 4.4.0
    174      * @access public
    175166     *
    176167     * @return string The matched route.
     
    184175     *
    185176     * @since 4.4.0
    186      * @access public
    187177     *
    188178     * @param string $route Route name.
     
    196186     *
    197187     * @since 4.4.0
    198      * @access public
    199188     *
    200189     * @return null|array The handler that was used to create the response.
     
    208197     *
    209198     * @since 4.4.0
    210      * @access public
    211199     *
    212200     * @param array $handler The matched handler.
     
    220208     *
    221209     * @since 4.4.0
    222      * @access public
    223210     *
    224211     * @return bool Whether the response is an error.
     
    232219     *
    233220     * @since 4.4.0
    234      * @access public
    235221     *
    236222     * @return WP_Error|null WP_Error or null on not an errored response.
     
    262248     *
    263249     * @since 4.5.0
    264      * @access public
    265250     *
    266251     * @return array Compact URIs.
Note: See TracChangeset for help on using the changeset viewer.