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/class-wp-hook.php

    r40948 r41162  
    2222     *
    2323     * @since 4.7.0
    24      * @access public
    2524     * @var array
    2625     */
     
    3130     *
    3231     * @since 4.7.0
    33      * @access private
    3432     * @var array
    3533     */
     
    4038     *
    4139     * @since 4.7.0
    42      * @access private
    4340     * @var array
    4441     */
     
    4946     *
    5047     * @since 4.7.0
    51      * @access private
    5248     * @var int
    5349     */
     
    5854     *
    5955     * @since 4.7.0
    60      * @access private
    6156     * @var bool
    6257     */
     
    6762     *
    6863     * @since 4.7.0
    69      * @access public
    7064     *
    7165     * @param string   $tag             The name of the filter to hook the $function_to_add callback to.
     
    10094     *
    10195     * @since 4.7.0
    102      * @access private
    10396     *
    10497     * @param bool|int $new_priority     Optional. The priority of the new filter being added. Default false,
     
    169162     *
    170163     * @since 4.7.0
    171      * @access public
    172164     *
    173165     * @param string   $tag                The filter hook to which the function to be removed is hooked. Used
     
    197189     *
    198190     * @since 4.7.0
    199      * @access public
    200191     *
    201192     * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
     
    227218     *
    228219     * @since 4.7.0
    229      * @access public
    230220     *
    231221     * @return bool True if callbacks have been registered for the current hook, otherwise false.
     
    244234     *
    245235     * @since 4.7.0
    246      * @access public
    247236     *
    248237     * @param int|bool $priority Optional. The priority number to remove. Default false.
     
    268257     *
    269258     * @since 4.7.0
    270      * @access public
    271259     *
    272260     * @param mixed $value The value to filter.
     
    315303     *
    316304     * @since 4.7.0
    317      * @access public
    318305     *
    319306     * @param mixed $args Arguments to pass to the hook callbacks.
     
    333320     *
    334321     * @since 4.7.0
    335      * @access public
    336322     *
    337323     * @param array $args Arguments to pass to the hook callbacks. Passed by reference.
     
    356342     *
    357343     * @since 4.7.0
    358      * @access public
    359344     *
    360345     * @return int|false If the hook is running, return the current priority level. If it isn't running, return false.
     
    372357     *
    373358     * @since 4.7.0
    374      * @access public
    375359     * @static
    376360     *
     
    406390     *
    407391     * @since 4.7.0
    408      * @access public
    409392     *
    410393     * @link https://secure.php.net/manual/en/arrayaccess.offsetexists.php
     
    421404     *
    422405     * @since 4.7.0
    423      * @access public
    424406     *
    425407     * @link https://secure.php.net/manual/en/arrayaccess.offsetget.php
     
    436418     *
    437419     * @since 4.7.0
    438      * @access public
    439420     *
    440421     * @link https://secure.php.net/manual/en/arrayaccess.offsetset.php
     
    455436     *
    456437     * @since 4.7.0
    457      * @access public
    458438     *
    459439     * @link https://secure.php.net/manual/en/arrayaccess.offsetunset.php
     
    469449     *
    470450     * @since 4.7.0
    471      * @access public
    472451     *
    473452     * @link https://secure.php.net/manual/en/iterator.current.php
     
    483462     *
    484463     * @since 4.7.0
    485      * @access public
    486464     *
    487465     * @link https://secure.php.net/manual/en/iterator.next.php
     
    497475     *
    498476     * @since 4.7.0
    499      * @access public
    500477     *
    501478     * @link https://secure.php.net/manual/en/iterator.key.php
     
    511488     *
    512489     * @since 4.7.0
    513      * @access public
    514490     *
    515491     * @link https://secure.php.net/manual/en/iterator.valid.php
     
    525501     *
    526502     * @since 4.7.0
    527      * @access public
    528503     *
    529504     * @link https://secure.php.net/manual/en/iterator.rewind.php
Note: See TracChangeset for help on using the changeset viewer.