<!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>[28083] trunk/src: Priority fixes for various existing hook documentation.</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/28083">28083</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-04-12 00:00:32 +0000 (Sat, 12 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Priority fixes for various existing hook documentation.
Props kpdesign.
See <a href="http://core.trac.wordpress.org/ticket/26869">#26869</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesplugininstallphp">trunk/src/wp-admin/includes/plugin-install.php</a></li>
<li><a href="#trunksrcwpadminnetworkadminphp">trunk/src/wp-admin/network/admin.php</a></li>
<li><a href="#trunksrcwpadminoptionsdiscussionphp">trunk/src/wp-admin/options-discussion.php</a></li>
<li><a href="#trunksrcwpadminoptionswritingphp">trunk/src/wp-admin/options-writing.php</a></li>
<li><a href="#trunksrcwpadminoptionsphp">trunk/src/wp-admin/options.php</a></li>
<li><a href="#trunksrcwpadminuseradminphp">trunk/src/wp-admin/user/admin.php</a></li>
<li><a href="#trunksrcwpincludesclasswpembedphp">trunk/src/wp-includes/class-wp-embed.php</a></li>
<li><a href="#trunksrcwpincludesclasswpxmlrpcserverphp">trunk/src/wp-includes/class-wp-xmlrpc-server.php</a></li>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesplugininstallphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/plugin-install.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/plugin-install.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-admin/includes/plugin-install.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -53,7 +53,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><span class="cx"> *
</span><del>- * @param bool|object The result object. Default is false.
</del><ins>+ * @param bool|object $result The result object. Default false.
</ins><span class="cx"> * @param string $action The type of information being requested from the Plugin Install API.
</span><span class="cx"> * @param object $args Plugin API arguments.
</span><span class="cx"> */
</span></span></pre></div>
<a id="trunksrcwpadminnetworkadminphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/network/admin.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/network/admin.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-admin/network/admin.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -22,7 +22,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.2.0
</span><span class="cx"> *
</span><del>- * @param bool $redirect_user_admin_request Whether the request should be redirected.
</del><ins>+ * @param bool $redirect_network_admin_request Whether the request should be redirected.
</ins><span class="cx"> */
</span><span class="cx"> $redirect_network_admin_request = apply_filters( 'redirect_network_admin_request', $redirect_network_admin_request );
</span><span class="cx"> if ( $redirect_network_admin_request ) {
</span></span></pre></div>
<a id="trunksrcwpadminoptionsdiscussionphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/options-discussion.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/options-discussion.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-admin/options-discussion.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -80,7 +80,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0.
</span><span class="cx"> *
</span><del>- * @param int $10 The maximum depth of threaded comments. Default 10.
</del><ins>+ * @param int $max_depth The maximum depth of threaded comments. Default 10.
</ins><span class="cx"> */
</span><span class="cx"> $maxdeep = (int) apply_filters( 'thread_comments_depth_max', 10 );
</span><span class="cx">
</span></span></pre></div>
<a id="trunksrcwpadminoptionswritingphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/options-writing.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/options-writing.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-admin/options-writing.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -37,13 +37,7 @@
</span><span class="cx"> ) );
</span><span class="cx"> }
</span><span class="cx">
</span><del>-/**
- * Toggle site update services configuration functionality.
- *
- * @since 3.0.0
- *
- * @param bool True or false, based on whether update services configuration is enabled or not.
- */
</del><ins>+/** This filter is documented in wp-admin/options-writing.php */
</ins><span class="cx"> if ( apply_filters( 'enable_update_services_configuration', true ) ) {
</span><span class="cx"> get_current_screen()->add_help_tab( array(
</span><span class="cx"> 'id' => 'options-services',
</span><span class="lines">@@ -167,7 +161,13 @@
</span><span class="cx"> <?php } ?>
</span><span class="cx">
</span><span class="cx"> <?php
</span><del>-/** This filter is documented in wp-admin/options-writing.php */
</del><ins>+/**
+ * Filter whether to enable the Update Services section in the Writing settings screen.
+ *
+ * @since 3.0.0
+ *
+ * @param bool $enable Whether to enable the Update Services settings area. Default true.
+ */
</ins><span class="cx"> if ( apply_filters( 'enable_update_services_configuration', true ) ) {
</span><span class="cx"> ?>
</span><span class="cx"> <h3 class="title"><?php _e('Update Services') ?></h3>
</span></span></pre></div>
<a id="trunksrcwpadminoptionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/options.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/options.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-admin/options.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -108,11 +108,11 @@
</span><span class="cx"> $whitelist_options['general'][] = 'WPLANG';
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Toggle post-by-email functionality.
</del><ins>+ * Filter whether the post-by-email functionality is enabled.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param bool True or false, based on whether post-by-email configuration is enabled or not.
</del><ins>+ * @param bool $enabled Whether post-by-email configuration is enabled. Default true.
</ins><span class="cx"> */
</span><span class="cx"> if ( apply_filters( 'enable_post_by_email_configuration', true ) )
</span><span class="cx"> $whitelist_options['writing'] = array_merge($whitelist_options['writing'], $mail_options);
</span></span></pre></div>
<a id="trunksrcwpadminuseradminphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/user/admin.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/user/admin.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-admin/user/admin.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -18,11 +18,8 @@
</span><span class="cx">
</span><span class="cx"> $redirect_user_admin_request = ( ( $current_blog->domain != $current_site->domain ) || ( $current_blog->path != $current_site->path ) );
</span><span class="cx"> /**
</span><del>- * Filter whether a user should be redirected to the Global Dashboard in Multisite.
</del><ins>+ * Filter whether to redirect the request to the User Admin in Multisite.
</ins><span class="cx"> *
</span><del>- * Users not assigned to any sites in the network will be redirected to the Global
- * Dashboard after logging in.
- *
</del><span class="cx"> * @since 3.2.0
</span><span class="cx"> *
</span><span class="cx"> * @param bool $redirect_user_admin_request Whether the request should be redirected.
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpembedphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-embed.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-embed.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-includes/class-wp-embed.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -209,6 +209,8 @@
</span><span class="cx"> /**
</span><span class="cx"> * Filter whether to inspect the given URL for discoverable <link> tags.
</span><span class="cx"> *
</span><ins>+ * @since 2.9.0
+ *
</ins><span class="cx"> * @see WP_oEmbed::discover()
</span><span class="cx"> *
</span><span class="cx"> * @param bool false Whether to enable <link> tag discovery. Default false.
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpxmlrpcserverphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-xmlrpc-server.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-xmlrpc-server.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-includes/class-wp-xmlrpc-server.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -5775,6 +5775,8 @@
</span><span class="cx"> sleep(1);
</span><span class="cx">
</span><span class="cx"> $remote_ip = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
</span><ins>+
+ /** This filter is documented in wp-includes/class-http.php */
</ins><span class="cx"> $user_agent = apply_filters( 'http_headers_useragent', 'WordPress/' . $GLOBALS['wp_version'] . '; ' . get_bloginfo( 'url' ) );
</span><span class="cx">
</span><span class="cx"> // Let's check the remote site
</span></span></pre></div>
<a id="trunksrcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/comment-template.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/comment-template.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-includes/comment-template.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -518,7 +518,15 @@
</span><span class="cx"> $excerpt .= $blah[$i] . ' ';
</span><span class="cx"> }
</span><span class="cx"> $excerpt .= ($use_dotdotdot) ? '…' : '';
</span><del>- return apply_filters('get_comment_excerpt', $excerpt);
</del><ins>+
+ /**
+ * Filter the retrieved comment excerpt.
+ *
+ * @since 1.5.0
+ *
+ * @param string $excerpt The comment excerpt text.
+ */
+ return apply_filters( 'get_comment_excerpt', $excerpt );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -641,7 +649,7 @@
</span><span class="cx"> /**
</span><span class="cx"> * Filter the returned post comments permalink.
</span><span class="cx"> *
</span><del>- * @since
</del><ins>+ * @since 3.6.0
</ins><span class="cx"> *
</span><span class="cx"> * @param string $comments_link Post comments permalink with '#comments' appended.
</span><span class="cx"> * @param int|WP_Post $post_id Post ID or WP_Post object.
</span><span class="lines">@@ -976,7 +984,7 @@
</span><span class="cx"> /**
</span><span class="cx"> * Filter whether the current post is open for comments.
</span><span class="cx"> *
</span><del>- * @since
</del><ins>+ * @since 2.5.0
</ins><span class="cx"> *
</span><span class="cx"> * @param bool $open Whether the current post is open for comments.
</span><span class="cx"> * @param int|WP_Post $post_id The post ID or WP_Post object.
</span><span class="lines">@@ -997,6 +1005,15 @@
</span><span class="cx"> $_post = get_post($post_id);
</span><span class="cx">
</span><span class="cx"> $open = ( 'open' == $_post->ping_status );
</span><ins>+
+ /**
+ * Filter whether the current post is open for pings.
+ *
+ * @since 2.5.0
+ *
+ * @param bool $open Whether the current post is open for pings.
+ * @param int|WP_Post $post_id The post ID or WP_Post object.
+ */
</ins><span class="cx"> return apply_filters( 'pings_open', $open, $post_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2055,7 +2072,9 @@
</span><span class="cx"> $defaults = array(
</span><span class="cx"> 'fields' => $fields,
</span><span class="cx"> 'comment_field' => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" aria-required="true"></textarea></p>',
</span><ins>+ /** This filter is documented in wp-includes/link-template.php */
</ins><span class="cx"> 'must_log_in' => '<p class="must-log-in">' . sprintf( __( 'You must be <a href="%s">logged in</a> to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
</span><ins>+ /** This filter is documented in wp-includes/link-template.php */
</ins><span class="cx"> 'logged_in_as' => '<p class="logged-in-as">' . sprintf( __( 'Logged in as <a href="%1$s">%2$s</a>. <a href="%3$s" title="Log out of this account">Log out?</a>' ), get_edit_user_link(), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
</span><span class="cx"> 'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',
</span><span class="cx"> 'comment_notes_after' => '<p class="form-allowed-tags">' . sprintf( __( 'You may use these <abbr title="HyperText Markup Language">HTML</abbr> tags and attributes: %s' ), ' <code>' . allowed_tags() . '</code>' ) . '</p>',
</span></span></pre></div>
<a id="trunksrcwpincludesl10nphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/l10n.php (28082 => 28083)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/l10n.php 2014-04-11 23:24:32 UTC (rev 28082)
+++ trunk/src/wp-includes/l10n.php 2014-04-12 00:00:32 UTC (rev 28083)
</span><span class="lines">@@ -53,7 +53,7 @@
</span><span class="cx"> if ( empty( $locale ) )
</span><span class="cx"> $locale = 'en_US';
</span><span class="cx">
</span><del>- // duplicate_hook
</del><ins>+ /** This filter is documented in wp-includes/l10n.php */
</ins><span class="cx"> return apply_filters( 'locale', $locale );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -424,9 +424,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.9.0
</span><span class="cx"> *
</span><del>- * @param boolean Whether to override the text domain. Default false.
- * @param string $domain Text domain. Unique identifier for retrieving translated strings.
- * @param string $mofile Path to the MO file.
</del><ins>+ * @param bool $override Whether to override the text domain. Default false.
+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+ * @param string $mofile Path to the MO file.
</ins><span class="cx"> */
</span><span class="cx"> $plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
</span><span class="cx">
</span><span class="lines">@@ -479,12 +479,12 @@
</span><span class="cx"> global $l10n;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filter text text domain for loading translation.
</del><ins>+ * Filter the text domain for loading translation.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param boolean Whether to override unloading the text domain. Default false.
- * @param string $domain Text domain. Unique identifier for retrieving translated strings.
</del><ins>+ * @param bool $override Whether to override unloading the text domain. Default false.
+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.
</ins><span class="cx"> */
</span><span class="cx"> $plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
</span><span class="cx">
</span><span class="lines">@@ -591,7 +591,7 @@
</span><span class="cx"> * @return bool True when textdomain is successfully loaded, false otherwise.
</span><span class="cx"> */
</span><span class="cx"> function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
</span><del>- // duplicate_hook
</del><ins>+ /** This filter is documented in wp-includes/l10n.php */
</ins><span class="cx"> $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
</span><span class="cx"> $path = trailingslashit( WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ) );
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>