Changeset 29459 for trunk/src/wp-admin/includes/class-wp-list-table.php

Timestamp:

08/10/2014 02:17:14 AM (11 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.

File:

• trunk/src/wp-admin/includes/class-wp-list-table.php (modified) (2 diffs)

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

@@ -3 +3 @@
  * Base class for displaying a list of items in an ajaxified HTML table.
  *
+ * @since 3.1.0
+ * @access private
+ *
  * @package WordPress
  * @subpackage List_Table
- * @since 3.1.0
- * @access private
  */
 class WP_List_Table {
@@ -65 +66 @@
 
     /**
-     * Constructor. The child class should call this constructor from its own constructor
-     *
-     * @param array $args An associative array with information about the current table
-     * @access protected
-     */
+     * Constructor.
+     *
+     * The child class should call this constructor from its own constructor to override
+     * the default $args.
+     *
+     * @since 3.1.0
+     *
+     * @param array|string $args {
+     *     Array or string of arguments.
+     *
+     *     @type string $plural   Plural value used for labels and the objects being listed.
+     *                            This affects things such as CSS class-names and nonces used
+     *                            in the list table, e.g. 'posts'. Default empty.
+     *     @type string $singular Singular label for an object being listed, e.g. 'post'.
+     *                            Default empty
+     *     @type bool   $ajax     Whether the list table supports AJAX. This includes loading
+     *                            and sorting data, for example. If true, the class will call
+     *                            the {@see _js_vars()} method in the footer to provide variables
+     *                            to any scripts handling AJAX events. Default false.
+     *     @type string $screen   String containing the hook name used to determine the current
+     *                            screen. If left null, the current screen will be automatically set.
+     *                            Default null.
+     * }
+     */ 
     public function __construct( $args = array() ) {
         $args = wp_parse_args( $args, array(