<!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>[20579] trunk/wp-admin: Clean out layout columns API in WP_Screen.</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/20579">20579</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2012-04-24 20:46:04 +0000 (Tue, 24 Apr 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Clean out layout columns API in WP_Screen.
* Move layout column setup into render_screen_meta() so that the number of columns is available earlier.
* Store the user provisioned number of columns in an instance var.
* Access the var with get_columns()
* Move all templates away from the screen_layout_columns global to the get_columns() method.
* Deprecate the global
* Remove the no longer needed check for 'auto' in the user option.
* Cast the user option to an int.
Props griffinjt
fixes <a href="http://core.trac.wordpress.org/ticket/20506">#20506</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadmineditformadvancedphp">trunk/wp-admin/edit-form-advanced.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="#trunkwpadminincludesscreenphp">trunk/wp-admin/includes/screen.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 (20578 => 20579)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/edit-form-advanced.php 2012-04-24 19:58:21 UTC (rev 20578)
+++ trunk/wp-admin/edit-form-advanced.php 2012-04-24 20:46:04 UTC (rev 20579)
</span><span class="lines">@@ -277,7 +277,7 @@
</span><span class="cx">
</span><span class="cx"> <div id="poststuff">
</span><span class="cx">
</span><del>-<div id="post-body" class="metabox-holder columns-<?php echo 1 == $screen_layout_columns ? '1' : '2'; ?>">
</del><ins>+<div id="post-body" class="metabox-holder columns-<?php echo 1 == get_current_screen()->get_columns() ? '1' : '2'; ?>">
</ins><span class="cx"> <div id="post-body-content">
</span><span class="cx"> <?php if ( post_type_supports($post_type, 'title') ) { ?>
</span><span class="cx"> <div id="titlediv">
</span></span></pre></div>
<a id="trunkwpadmineditlinkformphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/edit-link-form.php (20578 => 20579)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/edit-link-form.php 2012-04-24 19:58:21 UTC (rev 20578)
+++ trunk/wp-admin/edit-link-form.php 2012-04-24 20:46:04 UTC (rev 20579)
</span><span class="lines">@@ -77,7 +77,7 @@
</span><span class="cx">
</span><span class="cx"> <div id="poststuff">
</span><span class="cx">
</span><del>-<div id="post-body" class="metabox-holder columns-<?php echo 1 == $screen_layout_columns ? '1' : '2'; ?>">
</del><ins>+<div id="post-body" class="metabox-holder columns-<?php echo 1 == get_current_screen()->get_columns() ? '1' : '2'; ?>">
</ins><span class="cx"> <div id="post-body-content">
</span><span class="cx"> <div id="namediv" class="stuffbox">
</span><span class="cx"> <h3><label for="link_name"><?php _ex('Name', 'link name') ?></label></h3>
</span></span></pre></div>
<a id="trunkwpadminincludesdashboardphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/dashboard.php (20578 => 20579)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/dashboard.php 2012-04-24 19:58:21 UTC (rev 20578)
+++ trunk/wp-admin/includes/dashboard.php 2012-04-24 20:46:04 UTC (rev 20579)
</span><span class="lines">@@ -193,10 +193,8 @@
</span><span class="cx"> * @since 2.5.0
</span><span class="cx"> */
</span><span class="cx"> function wp_dashboard() {
</span><del>- global $screen_layout_columns;
-
</del><span class="cx"> $screen = get_current_screen();
</span><del>- $class = 'columns-' . $screen_layout_columns;
</del><ins>+ $class = 'columns-' . get_current_screen()->get_columns();
</ins><span class="cx">
</span><span class="cx"> ?>
</span><span class="cx"> <div id="dashboard-widgets" class="metabox-holder <?php echo $class; ?>">
</span></span></pre></div>
<a id="trunkwpadminincludesscreenphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/screen.php (20578 => 20579)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/screen.php 2012-04-24 19:58:21 UTC (rev 20578)
+++ trunk/wp-admin/includes/screen.php 2012-04-24 20:46:04 UTC (rev 20579)
</span><span class="lines">@@ -226,6 +226,15 @@
</span><span class="cx"> public $base;
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * The number of columns to display. Access with get_columns().
+ *
+ * @since 3.4.0
+ * @var int
+ * @access private
+ */
+ private $columns = 0;
+
+ /**
</ins><span class="cx"> * The unique ID of the screen.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.3.0
</span><span class="lines">@@ -665,7 +674,7 @@
</span><span class="cx"> public function get_help_sidebar() {
</span><span class="cx"> return $this->_help_sidebar;
</span><span class="cx"> }
</span><del>-
</del><ins>+
</ins><span class="cx"> /**
</span><span class="cx"> * Add a sidebar to the contextual help for the screen.
</span><span class="cx"> * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add a sidebar to the contextual help.
</span><span class="lines">@@ -679,6 +688,23 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Gets the number of layout columns the user has selected.
+ *
+ * The layout_columns option controls the max number and default number of
+ * columns. This method returns the number of columns within that range selected
+ * by the user via Screen Options. If no selection has been made, the default
+ * provisioned in layout_columns is returned. If the screen does not support
+ * selecting the number of layout columns, 0 is returned.
+ *
+ * @since 3.4.0
+ *
+ * @return int Number of columns to display.
+ */
+ public function get_columns() {
+ return $this->columns;
+ }
+
+ /**
</ins><span class="cx"> * Render the screen's help section.
</span><span class="cx"> *
</span><span class="cx"> * This will trigger the deprecated filters for backwards compatibility.
</span><span class="lines">@@ -773,6 +799,22 @@
</span><span class="cx"> </div>
</span><span class="cx"> </div>
</span><span class="cx"> <?php
</span><ins>+ // Setup layout columns
+
+ // Back compat for plugins using the filter instead of add_screen_option()
+ $columns = apply_filters( 'screen_layout_columns', array(), $this->id, $this );
+
+ if ( ! empty( $columns ) && isset( $columns[ $this->id ] ) )
+ $this->add_option( 'layout_columns', array('max' => $columns[ $this->id ] ) );
+
+ if ( $this->get_option( 'layout_columns' ) ) {
+ $this->columns = (int) get_user_option("screen_layout_$this->id");
+
+ if ( ! $this->columns && $this->get_option( 'layout_columns', 'default' ) )
+ $this->columns = $this->get_option( 'layout_columns', 'default' );
+ }
+ $GLOBALS[ 'screen_layout_columns' ] = $this->columns; // Set the gobal for back-compat.
+
</ins><span class="cx"> // Add screen options
</span><span class="cx"> if ( $this->show_screen_options() )
</span><span class="cx"> $this->render_screen_options();
</span><span class="lines">@@ -907,27 +949,12 @@
</span><span class="cx"> * @since 3.3.0
</span><span class="cx"> */
</span><span class="cx"> function render_screen_layout() {
</span><del>- global $screen_layout_columns;
-
- // Back compat for plugins using the filter instead of add_screen_option()
- $columns = apply_filters( 'screen_layout_columns', array(), $this->id, $this );
-
- if ( ! empty( $columns ) && isset( $columns[ $this->id ] ) )
- $this->add_option( 'layout_columns', array('max' => $columns[ $this->id ] ) );
-
- if ( ! $this->get_option('layout_columns') ) {
- $screen_layout_columns = 0;
</del><ins>+ if ( ! $this->get_option('layout_columns') )
</ins><span class="cx"> return;
</span><del>- }
</del><span class="cx">
</span><del>- $screen_layout_columns = get_user_option("screen_layout_$this->id");
</del><ins>+ $screen_layout_columns = $this->get_columns();
</ins><span class="cx"> $num = $this->get_option( 'layout_columns', 'max' );
</span><span class="cx">
</span><del>- if ( ! $screen_layout_columns || 'auto' == $screen_layout_columns ) {
- if ( $this->get_option( 'layout_columns', 'default' ) )
- $screen_layout_columns = $this->get_option( 'layout_columns', 'default' );
- }
-
</del><span class="cx"> ?>
</span><span class="cx"> <h5 class="screen-layout"><?php _e('Screen Layout'); ?></h5>
</span><span class="cx"> <div class='columns-prefs'><?php
</span></span></pre>
</div>
</div>
</body>
</html>