WordPress.org
Get WordPress

Make WordPress Core

Changeset 29459


Ignore:
Timestamp:
08/10/2014 02:17:14 AM (12 years ago)
Author:
DrewAPicture
Message:

Document default arguments for the WP_List_Table class. Also add referenced docblocks to extending class constructors.

Props mikejolley for the initial patch.
Fixes #28679. See #28298.

Location:
trunk/src/wp-admin/includes
Files:
11 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-wp-comments-list-table.php

    r29206 r29459  
    2222        public $pending_count = array();
    2323
     24        /**
     25         * Constructor.
     26         *
     27         * @since 3.1.0
     28         *
     29         * @see WP_List_Table::__construct() for more information on default arguments.
     30         *
     31         * @param array $args An associative array of arguments.
     32         */     
    2433        public function __construct( $args = array() ) {
    2534                global $post_id;

  • trunk/src/wp-admin/includes/class-wp-links-list-table.php

    r29137 r29459  
    1010class WP_Links_List_Table extends WP_List_Table {
    1111
     12        /**
     13         * Constructor.
     14         *
     15         * @since 3.1.0
     16         *
     17         * @see WP_List_Table::__construct() for more information on default arguments.
     18         *
     19         * @param array $args An associative array of arguments.
     20         */     
    1221        public function __construct( $args = array() ) {
    1322                parent::__construct( array(

  • trunk/src/wp-admin/includes/class-wp-list-table.php

    r29454 r29459  
    33 * Base class for displaying a list of items in an ajaxified HTML table.
    44 *
     5 * @since 3.1.0
     6 * @access private
     7 *
    58 * @package WordPress
    69 * @subpackage List_Table
    7  * @since 3.1.0
    8  * @access private
    910 */
    1011class WP_List_Table {
    … …  
    6566
    6667        /**
    67          * Constructor. The child class should call this constructor from its own constructor
    68          *
    69          * @param array $args An associative array with information about the current table
    70          * @access protected
    71          */
     68         * Constructor.
     69         *
     70         * The child class should call this constructor from its own constructor to override
     71         * the default $args.
     72         *
     73         * @since 3.1.0
     74         *
     75         * @param array|string $args {
     76         *     Array or string of arguments.
     77         *
     78         *     @type string $plural   Plural value used for labels and the objects being listed.
     79         *                            This affects things such as CSS class-names and nonces used
     80         *                            in the list table, e.g. 'posts'. Default empty.
     81         *     @type string $singular Singular label for an object being listed, e.g. 'post'.
     82         *                            Default empty
     83         *     @type bool   $ajax     Whether the list table supports AJAX. This includes loading
     84         *                            and sorting data, for example. If true, the class will call
     85         *                            the {@see _js_vars()} method in the footer to provide variables
     86         *                            to any scripts handling AJAX events. Default false.
     87         *     @type string $screen   String containing the hook name used to determine the current
     88         *                            screen. If left null, the current screen will be automatically set.
     89         *                            Default null.
     90         * }
     91         */     
    7292        public function __construct( $args = array() ) {
    7393                $args = wp_parse_args( $args, array(

  • trunk/src/wp-admin/includes/class-wp-media-list-table.php

    r29320 r29459  
    1010class WP_Media_List_Table extends WP_List_Table {
    1111
     12        /**
     13         * Constructor.
     14         *
     15         * @since 3.1.0
     16         *
     17         * @see WP_List_Table::__construct() for more information on default arguments.
     18         *
     19         * @param array $args An associative array of arguments.
     20         */     
    1221        public function __construct( $args = array() ) {
    1322                $this->detached = isset( $_REQUEST['detached'] ) || isset( $_REQUEST['find_detached'] );

  • trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php

    r29206 r29459  
    1010class WP_MS_Sites_List_Table extends WP_List_Table {
    1111
     12        /**
     13         * Constructor.
     14         *
     15         * @since 3.1.0
     16         *
     17         * @see WP_List_Table::__construct() for more information on default arguments.
     18         *
     19         * @param array $args An associative array of arguments.
     20         */     
    1221        public function __construct( $args = array() ) {
    1322                parent::__construct( array(

  • trunk/src/wp-admin/includes/class-wp-ms-themes-list-table.php

    r29206 r29459  
    1313        public $is_site_themes;
    1414
     15        /**
     16         * Constructor.
     17         *
     18         * @since 3.1.0
     19         *
     20         * @see WP_List_Table::__construct() for more information on default arguments.
     21         *
     22         * @param array $args An associative array of arguments.
     23         */
    1524        public function __construct( $args = array() ) {
    1625                global $status, $page;

  • trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

    r29453 r29459  
    1010class WP_Plugins_List_Table extends WP_List_Table {
    1111
     12        /**
     13         * Constructor.
     14         *
     15         * @since 3.1.0
     16         *
     17         * @see WP_List_Table::__construct() for more information on default arguments.
     18         *
     19         * @param array $args An associative array of arguments.
     20         */     
    1221        public function __construct( $args = array() ) {
    1322                global $status, $page;

  • trunk/src/wp-admin/includes/class-wp-posts-list-table.php

    r29206 r29459  
    4646        private $sticky_posts_count = 0;
    4747
     48        /**
     49         * Constructor.
     50         *
     51         * @since 3.1.0
     52         *
     53         * @see WP_List_Table::__construct() for more information on default arguments.
     54         *
     55         * @param array $args An associative array of arguments.
     56         */     
    4857        public function __construct( $args = array() ) {
    4958                global $post_type_object, $wpdb;

  • trunk/src/wp-admin/includes/class-wp-terms-list-table.php

    r29343 r29459  
    1212        public $callback_args;
    1313
     14        /**
     15         * Constructor.
     16         *
     17         * @since 3.1.0
     18         *
     19         * @see WP_List_Table::__construct() for more information on default arguments.
     20         *
     21         * @param array $args An associative array of arguments.
     22         */     
    1423        public function __construct( $args = array() ) {
    1524                global $post_type, $taxonomy, $action, $tax;

  • trunk/src/wp-admin/includes/class-wp-themes-list-table.php

    r29206 r29459  
    1313        public $features = array();
    1414
     15        /**
     16         * Constructor.
     17         *
     18         * @since 3.1.0
     19         *
     20         * @see WP_List_Table::__construct() for more information on default arguments.
     21         *
     22         * @param array $args An associative array of arguments.
     23         */     
    1524        public function __construct( $args = array() ) {
    1625                parent::__construct( array(

  • trunk/src/wp-admin/includes/class-wp-users-list-table.php

    r29137 r29459  
    3131        /**
    3232         * Constructor.
    33          *
    34          * @since 3.1.0
    35          * @access public
    36          */
     33         *
     34         * @since 3.1.0
     35         *
     36         * @see WP_List_Table::__construct() for more information on default arguments.
     37         *
     38         * @param array $args An associative array of arguments.
     39         */     
    3740        public function __construct( $args = array() ) {
    3841                parent::__construct( array(
Note: See TracChangeset for help on using the changeset viewer.