Changeset 38647

Timestamp:

09/23/2016 08:32:48 PM (8 years ago)

Author:

ericlewis

Message:

Allow custom bulk actions in admin list tables.

Bulk action filtering was introduced in 3.1, but only to remove default bulk actions, not add new ones.

Bulk actions can now be registered for all admin list table dropdowns via the bulk_actions-{get_current_screen()->id} filter. Handling custom bulk actions can be performed in the corresponding and newly introduced handle_bulk_actions-${get_current_screen()->id} filter.

Props scribu, flixos90, Veraxus.
See #16031.

Location:

trunk/src/wp-admin

Files:

• edit-comments.php (modified) (1 diff)
• edit-tags.php (modified) (2 diffs)
• edit.php (modified) (1 diff)
• includes/class-wp-list-table.php (modified) (2 diffs)
• link-manager.php (modified) (2 diffs)
• network/site-themes.php (modified) (1 diff)
• network/site-users.php (modified) (1 diff)
• network/sites.php (modified) (1 diff)
• network/themes.php (modified) (1 diff)
• network/users.php (modified) (1 diff)
• plugins.php (modified) (1 diff)
• upload.php (modified) (1 diff)
• users.php (modified) (1 diff)

trunk/src/wp-admin/edit-comments.php

@@ -81 +81 @@
                 break;
         }
+    }
+
+    if ( ! in_array( $doaction, array( 'approve', 'unapprove', 'spam', 'unspam', 'trash', 'delete' ), true ) ) {
+        /**
+         * Fires when a custom bulk action should be handled.
+         *
+         * The redirect link should be modified with success or failure feedback
+         * from the action to be used to display feedback to the user.
+         *
+         * @since 4.7.0
+         *
+         * @param string $redirect_to The redirect URL.
+         * @param string $doaction    The action being taken.
+         * @param array  $comment_ids The comments to take the action on.
+         */
+        $redirect_to = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $redirect_to, $doaction, $comment_ids );
     }
 

trunk/src/wp-admin/edit-tags.php

@@ -196 +196 @@
         $location = add_query_arg( array( 'error' => true, 'message' => 5 ), $location );
     break;
+default:
+    if ( ! $wp_list_table->current_action() || ! isset( $_REQUEST['delete_tags'] ) ) {
+        break;
+    }
+    check_admin_referer( 'bulk-tags' );
+    $tags = (array) $_REQUEST['delete_tags'];
+    /**
+     * Fires when a custom bulk action should be handled.
+     *
+     * The sendback link should be modified with success or failure feedback
+     * from the action to be used to display feedback to the user.
+     *
+     * @since 4.7.0
+     *
+     * @param string $location The redirect URL.
+     * @param string $action   The action being taken.
+     * @param array  $tags     The tag IDs to take the action on.
+     */
+    $location = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $location, $wp_list_table->current_action(), $tags );
+    break;
 }
 
@@ -211 +231 @@
      *
      * @since 4.6.0
-     * 
+     *
      * @param string $location The destination URL.
      * @param object $tax      The taxonomy object.

trunk/src/wp-admin/edit.php

@@ -162 +162 @@
                 }
             }
+            break;
+        default:
+            /**
+             * Fires when a custom bulk action should be handled.
+             *
+             * The sendback link should be modified with success or failure feedback
+             * from the action to be used to display feedback to the user.
+             *
+             * @since 4.7.0
+             *
+             * @param string $sendback The redirect URL.
+             * @param string $doaction The action being taken.
+             * @param array  $post_ids The post IDs to take the action on. 
+             */
+            $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $doaction, $post_ids );
             break;
     }

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

@@ -437 +437 @@
     protected function bulk_actions( $which = '' ) {
         if ( is_null( $this->_actions ) ) {
-            $no_new_actions = $this->_actions = $this->get_bulk_actions();
+            $this->_actions = $this->get_bulk_actions();
             /**
              * Filters the list table Bulk Actions drop-down.
@@ -451 +451 @@
              */
             $this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions );
-            $this->_actions = array_intersect_assoc( $this->_actions, $no_new_actions );
             $two = '';
         } else {

trunk/src/wp-admin/link-manager.php

@@ -20 +20 @@
     check_admin_referer( 'bulk-bookmarks' );
 
+    $redirect_to = admin_url( 'link-manager.php' );
+    $bulklinks = (array) $_REQUEST['linkcheck'];
+
     if ( 'delete' == $doaction ) {
-        $bulklinks = (array) $_REQUEST['linkcheck'];
         foreach ( $bulklinks as $link_id ) {
             $link_id = (int) $link_id;
@@ -28 +30 @@
         }
 
-        wp_redirect( add_query_arg('deleted', count( $bulklinks ), admin_url( 'link-manager.php' ) ) );
-        exit;
+        $redirect_to = add_query_arg( 'deleted', count( $bulklinks ), $redirect_to );
+    } else {
+        /**
+         * Fires when a custom bulk action should be handled.
+         *
+         * The redirect link should be modified with success or failure feedback
+         * from the action to be used to display feedback to the user.
+         *
+         * @since 4.7.0
+         *
+         * @param string $redirect_to The redirect URL.
+         * @param string $doaction    The action being taken.
+         * @param array  $bulklinks   The links to take the action on.
+         */
+        $redirect_to = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $redirect_to, $doaction, $bulklinks );
     }
+    wp_redirect( $redirect_to );
+    exit;
 } elseif ( ! empty( $_GET['_wp_http_referer'] ) ) {
      wp_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), wp_unslash( $_SERVER['REQUEST_URI'] ) ) );

trunk/src/wp-admin/network/site-themes.php

@@ -123 +123 @@
             }
             break;
+        default:
+            if ( isset( $_POST['checked'] ) ) {
+                check_admin_referer( 'bulk-themes' );
+                $themes = (array) $_POST['checked'];
+                $n = count( $themes );
+                /**
+                 * Fires when a custom bulk action should be handled.
+                 *
+                 * The redirect link should be modified with success or failure feedback
+                 * from the action to be used to display feedback to the user.
+                 *
+                 * @since 4.7.0
+                 *
+                 * @param string $referer The redirect URL.
+                 * @param string $action  The action being taken.
+                 * @param array  $themes  The themes to take the action on.
+                 * @param int    $site_id The current site id
+                 */
+                $referer = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $referer, $action, $themes, $id );
+            } else {
+                $action = 'error';
+                $n = 'none';
+            }
     }
 

trunk/src/wp-admin/network/site-users.php

@@ -165 +165 @@
             }
             break;
+        default:
+            if ( ! isset( $_REQUEST['users'] ) ) {
+                break;
+            }
+            check_admin_referer( 'bulk-users' );
+            $userids = $_REQUEST['users'];
+            /**
+             * Fires when a custom bulk action should be handled.
+             *
+             * The redirect link should be modified with success or failure feedback
+             * from the action to be used to display feedback to the user.
+             *
+             * @since 4.7.0
+             *
+             * @param string $referer The redirect URL.
+             * @param string $action  The action being taken.
+             * @param array  $userids The users to take the action on.
+             * @param int    $id      The id of the current site
+             */
+            $referer = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $referer, $action, $userids, $id );
+            $update = $action;
+            break;
     }
 

trunk/src/wp-admin/network/sites.php

@@ -161 +161 @@
                     }
                 }
+                if ( ! in_array( $doaction, array( 'delete', 'spam', 'notspam' ), true ) ) {
+                    $redirect_to = wp_get_referer();
+                    $blogs = (array) $_POST['allblogs'];
+                    /**
+                     * Fires when a custom bulk action should be handled.
+                     *
+                     * The redirect link should be modified with success or failure feedback
+                     * from the action to be used to display feedback to the user.
+                     *
+                     * @since 4.7.0
+                     *
+                     * @param string $redirect_to The redirect URL.
+                     * @param string $doaction      The action being taken.
+                     * @param array  $blogs       The blogs to take the action on.
+                     * @param int    $site_id     The current site id.
+                     */
+                    $redirect_to = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $redirect_to, $doaction, $blogs, $id );
+                    wp_safe_redirect( $redirect_to );
+                    exit();
+                }
             } else {
                 $location = network_admin_url( 'sites.php' );

trunk/src/wp-admin/network/themes.php

@@ -196 +196 @@
             ), network_admin_url( 'themes.php' ) ) );
             exit;
+        default:
+            $themes = isset( $_POST['checked'] ) ? (array) $_POST['checked'] : array();
+            if ( empty( $themes ) ) {
+                wp_safe_redirect( add_query_arg( 'error', 'none', $referer ) );
+                exit;
+            }
+            check_admin_referer( 'bulk-themes' );
+
+            /**
+             * Fires when a custom bulk action should be handled.
+             *
+             * The redirect link should be modified with success or failure feedback
+             * from the action to be used to display feedback to the user.
+             *
+             * @since 4.7.0
+             *
+             * @param string $referer   The redirect URL.
+             * @param string $action    The action being taken.
+             * @param array  $themes    The themes to take the action on.
+             */
+            $referer = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $referer, $action, $themes );
+
+            wp_safe_redirect( $referer );
+            exit;
     }
+
 }
 

trunk/src/wp-admin/network/users.php

@@ -94 +94 @@
                 }
 
+                if ( ! in_array( $doaction, array( 'delete', 'spam', 'notspam' ), true ) ) {
+                    $sendback = wp_get_referer();
+
+                    $user_ids = (array) $_POST['allusers'];
+                    /**
+                     * Fires when a custom bulk action should be handled.
+                     *
+                     * The sendback link should be modified with success or failure feedback
+                     * from the action to be used to display feedback to the user.
+                     *
+                     * @since 4.7.0
+                     *
+                     * @param string $sendback The redirect URL.
+                     * @param string $doaction The action being taken.
+                     * @param array  $user_ids The users to take the action on.
+                     */
+                    $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $doaction, $user_ids );
+
+                    wp_safe_redirect( $sendback );
+                    exit();
+                }
+
                 wp_safe_redirect( add_query_arg( array( 'updated' => 'true', 'action' => $userfunction ), wp_get_referer() ) );
             } else {

trunk/src/wp-admin/plugins.php

@@ -357 +357 @@
             }
             break;
+
+        default:
+            if ( isset( $_POST['checked'] ) ) {
+                check_admin_referer('bulk-plugins');
+                $plugins = isset( $_POST['checked'] ) ? (array) $_POST['checked'] : array();
+                $sendback = wp_get_referer();
+
+                /**
+                 * Fires when a custom bulk action should be handled.
+                 *
+                 * The sendback link should be modified with success or failure feedback
+                 * from the action to be used to display feedback to the user.
+                 *
+                 * @since 4.7.0
+                 *
+                 * @param string $sendback The redirect URL.
+                 * @param string $action   The action being taken.
+                 * @param array  $plugins  The plugins to take the action on.
+                 */
+                $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $action, $plugins );
+
+                wp_safe_redirect( $sendback );
+                exit;
+            }
+            break;
     }
+
 }
 

trunk/src/wp-admin/upload.php

@@ -164 +164 @@
             $location = add_query_arg( 'deleted', count( $post_ids ), $location );
             break;
+        default:
+            /**
+             * Fires when a custom bulk action should be handled.
+             *
+             * The redirect link should be modified with success or failure feedback
+             * from the action to be used to display feedback to the user.
+             *
+             * @since 4.7.0
+             *
+             * @param string $location The redirect URL.
+             * @param string $doaction The action being taken.
+             * @param array  $post_ids The posts to take the action on.
+             */
+            $location = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $location, $doaction, $post_ids );
     }
 

trunk/src/wp-admin/users.php

@@ -411 +411 @@
     }
 
+    if ( $wp_list_table->current_action() && ! empty( $_REQUEST['users'] ) ) {
+        $userids = $_REQUEST['users'];
+        $sendback = wp_get_referer();
+
+        /**
+         * Fires when a custom bulk action should be handled.
+         *
+         * The sendback link should be modified with success or failure feedback
+         * from the action to be used to display feedback to the user.
+         *
+         * @since 4.7.0
+         *
+         * @param string $sendback The redirect URL.
+         * @param string $action   The action being taken.
+         * @param array  $userids  The users to take the action on.
+         */
+        $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $wp_list_table->current_action(), $userids );
+
+        wp_safe_redirect( $sendback );
+        exit;
+    }
+
     $wp_list_table->prepare_items();
     $total_pages = $wp_list_table->get_pagination_arg( 'total_pages' );