Changeset 46811 for trunk/src/wp-admin/edit-comments.php

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.

File:

• trunk/src/wp-admin/edit-comments.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
     }