<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34951] trunk: Administration: Add the ability to pass an array of screen IDs to `add_meta_box()` and `remove_meta_box()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34951">34951</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34951","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-10-08 19:06:32 +0000 (Thu, 08 Oct 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/15000">#15000</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludestemplatefunctionsphp">trunk/src/wp-admin/includes/template-functions.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesTemplatephp">trunk/tests/phpunit/tests/admin/includesTemplate.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludestemplatefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/template-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/template-functions.php 2015-10-08 18:26:13 UTC (rev 34950)
+++ trunk/src/wp-admin/includes/template-functions.php 2015-10-08 19:06:32 UTC (rev 34951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -847,9 +847,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add a meta box to an edit form.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds a meta box to one or more screens.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_meta_boxes
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -857,8 +858,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Title of the meta box.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param callable $callback Function that fills the box with the desired content.
</span><span class="cx" style="display: block; padding: 0 10px"> * The function should echo its output.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Optional. The context within the screen where the boxes
</span><span class="cx" style="display: block; padding: 0 10px"> * should display. Available contexts vary from screen to
</span><span class="cx" style="display: block; padding: 0 10px"> * screen. Post edit screen contexts include 'normal', 'side',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -874,11 +877,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advanced', $priority = 'default', $callback_args = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_meta_boxes;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $screen ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $screen ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $screen = get_current_screen();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- elseif ( is_string( $screen ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_string( $screen ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $screen = convert_to_screen( $screen );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_array( $screen ) ) {
+ foreach ( $screen as $single_screen ) {
+ add_meta_box( $id, $title, $callback, $single_screen, $context, $priority, $callback_args );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $screen->id ) ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $page = $screen->id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !isset($wp_meta_boxes) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1011,24 +1023,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Remove a meta box from an edit form.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Removes a meta box from one or more screens.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_meta_boxes
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $id String for use in the 'id' attribute of tags.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|object $screen The screen on which to show the box (post, page, link).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $context The context within the page where the boxes should show ('normal', 'advanced').
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function remove_meta_box($id, $screen, $context) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function remove_meta_box( $id, $screen, $context ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_meta_boxes;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $screen ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $screen ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $screen = get_current_screen();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- elseif ( is_string( $screen ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_string( $screen ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $screen = convert_to_screen( $screen );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( is_array( $screen ) ) {
+ foreach ( $screen as $single_screen ) {
+ remove_meta_box( $id, $single_screen, $context );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $screen->id ) ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $page = $screen->id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !isset($wp_meta_boxes) )
</span></span></pre></div>
<a id="trunktestsphpunittestsadminincludesTemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/includesTemplate.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesTemplate.php 2015-10-08 18:26:13 UTC (rev 34950)
+++ trunk/tests/phpunit/tests/admin/includesTemplate.php 2015-10-08 19:06:32 UTC (rev 34951)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,4 +45,67 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals('', selected(0,false,false));
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals('', checked(0,false,false));
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ 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'] );
+ }
+
+}
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>