<!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>[19013] trunk/wp-admin: Update meta box functions to handle WP_Screen objects and pass objects instead of IDs to them in core files.</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, #logmsg > ol { margin-left: 0; 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/19013">19013</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2011-10-19 21:43:02 +0000 (Wed, 19 Oct 2011)</dd>
</dl>
<h3>Log Message</h3>
<pre>Update meta box functions to handle WP_Screen objects and pass objects instead of IDs to them in core files. Allow passing emptiness to get the current screen. see <a href="http://core.trac.wordpress.org/ticket/18958">#18958</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadmineditformadvancedphp">trunk/wp-admin/edit-form-advanced.php</a></li>
<li><a href="#trunkwpadmineditformcommentphp">trunk/wp-admin/edit-form-comment.php</a></li>
<li><a href="#trunkwpadmineditlinkformphp">trunk/wp-admin/edit-link-form.php</a></li>
<li><a href="#trunkwpadminincludesdashboardphp">trunk/wp-admin/includes/dashboard.php</a></li>
<li><a href="#trunkwpadminincludestemplatephp">trunk/wp-admin/includes/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadmineditformadvancedphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/edit-form-advanced.php (19012 => 19013)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/edit-form-advanced.php 2011-10-19 21:06:50 UTC (rev 19012)
+++ trunk/wp-admin/edit-form-advanced.php 2011-10-19 21:43:02 UTC (rev 19013)
</span><span class="lines">@@ -99,10 +99,10 @@
</span><span class="cx"> // All meta boxes should be defined and added before the first do_meta_boxes() call (or potentially during the do_meta_boxes action).
</span><span class="cx"> require_once('./includes/meta-boxes.php');
</span><span class="cx">
</span><del>-add_meta_box('submitdiv', __('Publish'), 'post_submit_meta_box', $post_type, 'side', 'core');
</del><ins>+add_meta_box('submitdiv', __('Publish'), 'post_submit_meta_box', null, 'side', 'core');
</ins><span class="cx">
</span><span class="cx"> if ( current_theme_supports( 'post-formats' ) && post_type_supports( $post_type, 'post-formats' ) )
</span><del>- add_meta_box( 'formatdiv', _x( 'Format', 'post format' ), 'post_format_meta_box', $post_type, 'side', 'core' );
</del><ins>+ add_meta_box( 'formatdiv', _x( 'Format', 'post format' ), 'post_format_meta_box', null, 'side', 'core' );
</ins><span class="cx">
</span><span class="cx"> // all taxonomies
</span><span class="cx"> foreach ( get_object_taxonomies($post_type) as $tax_name ) {
</span><span class="lines">@@ -113,43 +113,43 @@
</span><span class="cx"> $label = $taxonomy->labels->name;
</span><span class="cx">
</span><span class="cx"> if ( !is_taxonomy_hierarchical($tax_name) )
</span><del>- add_meta_box('tagsdiv-' . $tax_name, $label, 'post_tags_meta_box', $post_type, 'side', 'core', array( 'taxonomy' => $tax_name ));
</del><ins>+ add_meta_box('tagsdiv-' . $tax_name, $label, 'post_tags_meta_box', null, 'side', 'core', array( 'taxonomy' => $tax_name ));
</ins><span class="cx"> else
</span><del>- add_meta_box($tax_name . 'div', $label, 'post_categories_meta_box', $post_type, 'side', 'core', array( 'taxonomy' => $tax_name ));
</del><ins>+ add_meta_box($tax_name . 'div', $label, 'post_categories_meta_box', null, 'side', 'core', array( 'taxonomy' => $tax_name ));
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> if ( post_type_supports($post_type, 'page-attributes') )
</span><del>- add_meta_box('pageparentdiv', 'page' == $post_type ? __('Page Attributes') : __('Attributes'), 'page_attributes_meta_box', $post_type, 'side', 'core');
</del><ins>+ add_meta_box('pageparentdiv', 'page' == $post_type ? __('Page Attributes') : __('Attributes'), 'page_attributes_meta_box', null, 'side', 'core');
</ins><span class="cx">
</span><span class="cx"> if ( current_theme_supports( 'post-thumbnails', $post_type ) && post_type_supports( $post_type, 'thumbnail' ) )
</span><del>- add_meta_box('postimagediv', __('Featured Image'), 'post_thumbnail_meta_box', $post_type, 'side', 'low');
</del><ins>+ add_meta_box('postimagediv', __('Featured Image'), 'post_thumbnail_meta_box', null, 'side', 'low');
</ins><span class="cx">
</span><span class="cx"> if ( post_type_supports($post_type, 'excerpt') )
</span><del>- add_meta_box('postexcerpt', __('Excerpt'), 'post_excerpt_meta_box', $post_type, 'normal', 'core');
</del><ins>+ add_meta_box('postexcerpt', __('Excerpt'), 'post_excerpt_meta_box', null, 'normal', 'core');
</ins><span class="cx">
</span><span class="cx"> if ( post_type_supports($post_type, 'trackbacks') )
</span><del>- add_meta_box('trackbacksdiv', __('Send Trackbacks'), 'post_trackback_meta_box', $post_type, 'normal', 'core');
</del><ins>+ add_meta_box('trackbacksdiv', __('Send Trackbacks'), 'post_trackback_meta_box', null, 'normal', 'core');
</ins><span class="cx">
</span><span class="cx"> if ( post_type_supports($post_type, 'custom-fields') )
</span><del>- add_meta_box('postcustom', __('Custom Fields'), 'post_custom_meta_box', $post_type, 'normal', 'core');
</del><ins>+ add_meta_box('postcustom', __('Custom Fields'), 'post_custom_meta_box', null, 'normal', 'core');
</ins><span class="cx">
</span><span class="cx"> do_action('dbx_post_advanced');
</span><span class="cx"> if ( post_type_supports($post_type, 'comments') )
</span><del>- add_meta_box('commentstatusdiv', __('Discussion'), 'post_comment_status_meta_box', $post_type, 'normal', 'core');
</del><ins>+ add_meta_box('commentstatusdiv', __('Discussion'), 'post_comment_status_meta_box', null, 'normal', 'core');
</ins><span class="cx">
</span><span class="cx"> if ( ('publish' == $post->post_status || 'private' == $post->post_status) && post_type_supports($post_type, 'comments') )
</span><del>- add_meta_box('commentsdiv', __('Comments'), 'post_comment_meta_box', $post_type, 'normal', 'core');
</del><ins>+ add_meta_box('commentsdiv', __('Comments'), 'post_comment_meta_box', null, 'normal', 'core');
</ins><span class="cx">
</span><span class="cx"> if ( !( 'pending' == $post->post_status && !current_user_can( $post_type_object->cap->publish_posts ) ) )
</span><del>- add_meta_box('slugdiv', __('Slug'), 'post_slug_meta_box', $post_type, 'normal', 'core');
</del><ins>+ add_meta_box('slugdiv', __('Slug'), 'post_slug_meta_box', null, 'normal', 'core');
</ins><span class="cx">
</span><span class="cx"> if ( post_type_supports($post_type, 'author') ) {
</span><span class="cx"> if ( is_super_admin() || current_user_can( $post_type_object->cap->edit_others_posts ) )
</span><del>- add_meta_box('authordiv', __('Author'), 'post_author_meta_box', $post_type, 'normal', 'core');
</del><ins>+ add_meta_box('authordiv', __('Author'), 'post_author_meta_box', null, 'normal', 'core');
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> if ( post_type_supports($post_type, 'revisions') && 0 < $post_ID && wp_get_post_revisions( $post_ID ) )
</span><del>- add_meta_box('revisionsdiv', __('Revisions'), 'post_revisions_meta_box', $post_type, 'normal', 'core');
</del><ins>+ add_meta_box('revisionsdiv', __('Revisions'), 'post_revisions_meta_box', null, 'normal', 'core');
</ins><span class="cx">
</span><span class="cx"> do_action('add_meta_boxes', $post_type, $post);
</span><span class="cx"> do_action('add_meta_boxes_' . $post_type, $post);
</span><span class="lines">@@ -347,11 +347,11 @@
</span><span class="cx"> $side_meta_boxes = do_meta_boxes($post_type, 'side', $post);
</span><span class="cx"> }
</span><span class="cx">
</span><del>-do_meta_boxes($post_type, 'normal', $post);
</del><ins>+do_meta_boxes(null, 'normal', $post);
</ins><span class="cx">
</span><span class="cx"> ( 'page' == $post_type ) ? do_action('edit_page_form') : do_action('edit_form_advanced');
</span><span class="cx">
</span><del>-do_meta_boxes($post_type, 'advanced', $post);
</del><ins>+do_meta_boxes(null, 'advanced', $post);
</ins><span class="cx">
</span><span class="cx"> do_action('dbx_post_sidebar'); ?>
</span><span class="cx">
</span></span></pre></div>
<a id="trunkwpadmineditformcommentphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/edit-form-comment.php (19012 => 19013)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/edit-form-comment.php 2011-10-19 21:06:50 UTC (rev 19012)
+++ trunk/wp-admin/edit-form-comment.php 2011-10-19 21:43:02 UTC (rev 19013)
</span><span class="lines">@@ -130,7 +130,7 @@
</span><span class="cx"> do_action('add_meta_boxes', 'comment', $comment);
</span><span class="cx"> do_action('add_meta_boxes_comment', $comment);
</span><span class="cx">
</span><del>-do_meta_boxes('comment', 'normal', $comment);
</del><ins>+do_meta_boxes(null, 'normal', $comment);
</ins><span class="cx"> ?>
</span><span class="cx"> <input type="hidden" name="c" value="<?php echo esc_attr($comment->comment_ID) ?>" />
</span><span class="cx"> <input type="hidden" name="p" value="<?php echo esc_attr($comment->comment_post_ID) ?>" />
</span></span></pre></div>
<a id="trunkwpadmineditlinkformphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/edit-link-form.php (19012 => 19013)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/edit-link-form.php 2011-10-19 21:06:50 UTC (rev 19012)
+++ trunk/wp-admin/edit-link-form.php 2011-10-19 21:43:02 UTC (rev 19013)
</span><span class="lines">@@ -24,11 +24,11 @@
</span><span class="cx">
</span><span class="cx"> require_once('./includes/meta-boxes.php');
</span><span class="cx">
</span><del>-add_meta_box('linksubmitdiv', __('Save'), 'link_submit_meta_box', 'link', 'side', 'core');
-add_meta_box('linkcategorydiv', __('Categories'), 'link_categories_meta_box', 'link', 'normal', 'core');
-add_meta_box('linktargetdiv', __('Target'), 'link_target_meta_box', 'link', 'normal', 'core');
-add_meta_box('linkxfndiv', __('Link Relationship (XFN)'), 'link_xfn_meta_box', 'link', 'normal', 'core');
-add_meta_box('linkadvanceddiv', __('Advanced'), 'link_advanced_meta_box', 'link', 'normal', 'core');
</del><ins>+add_meta_box('linksubmitdiv', __('Save'), 'link_submit_meta_box', null, 'side', 'core');
+add_meta_box('linkcategorydiv', __('Categories'), 'link_categories_meta_box', null, 'normal', 'core');
+add_meta_box('linktargetdiv', __('Target'), 'link_target_meta_box', null, 'normal', 'core');
+add_meta_box('linkxfndiv', __('Link Relationship (XFN)'), 'link_xfn_meta_box', null, 'normal', 'core');
+add_meta_box('linkadvanceddiv', __('Advanced'), 'link_advanced_meta_box', null, 'normal', 'core');
</ins><span class="cx">
</span><span class="cx"> do_action('add_meta_boxes', 'link', $link);
</span><span class="cx"> do_action('add_meta_boxes_link', $link);
</span><span class="lines">@@ -112,9 +112,9 @@
</span><span class="cx"> $side_meta_boxes = do_meta_boxes( 'link', 'side', $link );
</span><span class="cx"> }
</span><span class="cx">
</span><del>-do_meta_boxes('link', 'normal', $link);
</del><ins>+do_meta_boxes(null, 'normal', $link);
</ins><span class="cx">
</span><del>-do_meta_boxes('link', 'advanced', $link);
</del><ins>+do_meta_boxes(null, 'advanced', $link);
</ins><span class="cx">
</span><span class="cx"> if ( $link_id ) : ?>
</span><span class="cx"> <input type="hidden" name="action" value="save" />
</span></span></pre></div>
<a id="trunkwpadminincludesdashboardphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/dashboard.php (19012 => 19013)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/dashboard.php 2011-10-19 21:06:50 UTC (rev 19012)
+++ trunk/wp-admin/includes/dashboard.php 2011-10-19 21:43:02 UTC (rev 19013)
</span><span class="lines">@@ -176,7 +176,7 @@
</span><span class="cx"> if ( 'dashboard_browser_nag' === $widget_id )
</span><span class="cx"> $priority = 'high';
</span><span class="cx">
</span><del>- add_meta_box( $widget_id, $widget_name, $callback, $screen->id, $location, $priority );
</del><ins>+ add_meta_box( $widget_id, $widget_name, $callback, $screen, $location, $priority );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function _wp_dashboard_control_callback( $dashboard, $meta_box ) {
</span></span></pre></div>
<a id="trunkwpadminincludestemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/template.php (19012 => 19013)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/template.php 2011-10-19 21:06:50 UTC (rev 19012)
+++ trunk/wp-admin/includes/template.php 2011-10-19 21:43:02 UTC (rev 19013)
</span><span class="lines">@@ -839,13 +839,20 @@
</span><span class="cx"> * @param string $id String for use in the 'id' attribute of tags.
</span><span class="cx"> * @param string $title Title of the meta box.
</span><span class="cx"> * @param string $callback Function that fills the box with the desired content. The function should echo its output.
</span><del>- * @param string $page The type of edit page on which to show the box (post, page, link).
</del><ins>+ * @param string|object $screen The screen on which to show the box (post, page, link).
</ins><span class="cx"> * @param string $context The context within the page where the boxes should show ('normal', 'advanced').
</span><span class="cx"> * @param string $priority The priority within the context where the boxes should show ('high', 'low').
</span><span class="cx"> */
</span><del>-function add_meta_box($id, $title, $callback, $page, $context = 'advanced', $priority = 'default', $callback_args=null) {
</del><ins>+function add_meta_box($id, $title, $callback, $screen, $context = 'advanced', $priority = 'default', $callback_args=null) {
</ins><span class="cx"> global $wp_meta_boxes;
</span><span class="cx">
</span><ins>+ if ( empty( $screen ) )
+ $screen = get_current_screen();
+ elseif ( is_string( $screen ) )
+ $screen = convert_to_screen( $screen );
+
+ $page = $screen->id;
+
</ins><span class="cx"> if ( !isset($wp_meta_boxes) )
</span><span class="cx"> $wp_meta_boxes = array();
</span><span class="cx"> if ( !isset($wp_meta_boxes[$page]) )
</span><span class="lines">@@ -899,17 +906,24 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.5.0
</span><span class="cx"> *
</span><del>- * @param string $page page identifier, also known as screen identifier
</del><ins>+ * @param string|object $screen Screen identifier
</ins><span class="cx"> * @param string $context box context
</span><span class="cx"> * @param mixed $object gets passed to the box callback function as first parameter
</span><span class="cx"> * @return int number of meta_boxes
</span><span class="cx"> */
</span><del>-function do_meta_boxes($page, $context, $object) {
</del><ins>+function do_meta_boxes( $screen, $context, $object ) {
</ins><span class="cx"> global $wp_meta_boxes;
</span><span class="cx"> static $already_sorted = false;
</span><span class="cx">
</span><del>- $hidden = get_hidden_meta_boxes($page);
</del><ins>+ if ( empty( $screen ) )
+ $screen = get_current_screen();
+ elseif ( is_string( $screen ) )
+ $screen = convert_to_screen( $screen );
</ins><span class="cx">
</span><ins>+ $page = $screen->id;
+
+ $hidden = get_hidden_meta_boxes( $screen );
+
</ins><span class="cx"> printf('<div id="%s-sortables" class="meta-box-sortables">', htmlspecialchars($context));
</span><span class="cx">
</span><span class="cx"> $i = 0;
</span><span class="lines">@@ -919,7 +933,7 @@
</span><span class="cx"> foreach ( $sorted as $box_context => $ids ) {
</span><span class="cx"> foreach ( explode(',', $ids ) as $id ) {
</span><span class="cx"> if ( $id && 'dashboard_browser_nag' !== $id )
</span><del>- add_meta_box( $id, null, null, $page, $box_context, 'sorted' );
</del><ins>+ add_meta_box( $id, null, null, $screen, $box_context, 'sorted' );
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="lines">@@ -961,12 +975,19 @@
</span><span class="cx"> * @since 2.6.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $id String for use in the 'id' attribute of tags.
</span><del>- * @param string $page The type of edit page on which to show the box (post, page, link).
</del><ins>+ * @param string|object $screen The screen on which to show the box (post, page, link).
</ins><span class="cx"> * @param string $context The context within the page where the boxes should show ('normal', 'advanced').
</span><span class="cx"> */
</span><del>-function remove_meta_box($id, $page, $context) {
</del><ins>+function remove_meta_box($id, $screen, $context) {
</ins><span class="cx"> global $wp_meta_boxes;
</span><span class="cx">
</span><ins>+ if ( empty( $screen ) )
+ $screen = get_current_screen();
+ elseif ( is_string( $screen ) )
+ $screen = convert_to_screen( $screen );
+
+ $page = $screen->id;
+
</ins><span class="cx"> if ( !isset($wp_meta_boxes) )
</span><span class="cx"> $wp_meta_boxes = array();
</span><span class="cx"> if ( !isset($wp_meta_boxes[$page]) )
</span></span></pre>
</div>
</div>
</body>
</html>