Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:39:34 AM (9 years ago)
Author:
DrewAPicture
Message:

Docs: Remove @access notations from method DocBlocks in wp-admin/* 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-admin/includes/class-wp-users-list-table.php

    r41150 r41161  
    2222         *
    2323         * @since 3.1.0
    24          * @access public
    2524         * @var int
    2625         */
     
    3130         *
    3231         * @since 3.1.0
    33          * @access public
    3432         * @var bool
    3533         */
     
    4038         *
    4139         * @since 3.1.0
    42          * @access public
    4340         *
    4441         * @see WP_List_Table::__construct() for more information on default arguments.
     
    6360         *
    6461         * @since 3.1.0
    65          * @access public
    6662         *
    6763         * @return bool
     
    7874         *
    7975         * @since 3.1.0
    80          * @access public
    8176         *
    8277         * @global string $role
     
    150145         *
    151146         * @since 3.1.0
    152          * @access public
    153147         */
    154148        public function no_items() {
     
    164158         *
    165159         * @since  3.1.0
    166          * @access protected
    167160         *
    168161         * @global string $role
     
    230223         *
    231224         * @since  3.1.0
    232          * @access protected
    233225         *
    234226         * @return array Array of bulk actions.
     
    252244         *
    253245         * @since 3.1.0
    254          * @access protected
    255246         *
    256247         * @param string $which Whether this is being invoked above ("top")
     
    303294         *
    304295         * @since  3.1.0
    305          * @access public
    306296         *
    307297         * @return string The bulk action required.
     
    320310         *
    321311         * @since  3.1.0
    322          * @access public
    323312         *
    324313         * @return array Array in which the key is the ID of the column,
     
    345334         *
    346335         * @since 3.1.0
    347          * @access protected
    348336         *
    349337         * @return array Array of sortable columns.
     
    362350         *
    363351         * @since 3.1.0
    364          * @access public
    365352         */
    366353        public function display_rows() {
     
    380367         * @since 4.2.0 The `$style` parameter was deprecated.
    381368         * @since 4.4.0 The `$role` parameter was deprecated.
    382          * @access public
    383369         *
    384370         * @param WP_User $user_object The current user object.
     
    549535         *
    550536         * @since 4.3.0
    551          * @access protected
    552537         *
    553538         * @return string Name of the default primary column, in this case, 'username'.
     
    561546         *
    562547         * @since 4.4.0
    563          * @access protected
    564548         *
    565549         * @param WP_User $user_object The WP_User object.
Note: See TracChangeset for help on using the changeset viewer.