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

Timestamp:

05/31/2015 01:28:28 AM (10 years ago)

Author:

DrewAPicture

Message:

Fix formatting and add missing return descriptions for inline documenation introduced in [32644] for WP_List_Table.

Also fixes an error introduced in [32661] for WP_Links_List_Table.

See #25408. See #32246.

File:

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

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

@@ -798 +798 @@
 
     /**
-     * Get name of default primary column
+     * Get the name of the default primary column.
      *
      * @since 4.3.0
      * @access protected
      *
-     * @return string
+     * @return string Name of the default primary column, in this case, an empty string.
      */
     protected function get_default_primary_column_name() {
@@ -810 +810 @@
 
     /**
-     * Get name of primary column.
+     * Get the name of the primary column.
      *
      * @since 4.3.0
      * @access protected
      *
-     * @return string Filtered name of primary column
+     * @return string The name of the primary column.
      */
     protected function get_primary_column_name() {
         $columns = $this->get_columns();
         $default = $this->get_default_primary_column_name();
+
         /**
-         * Filter the name of the primary column for the current list table, with context as argument (eg: 'plugins').
+         * Filter the name of the primary column for the current list table, with context
+         * as argument (eg: 'plugins').
          *
          * @since 4.3.0
          *
-         * @param string $default Column name default for the specific list table (eg: 'name')
-         * @param string $context Screen ID for specific list table (eg: 'plugins')
+         * @param string $default Column name default for the specific list table, e.g. 'name'.
+         * @param string $context Screen ID for specific list table, e.g. 'plugins'.
          */
         $column  = apply_filters( 'list_table_primary_column', $default, $this->screen->id );
@@ -1157 +1159 @@
      * @access protected
      *
-     * @param object $item Item being acted upon
-     * @param string $column_name Current column name
-     * @param string $primary Primary column name
-     *
-     * @return string
+     * @param object $item        The item being acted upon.
+     * @param string $column_name Current column name.
+     * @param string $primary     Primary column name.
+     * @return string The row actions output. In this case, an empty string.
      */
     protected function handle_row_actions( $item, $column_name, $primary ) {