<!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>[27256] trunk/src/wp-admin/includes/screen.php: Inline documentation for hooks in wp-admin/includes/screen.php.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27256">27256</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-02-25 10:04:46 +0000 (Tue, 25 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-admin/includes/screen.php.
Props enej, kpdesign.
Fixes <a href="http://core.trac.wordpress.org/ticket/26821">#26821</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesscreenphp">trunk/src/wp-admin/includes/screen.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesscreenphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/screen.php (27255 => 27256)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/screen.php 2014-02-25 06:11:32 UTC (rev 27255)
+++ trunk/src/wp-admin/includes/screen.php 2014-02-25 10:04:46 UTC (rev 27256)
</span><span class="lines">@@ -20,8 +20,22 @@
</span><span class="cx">
</span><span class="cx"> static $column_headers = array();
</span><span class="cx">
</span><del>- if ( ! isset( $column_headers[ $screen->id ] ) )
</del><ins>+ if ( ! isset( $column_headers[ $screen->id ] ) ) {
+
+ /**
+ * Filter the column headers for a list table on a specific screen.
+ *
+ * The dynamic portion of the hook name, $screen->id, refers to the
+ * ID of a specific screen. For example, the screen ID for the Posts
+ * list table is edit-post, so the filter for that screen would be
+ * manage_edit-post_columns.
+ *
+ * @since 3.0.0
+ *
+ * @param array $columns An array of column headers. Default empty.
+ */
</ins><span class="cx"> $column_headers[ $screen->id ] = apply_filters( 'manage_' . $screen->id . '_columns', array() );
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> return $column_headers[ $screen->id ];
</span><span class="cx"> }
</span><span class="lines">@@ -101,9 +115,28 @@
</span><span class="cx"> else
</span><span class="cx"> $hidden = array( 'slugdiv' );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * Filter the default list of hidden meta boxes.
+ *
+ * @since 3.1.0
+ *
+ * @param array $hidden An array of meta boxes hidden by default.
+ * @param WP_Screen $screen WP_Screen object of the current screen.
+ */
</ins><span class="cx"> $hidden = apply_filters( 'default_hidden_meta_boxes', $hidden, $screen );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Filter the list of hidden meta boxes.
+ *
+ * @since 3.3.0
+ *
+ * @param array $hidden An array of hidden meta boxes.
+ * @param WP_Screen $screen WP_Screen object of the current screen.
+ * @param bool $use_defaults Whether to show the default meta boxes.
+ * Default true.
+ */
</ins><span class="cx"> return apply_filters( 'hidden_meta_boxes', $hidden, $screen, $use_defaults );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -502,6 +535,14 @@
</span><span class="cx"> $current_screen = $this;
</span><span class="cx"> $taxnow = $this->taxonomy;
</span><span class="cx"> $typenow = $this->post_type;
</span><ins>+
+ /**
+ * Fires after the current screen has been set.
+ *
+ * @since 3.0.0
+ *
+ * @param WP_Screen $current_screen Current WP_Screen object.
+ */
</ins><span class="cx"> do_action( 'current_screen', $current_screen );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -747,14 +788,46 @@
</span><span class="cx"> */
</span><span class="cx"> public function render_screen_meta() {
</span><span class="cx">
</span><del>- // Call old contextual_help_list filter.
</del><ins>+ /**
+ * Filter the legacy contextual help list.
+ *
+ * @since 2.7.0
+ * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
+ * get_current_screen()->remove_help_tab() instead.
+ *
+ * @param array $old_compat_help Old contextual help.
+ * @param WP_Screen $this Current WP_Screen instance.
+ */
</ins><span class="cx"> self::$_old_compat_help = apply_filters( 'contextual_help_list', self::$_old_compat_help, $this );
</span><span class="cx">
</span><span class="cx"> $old_help = isset( self::$_old_compat_help[ $this->id ] ) ? self::$_old_compat_help[ $this->id ] : '';
</span><ins>+
+ /**
+ * Filter the legacy contextual help text.
+ *
+ * @since 2.7.0
+ * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
+ * get_current_screen()->remove_help_tab() instead.
+ *
+ * @param string $old_help Help text that appears on the screen.
+ * @param string $screen_id Screen ID.
+ * @param WP_Screen $this Current WP_Screen instance.
+ *
+ */
</ins><span class="cx"> $old_help = apply_filters( 'contextual_help', $old_help, $this->id, $this );
</span><span class="cx">
</span><span class="cx"> // Default help only if there is no old-style block of text and no new-style help tabs.
</span><span class="cx"> if ( empty( $old_help ) && ! $this->get_help_tabs() ) {
</span><ins>+
+ /**
+ * Filter the default legacy contextual help text.
+ *
+ * @since 2.8.0
+ * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
+ * get_current_screen()->remove_help_tab() instead.
+ *
+ * @param string $old_help_default Default contextual help text.
+ */
</ins><span class="cx"> $default_help = apply_filters( 'default_contextual_help', '' );
</span><span class="cx"> if ( $default_help )
</span><span class="cx"> $old_help = '<p>' . $default_help . '</p>';
</span><span class="lines">@@ -835,7 +908,18 @@
</span><span class="cx"> <?php
</span><span class="cx"> // Setup layout columns
</span><span class="cx">
</span><del>- // Back compat for plugins using the filter instead of add_screen_option()
</del><ins>+ /**
+ * Filter the array of screen layout columns.
+ *
+ * This hook provides back-compat for plugins using the back-compat
+ * filter instead of add_screen_option().
+ *
+ * @since 2.8.0
+ *
+ * @param array $empty_columns Empty array.
+ * @param string $screen_id Screen ID.
+ * @param WP_Screen $this Current WP_Screen instance.
+ */
</ins><span class="cx"> $columns = apply_filters( 'screen_layout_columns', array(), $this->id, $this );
</span><span class="cx">
</span><span class="cx"> if ( ! empty( $columns ) && isset( $columns[ $this->id ] ) )
</span><span class="lines">@@ -892,11 +976,31 @@
</span><span class="cx"> break;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Filter the screen settings text displayed in the Screen Options tab.
+ *
+ * This filter is currently only used on the Widgets screen to enable
+ * accessibility mode.
+ *
+ * @since 3.0.0
+ *
+ * @param string $screen_settings Screen settings.
+ * @param WP_Screen $this WP_Screen object.
+ */
</ins><span class="cx"> $this->_screen_settings = apply_filters( 'screen_settings', $this->_screen_settings, $this );
</span><span class="cx">
</span><span class="cx"> if ( $this->_screen_settings || $this->_options )
</span><span class="cx"> $show_screen = true;
</span><span class="cx">
</span><ins>+ /**
+ * Filter whether to show the Screen Options tab.
+ *
+ * @since 3.2.0
+ *
+ * @param bool $show_screen Whether to show Screen Options tab.
+ * Default true.
+ * @param WP_Screen $this Current WP_Screen instance.
+ */
</ins><span class="cx"> $this->_show_screen_options = apply_filters( 'screen_options_show_screen', $show_screen, $this );
</span><span class="cx"> return $this->_show_screen_options;
</span><span class="cx"> }
</span><span class="lines">@@ -1034,16 +1138,22 @@
</span><span class="cx">
</span><span class="cx"> if ( 'edit_comments_per_page' == $option ) {
</span><span class="cx"> $comment_status = isset( $_REQUEST['comment_status'] ) ? $_REQUEST['comment_status'] : 'all';
</span><ins>+
+ /** This filter is documented in wp-admin/includes/class-wp-comments-list-table.php */
</ins><span class="cx"> $per_page = apply_filters( 'comments_per_page', $per_page, $comment_status );
</span><span class="cx"> } elseif ( 'categories_per_page' == $option ) {
</span><ins>+ /** This filter is documented in wp-admin/includes/class-wp-terms-list-table.php */
</ins><span class="cx"> $per_page = apply_filters( 'edit_categories_per_page', $per_page );
</span><span class="cx"> } else {
</span><ins>+ /** This filter is documented in wp-admin/includes/class-wp-list-table.php */
</ins><span class="cx"> $per_page = apply_filters( $option, $per_page );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Back compat
</span><del>- if ( isset( $this->post_type ) )
</del><ins>+ if ( isset( $this->post_type ) ) {
+ /** This filter is documented in wp-admin/includes/class-wp-posts-list-table.php */
</ins><span class="cx"> $per_page = apply_filters( 'edit_posts_per_page', $per_page, $this->post_type );
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> ?>
</span><span class="cx"> <div class="screen-options">
</span></span></pre>
</div>
</div>
</body>
</html>