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

    r40993 r41162  
    4747     *
    4848     * @since 2.1.0
    49      * @access public
    5049     * @var int
    5150     */
     
    5655     *
    5756     * @since 2.0.0
    58      * @access public
    5957     * @var array
    6058     */
     
    6563     *
    6664     * @since 2.0.0
    67      * @access public
    6865     * @var string
    6966     */
     
    7471     *
    7572     * @since 2.0.0
    76      * @access public
    7773     * @var array
    7874     */
     
    8379     *
    8480     * @since 2.0.0
    85      * @access public
    8681     * @var array
    8782     */
     
    9287     *
    9388     * @since 2.9.0
    94      * @access public
    9589     * @var string
    9690     */
     
    10094     * @static
    10195     * @since 3.3.0
    102      * @access private
    10396     * @var array
    10497     */
     
    111104     *
    112105     * @since 2.0.0
    113      * @access public
    114106     *
    115107     * @global wpdb $wpdb WordPress database abstraction object.
     
    251243     *
    252244     * @since 4.3.0
    253      * @access public
    254245     *
    255246     * @param callable $name      Method to call.
     
    268259     *
    269260     * @since 3.3.0
    270      * @access public
    271261     *
    272262     * @param string $key User meta key to check if set.
     
    298288     *
    299289     * @since 3.3.0
    300      * @access public
    301290     *
    302291     * @param string $key User meta key to retrieve.
     
    337326     *
    338327     * @since 3.3.0
    339      * @access public
    340328     *
    341329     * @param string $key   User meta key.
     
    362350     *
    363351     * @since 4.4.0
    364      * @access public
    365352     *
    366353     * @param string $key User meta key to unset.
     
    390377     *
    391378     * @since 3.4.0
    392      * @access public
    393379     *
    394380     * @return bool True if user exists in the database, false if not.
     
    445431     * used.
    446432     *
    447      * @access protected
    448433     * @since 2.1.0
    449434     *
     
    477462     *
    478463     * @since 2.0.0
    479      * @access public
    480464     *
    481465     * @return array List of all capabilities for the user.
     
    505489     *
    506490     * @since 2.0.0
    507      * @access public
    508491     *
    509492     * @param string $role Role name.
     
    534517     *
    535518     * @since 2.0.0
    536      * @access public
    537519     *
    538520     * @param string $role Role name.
     
    565547     *
    566548     * @since 2.0.0
    567      * @access public
    568549     *
    569550     * @param string $role Role name.
     
    613594     *
    614595     * @since 2.0.0
    615      * @access public
    616596     *
    617597     * @param int $max Max level of user.
     
    636616     *
    637617     * @since 2.0.0
    638      * @access public
    639618     *
    640619     * @global wpdb $wpdb WordPress database abstraction object.
     
    650629     *
    651630     * @since 2.0.0
    652      * @access public
    653631     *
    654632     * @param string $cap Capability name.
     
    666644     *
    667645     * @since 2.0.0
    668      * @access public
    669646     *
    670647     * @param string $cap Capability name.
     
    684661     *
    685662     * @since 2.1.0
    686      * @access public
    687663     *
    688664     * @global wpdb $wpdb WordPress database abstraction object.
     
    703679     *
    704680     * @since 2.0.0
    705      * @access public
    706681     *
    707682     * @see map_meta_cap()
     
    767742     *
    768743     * @since 2.0.0
    769      * @access public
    770744     *
    771745     * @param int $level Level number, 1 to 10.
Note: See TracChangeset for help on using the changeset viewer.