Changeset 48162

Timestamp:

06/25/2020 08:54:40 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve DocBlocks in wp-admin/includes/class-wp-list-table.php per the documentation standards.

See #49572.

File:

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

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

@@ -373 +373 @@
 
     /**
-     * Get an associative array ( id => link ) with the list
-     * of views available on this table.
+     * Gets the list of views available on this table.
+     *
+     * The format is an associative array:
+     * - `'id' => 'link'`
      *
      * @since 3.1.0
@@ -385 +387 @@
 
     /**
-     * Display the list of views available on this table.
+     * Displays the list of views available on this table.
      *
      * @since 3.1.0
@@ -418 +420 @@
 
     /**
-     * Get an associative array ( option_name => option_title ) with the list
-     * of bulk actions available on this table.
+     * Gets the list of bulk actions available on this table.
+     *
+     * The format is an associative array:
+     * - `'option_name' => 'option_title'`
      *
      * @since 3.1.0
@@ -430 +434 @@
 
     /**
-     * Display the bulk actions dropdown.
+     * Displays the bulk actions dropdown.
      *
      * @since 3.1.0
@@ -440 +444 @@
         if ( is_null( $this->_actions ) ) {
             $this->_actions = $this->get_bulk_actions();
+
             /**
              * Filters the list table Bulk Actions drop-down.
@@ -453 +458 @@
              */
             $this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-            $two            = '';
+
+            $two = '';
         } else {
             $two = '2';
@@ -479 +485 @@
 
     /**
-     * Get the current action selected from the bulk actions dropdown.
-     *
-     * @since 3.1.0
-     *
-     * @return string|false The action name or False if no action was selected
+     * Gets the current action selected from the bulk actions dropdown.
+     *
+     * @since 3.1.0
+     *
+     * @return string|false The action name. False if no action was selected.
      */
     public function current_action() {
@@ -620 +626 @@
 
     /**
-     * Display a view switcher
+     * Displays a view switcher.
      *
      * @since 3.1.0
@@ -652 +658 @@
 
     /**
-     * Display a comment count bubble
+     * Displays a comment count bubble.
      *
      * @since 3.1.0
@@ -746 +752 @@
 
     /**
-     * Get the current page number
+     * Gets the current page number.
      *
      * @since 3.1.0
@@ -763 +769 @@
 
     /**
-     * Get number of items to display on a single page
+     * Gets the number of items to display on a single page.
      *
      * @since 3.1.0
@@ -794 +800 @@
 
     /**
-     * Display the pagination.
+     * Displays the pagination.
      *
      * @since 3.1.0
@@ -934 +940 @@
 
     /**
-     * Get a list of columns. The format is:
-     * 'internal-name' => 'Title'
+     * Gets a list of columns.
+     *
+     * The format is:
+     * - `'internal-name' => 'Title'`
      *
      * @since 3.1.0
@@ -947 +955 @@
 
     /**
-     * Get a list of sortable columns.
+     * Gets a list of sortable columns.
      *
      * The format is:
      * - `'internal-name' => 'orderby'`
-     * - `'internal-name' => array( 'orderby', 'asc' )` - The second element set the initial sorting order.
-     * - `'internal-name' => array( 'orderby', true )` - The second element will make the initial sorting order be descending.
+     * - `'internal-name' => array( 'orderby', 'asc' )` - The second element sets the initial sorting order.
+     * - `'internal-name' => array( 'orderby', true )`  - The second element makes the initial order descending.
      *
      * @since 3.1.0
@@ -1037 +1045 @@
 
     /**
-     * Get a list of all, hidden and sortable columns, with filter applied
+     * Gets a list of all, hidden and sortable columns, with filter applied.
      *
      * @since 3.1.0
@@ -1093 +1101 @@
 
     /**
-     * Return number of visible columns
+     * Returns the number of visible columns.
      *
      * @since 3.1.0
@@ -1106 +1114 @@
 
     /**
-     * Print column headers, accounting for hidden and sortable columns.
+     * Prints column headers, accounting for hidden and sortable columns.
      *
      * @since 3.1.0
@@ -1158 +1166 @@
 
                 if ( $current_orderby === $orderby ) {
-                    $order   = 'asc' === $current_order ? 'desc' : 'asc';
+                    $order = 'asc' === $current_order ? 'desc' : 'asc';
+
                     $class[] = 'sorted';
                     $class[] = $current_order;
@@ -1167 +1176 @@
                         $order = $desc_first ? 'desc' : 'asc';
                     }
+
                     $class[] = 'sortable';
                     $class[] = 'desc' === $order ? 'asc' : 'desc';
@@ -1227 +1237 @@
 
     /**
-     * Get a list of CSS classes for the WP_List_Table table tag.
+     * Gets a list of CSS classes for the WP_List_Table table tag.
      *
      * @since 3.1.0
@@ -1238 +1248 @@
 
     /**
-     * Generate the table navigation above or below the table
+     * Generates the table navigation above or below the table
      *
      * @since 3.1.0
@@ -1266 +1276 @@
 
     /**
-     * Extra controls to be displayed between bulk actions and pagination
+     * Extra controls to be displayed between bulk actions and pagination.
      *
      * @since 3.1.0
@@ -1275 +1285 @@
 
     /**
-     * Generate the tbody element for the list table.
+     * Generates the tbody element for the list table.
      *
      * @since 3.1.0
@@ -1290 +1300 @@
 
     /**
-     * Generate the table rows
+     * Generates the table rows.
      *
      * @since 3.1.0
@@ -1301 +1311 @@
 
     /**
-     * Generates content for a single row of the table
+     * Generates content for a single row of the table.
      *
      * @since 3.1.0
@@ -1325 +1335 @@
 
     /**
-     * Generates the columns for a single row of the table
-     *
-     * @since 3.1.0
-     *
-     * @param object $item The current item
+     * Generates the columns for a single row of the table.
+     *
+     * @since 3.1.0
+     *
+     * @param object $item The current item.
      */
     protected function single_row_columns( $item ) {
@@ -1392 +1402 @@
 
     /**
-     * Handle an incoming ajax request (called from admin-ajax.php)
+     * Handles an incoming ajax request (called from admin-ajax.php)
      *
      * @since 3.1.0
@@ -1426 +1436 @@
 
     /**
-     * Send required variables to JavaScript land
+     * Sends required variables to JavaScript land.
+     *
+     * @since 3.1.0
      */
     public function _js_vars() {