Changeset 49599

Timestamp:

11/14/2020 04:52:25 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing descriptions for _WP_List_Table_Compat methods.

Props johannadevos, SaeedFard, swissspidy, desrosj, SergeyBiryukov.
Fixes #46842.

Location:

trunk/src/wp-admin/includes

Files:

• class-wp-list-table-compat.php (modified) (4 diffs)
• class-wp-list-table.php (modified) (1 diff)
• deprecated.php (modified) (1 diff)
• list-table.php (modified) (1 diff)

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

@@ -9 +9 @@
 
 /**
- * Helper class to be used only by back compat functions
+ * Helper class to be used only by back compat functions.
  *
  * @since 3.1.0
@@ -17 +17 @@
         public $_columns;
 
+        /**
+         * Constructor.
+         *
+         * @since 3.1.0
+         *
+         * @param string|WP_Screen $screen  The screen hook name or screen object.
+         * @param string[]         $columns An array of columns with column IDs as the keys
+         *                                  and translated column names as the values.
+         */
         public function __construct( $screen, $columns = array() ) {
                 if ( is_string( $screen ) ) {
@@ -31 +40 @@
 
         /**
+         * Gets a list of all, hidden, and sortable columns.
+         *
+         * @since 3.1.0
+         *
          * @return array
          */
@@ -43 +56 @@
 
         /**
+         * Gets a list of columns.
+         *
+         * @since 3.1.0
+         *
          * @return array
          */

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

@@ -1095 +1095 @@
 
         /**
-         * Gets 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

trunk/src/wp-admin/includes/deprecated.php

@@ -982 +982 @@
  * @see WP_Screen::add_help_tab()
  *
- * @param string    $screen The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions.
+ * @param string    $screen The handle for the screen to add help to. This is usually
+ *                          the hook name returned by the `add_*_page()` functions.
  * @param string    $help   The content of an 'Overview' help tab.
  */

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

@@ -72 +72 @@
  * @since 2.7.0
  *
- * @param string   $screen  The handle for the screen to add help to. This is usually the hook name returned by the
- *                          add_*_page() functions.
- * @param string[] $columns An array of columns with column IDs as the keys and translated column names as the values.
+ * @param string    $screen The handle for the screen to register column headers for. This is
+ *                          usually the hook name returned by the `add_*_page()` functions.
+ * @param string[] $columns An array of columns with column IDs as the keys and translated
+ *                          column names as the values.
  */
 function register_column_headers( $screen, $columns ) {