Changeset 46811

Timestamp:

12/03/2019 01:56:25 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Move the canonical DocBlock for handle_bulk_actions-{$screen} action to wp-admin/edit.php.

• Document accepted values for the $items parameter.
• Use interpolated syntax for the filter name.

Props dilipbheda, johnbillion, SergeyBiryukov.
Fixes #48857.

Location:

trunk/src/wp-admin

Files:

• edit-comments.php (modified) (1 diff)
• edit-tags.php (modified) (1 diff)
• edit.php (modified) (1 diff)
• link-manager.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

@@ -93 +93 @@
         $screen = get_current_screen()->id;
 
-        /**
-         * 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.
-         *
-         * The dynamic portion of the hook name, `$screen`, refers to the current screen ID.
-         *
-         * @since 4.7.0
-         *
-         * @param string $redirect_url The redirect URL.
-         * @param string $doaction     The action being taken.
-         * @param array  $items        The items to take the action on.
-         */
+        /** This action is documented in wp-admin/edit.php */
         $redirect_to = apply_filters( "handle_bulk_actions-{$screen}", $redirect_to, $doaction, $comment_ids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
     }

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

@@ -200 +200 @@
         }
         check_admin_referer( 'bulk-tags' );
-        $tags = (array) $_REQUEST['delete_tags'];
-        /** This action is documented in wp-admin/edit-comments.php */
-        $location = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $location, $wp_list_table->current_action(), $tags );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+
+        $screen = get_current_screen()->id;
+        $tags   = (array) $_REQUEST['delete_tags'];
+
+        /** This action is documented in wp-admin/edit.php */
+        $location = apply_filters( "handle_bulk_actions-{$screen}", $location, $wp_list_table->current_action(), $tags );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
         break;
 }

trunk/src/wp-admin/edit.php

@@ -183 +183 @@
             break;
         default:
-            /** This action is documented in wp-admin/edit-comments.php */
-            $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $doaction, $post_ids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+            $screen = get_current_screen()->id;
+
+            /**
+             * 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.
+             *
+             * The dynamic portion of the hook name, `$screen`, refers to the current screen ID.
+             *
+             * @since 4.7.0
+             *
+             * @param string $sendback The redirect URL.
+             * @param string $doaction The action being taken.
+             * @param array  $items    The items to take the action on. Accepts an array of IDs of posts,
+             *                         comments, terms, links, plugins, attachments, or users.
+             */
+            $sendback = apply_filters( "handle_bulk_actions-{$screen}", $sendback, $doaction, $post_ids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
             break;
     }

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

@@ -33 +33 @@
         $redirect_to = add_query_arg( 'deleted', count( $bulklinks ), $redirect_to );
     } else {
-        /** This action is documented in wp-admin/edit-comments.php */
-        $redirect_to = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $redirect_to, $doaction, $bulklinks ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        $screen = get_current_screen()->id;
+
+        /** This action is documented in wp-admin/edit.php */
+        $redirect_to = apply_filters( "handle_bulk_actions-{$screen}", $redirect_to, $doaction, $bulklinks ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
     }
     wp_redirect( $redirect_to );

trunk/src/wp-admin/plugins.php

@@ -415 +415 @@
             if ( isset( $_POST['checked'] ) ) {
                 check_admin_referer( 'bulk-plugins' );
+
+                $screen   = get_current_screen()->id;
+                $sendback = wp_get_referer();
                 $plugins  = isset( $_POST['checked'] ) ? (array) wp_unslash( $_POST['checked'] ) : array();
-                $sendback = wp_get_referer();
-
-                /** This action is documented in wp-admin/edit-comments.php */
-                $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $action, $plugins );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+
+                /** This action is documented in wp-admin/edit.php */
+                $sendback = apply_filters( "handle_bulk_actions-{$screen}", $sendback, $action, $plugins );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
                 wp_safe_redirect( $sendback );
                 exit;

trunk/src/wp-admin/upload.php

@@ -199 +199 @@
             break;
         default:
-            /** This action is documented in wp-admin/edit-comments.php */
-            $location = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $location, $doaction, $post_ids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+            $screen = get_current_screen()->id;
+
+            /** This action is documented in wp-admin/edit.php */
+            $location = apply_filters( "handle_bulk_actions-{$screen}", $location, $doaction, $post_ids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
     }
 

trunk/src/wp-admin/users.php

@@ -457 +457 @@
 
         if ( $wp_list_table->current_action() && ! empty( $_REQUEST['users'] ) ) {
+            $screen   = get_current_screen()->id;
+            $sendback = wp_get_referer();
             $userids  = $_REQUEST['users'];
-            $sendback = wp_get_referer();
-
-            /** This action is documented in wp-admin/edit-comments.php */
-            $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $wp_list_table->current_action(), $userids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+
+            /** This action is documented in wp-admin/edit.php */
+            $sendback = apply_filters( "handle_bulk_actions-{$screen}", $sendback, $wp_list_table->current_action(), $userids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 
             wp_safe_redirect( $sendback );