Changeset 34951 for trunk/src/wp-admin/includes/template-functions.php

Timestamp:

10/08/2015 07:06:32 PM (10 years ago)

Author:

DrewAPicture

Message:

Administration: Add the ability to pass an array of screen IDs to add_meta_box() and remove_meta_box().

The $screen parameter in both functions can now accept a single screen ID, WP_Screen object, or an array of screen IDs.

Adds tests.

Props coffee2code, iamfriendly, madalinungureanu, mordauk, igmoweb, meloniq, DrewAPicture.
See #15000.

File:

• trunk/src/wp-admin/includes/template-functions.php (modified) (4 diffs)

trunk/src/wp-admin/includes/template-functions.php

@@ -848 +848 @@
 
 /**
- * Add a meta box to an edit form.
+ * Adds a meta box to one or more screens.
  *
  * @since 2.5.0
+ * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
  *
  * @global array $wp_meta_boxes
@@ -858 +859 @@
  * @param callable         $callback      Function that fills the box with the desired content.
  *                                        The function should echo its output.
- * @param string|WP_Screen $screen        Optional. The screen on which to show the box (like a post
- *                                        type, 'link', or 'comment'). Default is the current screen.
+ * @param string|array|WP_Screen $screen  Optional. The screen or screens on which to show the box
+ *                                        (such as a post type, 'link', or 'comment'). Accepts a single
+ *                                        screen ID, WP_Screen object, or array of screen IDs. Default
+ *                                        is the current screen.
  * @param string           $context       Optional. The context within the screen where the boxes
  *                                        should display. Available contexts vary from screen to
@@ -875 +878 @@
     global $wp_meta_boxes;
 
-    if ( empty( $screen ) )
+    if ( empty( $screen ) ) {
         $screen = get_current_screen();
-    elseif ( is_string( $screen ) )
+    } elseif ( is_string( $screen ) ) {
         $screen = convert_to_screen( $screen );
+    } elseif ( is_array( $screen ) ) {
+        foreach ( $screen as $single_screen ) {
+            add_meta_box( $id, $title, $callback, $single_screen, $context, $priority, $callback_args );
+        }
+    }
+
+    if ( ! isset( $screen->id ) ) {
+        return;
+    }
 
     $page = $screen->id;
@@ -1012 +1024 @@
 
 /**
- * Remove a meta box from an edit form.
+ * Removes a meta box from one or more screens.
  *
  * @since 2.6.0
+ * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
  *
  * @global array $wp_meta_boxes
  *
  * @param string        $id      String for use in the 'id' attribute of tags.
- * @param string|object $screen  The screen on which to show the box (post, page, link).
+ * @param string|array|WP_Screen $screen The screen or screens on which the meta box is shown (such as a
+ *                                       post type, 'link', or 'comment'). Accepts a single screen ID,
+ *                                       WP_Screen object, or array of screen IDs.
  * @param string        $context The context within the page where the boxes should show ('normal', 'advanced').
  */
-function remove_meta_box($id, $screen, $context) {
+function remove_meta_box( $id, $screen, $context ) {
     global $wp_meta_boxes;
 
-    if ( empty( $screen ) )
+    if ( empty( $screen ) ) {
         $screen = get_current_screen();
-    elseif ( is_string( $screen ) )
+    } elseif ( is_string( $screen ) ) {
         $screen = convert_to_screen( $screen );
+    } elseif ( is_array( $screen ) ) {
+        foreach ( $screen as $single_screen ) {
+            remove_meta_box( $id, $single_screen, $context );
+        }
+    }
+
+    if ( ! isset( $screen->id ) ) {
+        return;
+    }
 
     $page = $screen->id;