Changeset 34951

Timestamp:

10/08/2015 07:06:32 PM (9 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.

Location:

trunk

Files:

• src/wp-admin/includes/template-functions.php (modified) (4 diffs)
• tests/phpunit/tests/admin/includesTemplate.php (modified) (1 diff)

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;

trunk/tests/phpunit/tests/admin/includesTemplate.php

@@ -46 +46 @@
         $this->assertEquals('', checked(0,false,false));
     }
+
+    public function test_add_meta_box() {
+        global $wp_meta_boxes;
+
+        add_meta_box( 'testbox1', 'Test Metabox', '__return_false', 'post' );
+        
+        $this->assertArrayHasKey( 'testbox1', $wp_meta_boxes['post']['advanced']['default'] );
+    }
+
+    public function test_remove_meta_box() {
+        global $wp_meta_boxes;
+
+        // Add a meta boxes to remove.
+        add_meta_box( 'testbox1', 'Test Metabox', '__return_false', $current_screen = 'post' );
+
+        // Confirm it's there.
+        $this->assertArrayHasKey( 'testbox1', $wp_meta_boxes[ $current_screen ]['advanced']['default'] );
+
+        // Remove the meta box.
+        remove_meta_box( 'testbox1', $current_screen, 'advanced' );
+
+        // Check that it was removed properly (The meta box should be set to false once that it has been removed)
+        $this->assertFalse( $wp_meta_boxes[ $current_screen ]['advanced']['default']['testbox1'] );
+    }
+
+    /**
+     * @ticket 15000
+     */
+    public function test_add_meta_box_on_multiple_screens() {
+        global $wp_meta_boxes;
+
+        // Add a meta box to three different post types
+        add_meta_box( 'testbox1', 'Test Metabox', '__return_false', array( 'post', 'comment', 'attachment' ) );
+
+        $this->assertArrayHasKey( 'testbox1', $wp_meta_boxes['post']['advanced']['default'] ); 
+        $this->assertArrayHasKey( 'testbox1', $wp_meta_boxes['comment']['advanced']['default'] );
+        $this->assertArrayHasKey( 'testbox1', $wp_meta_boxes['attachment']['advanced']['default'] );
+    }
+
+    /**
+     * @ticket 15000
+     */
+    public function test_remove_meta_box_from_multiple_screens() {
+        global $wp_meta_boxes;
+
+        // Add a meta box to three different screens.
+        add_meta_box( 'testbox1', 'Test Metabox', '__return_false', array( 'post', 'comment', 'attachment' ) );
+
+        // Remove meta box from posts.
+        remove_meta_box( 'testbox1', 'post', 'advanced' );
+
+        // Check that we have removed the meta boxes only from posts
+        $this->assertFalse( $wp_meta_boxes['post']['advanced']['default']['testbox1'] );
+        $this->assertArrayHasKey( 'testbox1', $wp_meta_boxes['comment']['advanced']['default'] );
+        $this->assertArrayHasKey( 'testbox1', $wp_meta_boxes['attachment']['advanced']['default'] );
+
+        // Remove the meta box from the other screens.
+        remove_meta_box( 'testbox1', array( 'comment', 'attachment' ), 'advanced' );
+
+        $this->assertFalse( $wp_meta_boxes['comment']['advanced']['default']['testbox1'] );
+        $this->assertFalse( $wp_meta_boxes['attachment']['advanced']['default']['testbox1'] );
+    }
+
 }