Ticket #28679: wp_list_table_docs.28679.diff

wp-admin/includes/class-wp-comments-list-table.php

@@ -21 +21 @@
 
         public $pending_count = array();
 
+        /**
+         * Constructor.
+         * 
+         * @since 3.1.0
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 global $post_id;
 

wp-admin/includes/class-wp-links-list-table.php

@@ -9 +9 @@
  */
 class WP_Links_List_Table extends WP_List_Table {
 
+        /**
+         * Constructor.
+         * 
+         * @since 3.1.0
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 parent::__construct( array(
                         'plural' => 'bookmarks',

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

@@ -64 +64 @@
         private $_pagination;
 
         /**
-         * Constructor. The child class should call this constructor from its own constructor
+         * Constructor.
+         *
+         * The child class should call this constructor from its own constructor to override the 
+         * default $args. The default args are 'plural', 'singular', 'ajax' and 'screen'.
+         *
+         * The 'plural' option is a string that controls the plural labels for the objects being listed. 
+         * This affects things such as css class-names and nonces used in the list table. e.g. 'posts'.
+         *
+         * The 'singular' option is a string that controls the singular label for an object being 
+         * listed. e.g. 'post'.
+         *
+         * The 'ajax' boolean is used to tell the class if the list table supports ajax. This includes 
+         * loading and sorting data for example. If true, the class will call the _js_vars() method in 
+         * the footer to provide variables to any scripts handling ajax events.
+         *
+         * The 'screen' option can be used to pass in a string containing the hook name used to determine 
+         * the current screen. If left 'null', the current screen will be automatically set.
+         *
+         * @since 3.1.0
          *
          * @param array $args An associative array with information about the current table
-         * @access protected
-         */
+         */     
         public function __construct( $args = array() ) {
                 $args = wp_parse_args( $args, array(
                         'plural' => '',

wp-admin/includes/class-wp-media-list-table.php

@@ -9 +9 @@
  */
 class WP_Media_List_Table extends WP_List_Table {
 
+        /**
+         * Constructor.
+         * 
+         * @since 3.1.0
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 $this->detached = isset( $_REQUEST['detached'] ) || isset( $_REQUEST['find_detached'] );
 

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

@@ -9 +9 @@
  */
 class WP_MS_Sites_List_Table extends WP_List_Table {
 
+        /**
+         * Constructor.
+         * 
+         * @since 3.1.0
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 parent::__construct( array(
                         'plural' => 'sites',

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

@@ -12 +12 @@
         public $site_id;
         public $is_site_themes;
 
+        /**
+         * Constructor.
+         * 
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */
         public function __construct( $args = array() ) {
                 global $status, $page;
 

wp-admin/includes/class-wp-plugins-list-table.php

@@ -9 +9 @@
  */
 class WP_Plugins_List_Table extends WP_List_Table {
 
+        /**
+         * Constructor.
+         * 
+         * @since 3.1.0
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 global $status, $page;
 

wp-admin/includes/class-wp-posts-list-table.php

@@ -45 +45 @@
          */
         private $sticky_posts_count = 0;
 
+        /**
+         * Constructor.
+         * 
+         * @since 3.1.0
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 global $post_type_object, $wpdb;
 

wp-admin/includes/class-wp-terms-list-table.php

@@ -11 +11 @@
 
         public $callback_args;
 
+        /**
+         * Constructor.
+         * 
+         * @since 3.1.0
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 global $post_type, $taxonomy, $action, $tax;
 

wp-admin/includes/class-wp-themes-list-table.php

@@ -12 +12 @@
         protected $search_terms = array();
         public $features = array();
 
+        /**
+         * Constructor.
+         * 
+         * @since 3.1.0
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 parent::__construct( array(
                         'ajax' => true,

wp-admin/includes/class-wp-users-list-table.php

@@ -30 +30 @@
 
         /**
          * Constructor.
-         *
+         * 
          * @since 3.1.0
-         * @access public
-         */
+         * @see WP_List_Table::__construct() For more information on the default arguments.
+         * @param array $args An associative array with information about the current table
+         */     
         public function __construct( $args = array() ) {
                 parent::__construct( array(
                         'singular' => 'user',