Changeset 38958

Timestamp:

10/26/2016 02:44:57 PM (10 years ago)

Author:

johnbillion

Message:

Administration: Standardise the docblocks for the handle_bulk_actions-* filters.

Props ericlewis, Veraxus
Fixes #16031

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

@@ -92 +92 @@
                  * @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.
+                 * @param string $redirect_url The redirect URL.
+                 * @param string $doaction     The action being taken.
+                 * @param array  $items        The items 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

@@ -175 +175 @@
         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.
-         */
+        /** 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 );
         break;

trunk/src/wp-admin/edit.php

@@ -164 +164 @@
                         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.
-                         */
+                        /** This action is documented in wp-admin/edit-comments.php */
                         $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $doaction, $post_ids );
                         break;

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

@@ -32 +32 @@
                 $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.
-                 */
+                /** 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 );
         }

trunk/src/wp-admin/plugins.php

@@ -364 +364 @@
                                 $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.
-                                 */
+                                /** This action is documented in wp-admin/edit-comments.php */
                                 $sendback = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $sendback, $action, $plugins );
-
                                 wp_safe_redirect( $sendback );
                                 exit;

trunk/src/wp-admin/upload.php

@@ -165 +165 @@
                         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.
-                         */
+                        /** This action is documented in wp-admin/edit-comments.php */
                         $location = apply_filters( 'handle_bulk_actions-' . get_current_screen()->id, $location, $doaction, $post_ids );
         }

trunk/src/wp-admin/users.php

@@ -415 +415 @@
                 $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.
-                 */
+                /** 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 );