Changeset 30225

Timestamp:

11/04/2014 03:54:50 PM (10 years ago)

Author:

DrewAPicture

Message:

Add parameter and return descriptions to the WP_List_Table::get_pagination_arg() DocBlock.

See #30224.

File:

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

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

@@ -248 +248 @@
 
     /**
-     * Access the pagination args
-     *
-     * @since 3.1.0
-     * @access public
-     *
-     * @param string $key
-     * @return int
+     * Access the pagination args.
+     *
+     * @since 3.1.0
+     * @access public
+     *
+     * @param string $key Pagination argument to retrieve. Common values include 'total_items',
+     *                    'total_pages', 'per_page', or 'infinite_scroll'.
+     * @return int Number of items that correspond to the given pagination argument.
      */
     public function get_pagination_arg( $key ) {