Changeset 26401

Timestamp:

11/26/2013 08:11:33 AM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/class-wp-list-table.php.

Props miyauchi, kpdesign.
Fixes 25848.

File:

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

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

@@ -245 +245 @@
         function views() {
                 $views = $this->get_views();
-                $views = apply_filters( 'views_' . $this->screen->id, $views );
+                /**
+                 * Filter the list of available list table views.
+                 *
+                 * The dynamic portion of the hook name, $this->screen->id, refers
+                 * to the ID of the current screen, usually a string.
+                 *
+                 * @since 3.5.0
+                 *
+                 * @param array $views An array of available list table views.
+                 */
+                $views = apply_filters( "views_{$this->screen->id}", $views );
 
                 if ( empty( $views ) )
@@ -280 +290 @@
                 if ( is_null( $this->_actions ) ) {
                         $no_new_actions = $this->_actions = $this->get_bulk_actions();
-                        // This filter can currently only be used to remove actions.
-                        $this->_actions = apply_filters( 'bulk_actions-' . $this->screen->id, $this->_actions );
+                        /**
+                         * Filter the list table Bulk Actions drop-down.
+                         *
+                         * The dynamic portion of the hook name, $this->screen->id, refers
+                         * to the ID of the current screen, usually a string.
+                         *
+                         * This filter can currently only be used to remove bulk actions.
+                         *
+                         * @since 3.5.0
+                         *
+                         * @param array $actions An array of the available bulk actions.
+                         */
+                        $this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions );
                         $this->_actions = array_intersect_assoc( $this->_actions, $no_new_actions );
                         $two = '';
@@ -369 +390 @@
 
                 /**
-                 * Filter the months dropdown results.
+                 * Filter the 'Months' drop-down results.
                  *
                  * @since 3.7.0
                  *
-                 * @param object $months    The months dropdown query results.
+                 * @param object $months    The months drop-down query results.
                  * @param string $post_type The post type.
                  */
@@ -483 +504 @@
                         $per_page = $default;
 
+                /**
+                 * Filter the number of items to be displayed on each page of the list table.
+                 *
+                 * The dynamic hook name, $option, refers to the per page option depending
+                 * on the type of list table in use. Possible values may include:
+                 * 'edit_comments_per_page', 'sites_network_per_page', 'site_themes_network_per_page',
+                 * 'themes_netework_per_page', 'users_network_per_page', 'edit_{$post_type}', etc.
+                 *
+                 * @since 2.9.0
+                 *
+                 * @param int $per_page Number of items to be displayed. Default 20.
+                 */
                 return (int) apply_filters( $option, $per_page );
         }
@@ -615 +648 @@
                 $hidden = get_hidden_columns( $this->screen );
 
-                $_sortable = apply_filters( "manage_{$this->screen->id}_sortable_columns", $this->get_sortable_columns() );
+                $sortable_columns = $this->get_sortable_columns();
+                /**
+                 * Filter the list table sortable columns for a specific screen.
+                 *
+                 * The dynamic portion of the hook name, $this->screen->id, refers
+                 * to the ID of the current screen, usually a string.
+                 *
+                 * @since 3.5.0
+                 *
+                 * @param array $sortable_columns An array of sortable columns.
+                 */
+                $_sortable = apply_filters( "manage_{$this->screen->id}_sortable_columns", $sortable_columns );
 
                 $sortable = array();