WordPress.org
Get WordPress

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-request.php

    r40815 r41162  
    3333     *
    3434     * @since 4.4.0
    35      * @access protected
    3635     * @var string
    3736     */
    … …  
    4544     *
    4645     * @since 4.4.0
    47      * @access protected
    4846     * @var array Contains GET, POST and FILES keys mapping to arrays of data.
    4947     */
    … …  
    5452     *
    5553     * @since 4.4.0
    56      * @access protected
    5754     * @var array Map of key to value. Key is always lowercase, as per HTTP specification.
    5855     */
    … …  
    6360     *
    6461     * @since 4.4.0
    65      * @access protected
    6662     * @var string Binary data from the request.
    6763     */
    … …  
    7268     *
    7369     * @since 4.4.0
    74      * @access protected
    7570     * @var string
    7671     */
    … …  
    8479     *
    8580     * @since 4.4.0
    86      * @access protected
    8781     * @var array Attributes for the request.
    8882     */
    … …  
    9589     *
    9690     * @since 4.4.0
    97      * @access protected
    9891     * @var bool
    9992     */
    … …  
    10497     *
    10598     * @since 4.4.0
    106      * @access protected
    10799     * @var bool
    108100     */
    … …  
    113105     *
    114106     * @since 4.4.0
    115      * @access public
    116107     *
    117108     * @param string $method     Optional. Request method. Default empty.
    … …  
    141132     *
    142133     * @since 4.4.0
    143      * @access public
    144134     *
    145135     * @return string HTTP method.
    … …  
    153143     *
    154144     * @since 4.4.0
    155      * @access public
    156145     *
    157146     * @param string $method HTTP method.
    … …  
    165154     *
    166155     * @since 4.4.0
    167      * @access public
    168156     *
    169157     * @return array Map of key to value. Key is always lowercase, as per HTTP specification.
    … …  
    187175     *
    188176     * @since 4.4.0
    189      * @access public
    190177     * @static
    191178     *
    … …  
    208195     *
    209196     * @since 4.4.0
    210      * @access public
    211197     *
    212198     * @param string $key Header name, will be canonicalized to lowercase.
    … …  
    227213     *
    228214     * @since 4.4.0
    229      * @access public
    230215     *
    231216     * @param string $key Header name, will be canonicalized to lowercase.
    … …  
    246231     *
    247232     * @since 4.4.0
    248      * @access public
    249233     *
    250234     * @param string $key   Header name.
    … …  
    262246     *
    263247     * @since 4.4.0
    264      * @access public
    265248     *
    266249     * @param string $key   Header name.
    … …  
    282265     *
    283266     * @since 4.4.0
    284      * @access public
    285267     *
    286268     * @param string $key Header name.
    … …  
    295277     *
    296278     * @since 4.4.0
    297      * @access public
    298279     *
    299280     * @param array $headers  Map of header name to value.
    … …  
    314295     *
    315296     * @since 4.4.0
    316      * @access public
    317297     *
    318298     * @return array Map containing 'value' and 'parameters' keys.
    … …  
    349329     *
    350330     * @since 4.4.0
    351      * @access protected
    352331     *
    353332     * @return array List of types to check, in order of priority.
    … …  
    401380     *
    402381     * @since 4.4.0
    403      * @access public
    404382     *
    405383     * @param string $key Parameter name.
    … …  
    423401     *
    424402     * @since 4.4.0
    425      * @access public
    426403     *
    427404     * @param string $key   Parameter name.
    … …  
    440417     *
    441418     * @since 4.4.0
    442      * @access public
    443419     *
    444420     * @return array Map of key to value.
    … …  
    466442     *
    467443     * @since 4.4.0
    468      * @access public
    469444     *
    470445     * @return array Parameter map of key to value.
    … …  
    480455     *
    481456     * @since 4.4.0
    482      * @access public
    483457     *
    484458     * @param array $params Parameter map of key to value.
    … …  
    494468     *
    495469     * @since 4.4.0
    496      * @access public
    497470     *
    498471     * @return array Parameter map of key to value
    … …  
    508481     *
    509482     * @since 4.4.0
    510      * @access public
    511483     *
    512484     * @param array $params Parameter map of key to value.
    … …  
    522494     *
    523495     * @since 4.4.0
    524      * @access public
    525496     *
    526497     * @return array Parameter map of key to value.
    … …  
    536507     *
    537508     * @since 4.4.0
    538      * @access public
    539509     *
    540510     * @param array $params Parameter map of key to value.
    … …  
    550520     *
    551521     * @since 4.4.0
    552      * @access public
    553522     *
    554523     * @return array Parameter map of key to value
    … …  
    564533     *
    565534     * @since 4.4.0
    566      * @access public
    567535     *
    568536     * @param array $params Parameter map of key to value.
    … …  
    578546     *
    579547     * @since 4.4.0
    580      * @access public
    581548     *
    582549     * @return array Parameter map of key to value
    … …  
    592559     *
    593560     * @since 4.4.0
    594      * @access public
    595561     *
    596562     * @param array $params Parameter map of key to value.
    … …  
    604570     *
    605571     * @since 4.4.0
    606      * @access public
    607572     *
    608573     * @return string Binary data from the request body.
    … …  
    616581     *
    617582     * @since 4.4.0
    618      * @access public
    619583     *
    620584     * @param string $data Binary data from the request body.
    … …  
    633597     *
    634598     * @since 4.4.0
    635      * @access public
    636599     *
    637600     * @return array Parameter map of key to value.
    … …  
    651614     * @since 4.4.0
    652615     * @since 4.7.0 Returns error instance if value cannot be decoded.
    653      * @access protected
    654616     * @return true|WP_Error True if the JSON data was passed or no JSON data was provided, WP_Error if invalid JSON was passed.
    655617     */
    … …  
    707669     *
    708670     * @since 4.4.0
    709      * @access protected
    710671     */
    711672    protected function parse_body_params() {
    … …  
    748709     *
    749710     * @since 4.4.0
    750      * @access public
    751711     *
    752712     * @return string Route matching regex.
    … …  
    760720     *
    761721     * @since 4.4.0
    762      * @access public
    763722     *
    764723     * @param string $route Route matching regex.
    … …  
    774733     *
    775734     * @since 4.4.0
    776      * @access public
    777735     *
    778736     * @return array Attributes for the request.
    … …  
    786744     *
    787745     * @since 4.4.0
    788      * @access public
    789746     *
    790747     * @param array $attributes Attributes for the request.
    … …  
    801758     *
    802759     * @since 4.4.0
    803      * @access public
    804760     *
    805761     * @return true|WP_Error True if parameters were sanitized, WP_Error if an error occurred during sanitization.
    … …  
    857813     *
    858814     * @since 4.4.0
    859      * @access public
    860815     *
    861816     * @return bool|WP_Error True if there are no parameters to validate or if all pass validation,
    … …  
    925880     *
    926881     * @since 4.4.0
    927      * @access public
    928882     *
    929883     * @param string $offset Parameter name.
    … …  
    946900     *
    947901     * @since 4.4.0
    948      * @access public
    949902     *
    950903     * @param string $offset Parameter name.
    … …  
    959912     *
    960913     * @since 4.4.0
    961      * @access public
    962914     *
    963915     * @param string $offset Parameter name.
    … …  
    972924     *
    973925     * @since 4.4.0
    974      * @access public
    975926     *
    976927     * @param string $offset Parameter name.
    … …  
    990941     * @static
    991942     * @since 4.5.0
    992      * @access public
    993943     *
    994944     * @param string $url URL with protocol, domain, path and query args.
Note: See TracChangeset for help on using the changeset viewer.