WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (8 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-server.php

    r40961 r41162  
    5959     *
    6060     * @since 4.4.0
    61      * @access protected
    6261     * @var array
    6362     */
    … …  
    6867     *
    6968     * @since 4.4.0
    70      * @access protected
    7169     * @var array
    7270     */
    … …  
    7775     *
    7876     * @since 4.4.0
    79      * @access protected
    8077     * @var array
    8178     */
    … …  
    8683     *
    8784     * @since 4.4.0
    88      * @access public
    8985     */
    9086    public function __construct() {
    … …  
    108104     *
    109105     * @since 4.4.0
    110      * @access public
    111106     *
    112107     * @return WP_Error|null WP_Error indicates unsuccessful login, null indicates successful
    … …  
    149144     *
    150145     * @since 4.4.0
    151      * @access protected
    152146     *
    153147     * @param WP_Error $error WP_Error instance.
    … …  
    192186     *
    193187     * @since 4.4.0
    194      * @access protected
    195188     *
    196189     * @param string $code    WP_Error-style code.
    … …  
    216209     *
    217210     * @since 4.4.0
    218      * @access public
    219211     *
    220212     * @see WP_REST_Server::dispatch()
    … …  
    426418     *
    427419     * @since 4.4.0
    428      * @access public
    429420     *
    430421     * @param WP_REST_Response $response Response object.
    … …  
    464455     *
    465456     * @since 4.4.0
    466      * @access public
    467457     * @static
    468458     *
    … …  
    498488     *
    499489     * @since 4.5.0
    500      * @access public
    501490     * @static
    502491     *
    … …  
    548537     *
    549538     * @since 4.4.0
    550      * @access protected
    551539     *
    552540     * @param array $data Data from the request.
    … …  
    624612     *
    625613     * @since 4.4.0
    626      * @access public
    627614     *
    628615     * @param WP_REST_Response $response Response object.
    … …  
    655642     *
    656643     * @since 4.4.0
    657      * @access public
    658644     *
    659645     * @param string $namespace  Namespace.
    … …  
    710696     *
    711697     * @since 4.4.0
    712      * @access public
    713698     *
    714699     * @return array `'/path/regex' => array( $callback, $bitmask )` or
    … …  
    785770     *
    786771     * @since 4.4.0
    787      * @access public
    788772     *
    789773     * @return array List of registered namespaces.
    … …  
    797781     *
    798782     * @since 4.4.0
    799      * @access public
    800783     *
    801784     * @param string $route Route pattern to fetch options for.
    … …  
    814797     *
    815798     * @since 4.4.0
    816      * @access public
    817799     *
    818800     * @param WP_REST_Request $request Request to attempt dispatching.
    … …  
    994976     *
    995977     * @since 4.4.0
    996      * @access protected
    997978     *
    998979     * @return bool|string Boolean false or string error message.
    … …  
    10191000     *
    10201001     * @since 4.4.0
    1021      * @access public
    10221002     *
    10231003     * @param array $request {
    … …  
    10641044     *
    10651045     * @since 4.4.0
    1066      * @access public
    10671046     *
    10681047     * @param WP_REST_Request $request REST request instance.
    … …  
    11071086     *
    11081087     * @since 4.4.0
    1109      * @access public
    11101088     *
    11111089     * @param array  $routes  Routes to get data for.
    … …  
    11521130     *
    11531131     * @since 4.4.0
    1154      * @access public
    11551132     *
    11561133     * @param string $route     Route to get data for.
    … …  
    12381215     *
    12391216     * @since 4.4.0
    1240      * @access protected
    12411217     *
    12421218     * @param int $code HTTP status.
    … …  
    12501226     *
    12511227     * @since 4.4.0
    1252      * @access public
    12531228     *
    12541229     * @param string $key Header key.
    … …  
    12711246     *
    12721247     * @since 4.4.0
    1273      * @access public
    12741248     *
    12751249     * @param array $headers Map of header name to header value.
    … …  
    12851259     *
    12861260     * @since 4.8.0
    1287      * @access public
    12881261     *
    12891262     * @param string $key Header key.
    … …  
    13091282     *
    13101283     * @since 4.4.0
    1311      * @access public
    13121284     *
    13131285     * @global string $HTTP_RAW_POST_DATA Raw post data.
    … …  
    13331305     *
    13341306     * @since 4.4.0
    1335      * @access public
    13361307     *
    13371308     * @param array $server Associative array similar to `$_SERVER`.
Note: See TracChangeset for help on using the changeset viewer.