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

Timestamp:

05/29/2015 02:40:52 AM (10 years ago)

Author:

helen

Message:

List tables: introduce the concept of a "primary" column.

This becomes the column that contains the row actions, and allows for a more flexibility, particularly with custom post types and list tables. To (re)define the primary column, use the list_table_primary_column filter, which receives the column name and the screen ID as arguments.

props stephdau, DaveAl, jesin.
see #25408.

File:

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

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

@@ -796 +796 @@
 
     /**
+     * Get name of default primary column
+     *
+     * @since 4.3.0
+     * @access protected
+     *
+     * @return string
+     */
+    protected function get_default_primary_column_name() {
+        return '';
+    }
+
+    /**
+     * Get name of primary column.
+     *
+     * @since 4.3.0
+     * @access protected
+     *
+     * @return string Filtered name of 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').
+         *
+         * @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')
+         */
+        $column  = apply_filters( 'list_table_primary_column', $default, $this->screen->id );
+
+        if ( empty( $column ) || ! isset( $columns[ $column ] ) ) {
+            $column = $default;
+        }
+
+        return $column;
+    }
+
+    /**
      * Get a list of all, hidden and sortable columns, with filter applied
      *
@@ -835 +875 @@
         }
 
-        $this->_column_headers = array( $columns, $hidden, $sortable );
+        $primary = $this->get_primary_column_name();
+        $this->_column_headers = array( $columns, $hidden, $sortable, $primary );
 
         return $this->_column_headers;
@@ -1063 +1104 @@
      */
     protected function single_row_columns( $item ) {
-        list( $columns, $hidden ) = $this->get_column_info();
+        list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
 
         foreach ( $columns as $column_name => $column_display_name ) {
-            $class = "class='$column_name column-$column_name'";
+            $classes = "$column_name column-$column_name";
+            if ( $primary === $column_name ) {
+                $classes .= ' has-row-actions column-primary';
+            }
 
             $style = '';
-            if ( in_array( $column_name, $hidden ) )
+            if ( in_array( $column_name, $hidden ) ) {
                 $style = ' style="display:none;"';
-
-            $attributes = "$class$style";
+            }
+
+            $attributes = "class='$classes'$style";
 
             if ( 'cb' == $column_name ) {
@@ -1082 +1127 @@
                 echo "<td $attributes>";
                 echo call_user_func( array( $this, 'column_' . $column_name ), $item );
+                echo $this->handle_row_actions( $item, $column_name, $primary );
                 echo "</td>";
             }
@@ -1087 +1133 @@
                 echo "<td $attributes>";
                 echo $this->column_default( $item, $column_name );
+                echo $this->handle_row_actions( $item, $column_name, $primary );
                 echo "</td>";
             }
         }
     }
+
+    /**
+     * Generate and display row actions links
+     *
+     * @since 4.3.0
+     * @access protected
+     *
+     * @param object $item Item being acted upon
+     * @param string $column_name Current column name
+     * @param string $primary Primary column name
+     *
+     * @return string
+     */
+    protected function handle_row_actions( $item, $column_name, $primary ) {
+        return '';
+    }
 
     /**