<!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>[32598] trunk/src/wp-includes/general-template.php: Cleanup doc blocks in `general-template.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" 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/32598">32598</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/32598","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-25 17:17:23 +0000 (Mon, 25 May 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'>Cleanup doc blocks in `general-template.php`.

See <a href="https://core.trac.wordpress.org/ticket/32444">#32444</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludesgeneraltemplatephp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/general-template.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php        2015-05-25 16:34:38 UTC (rev 32597)

+++ trunk/src/wp-includes/general-template.php  2015-05-25 17:17:23 UTC (rev 32598)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -190,8 +190,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.7.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param boolean $echo Default to echo and not return the form.

- * @return string|null String when retrieving, null when displaying or if searchform.php exists.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $echo Default to echo and not return the form.

+ * @return string|void String when $echo is false.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function get_search_form( $echo = true ) {

</span><span class="cx" style="display: block; padding: 0 10px">        /**

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -268,8 +268,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 1.5.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string $redirect Optional path to redirect to on login/logout.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param boolean $echo Default to echo and not return the link.

- * @return string|null String when retrieving, null when displaying.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool   $echo     Default to echo and not return the link.

+ * @return string|void String when retrieving.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_loginout($redirect = '', $echo = true) {

</span><span class="cx" style="display: block; padding: 0 10px">        if ( ! is_user_logged_in() )

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -323,14 +323,12 @@

</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"> /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Returns the Log In URL.

- *

</del><span class="cx" style="display: block; padding: 0 10px">  * Returns the URL that allows the user to log in to the site.

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.7.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $redirect Path to redirect to on login.

- * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $redirect     Path to redirect to on login.

+ * @param bool   $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @return string A log in URL.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_login_url($redirect = '', $force_reauth = false) {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -356,8 +354,6 @@

</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"> /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Returns the user registration URL.

- *

</del><span class="cx" style="display: block; padding: 0 10px">  * Returns the URL that allows the user to register on the site.

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 3.6.0

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -382,7 +378,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 3.0.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param array $args Configuration options to modify the form output.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string|null String when retrieving, null when displaying.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string|void String when retrieving.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_login_form( $args = array() ) {

</span><span class="cx" style="display: block; padding: 0 10px">        $defaults = array(

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -477,8 +473,6 @@

</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"> /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Returns the Lost Password URL.

- *

</del><span class="cx" style="display: block; padding: 0 10px">  * Returns the URL that allows the user to retrieve the lost password

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.8.0

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -514,12 +508,11 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 1.5.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string $before Text to output before the link. Default `<li>`.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $after Text to output after the link. Default `</li>`.

- * @param boolean $echo Default to echo and not return the link.

- * @return string|null String when retrieving, null when displaying.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $after  Text to output after the link. Default `</li>`.

+ * @param bool   $echo   Default to echo and not return the link.

+ * @return string|void String when retrieving.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-

</del><span class="cx" style="display: block; padding: 0 10px">         if ( ! is_user_logged_in() ) {

</span><span class="cx" style="display: block; padding: 0 10px">                if ( get_option('users_can_register') )

</span><span class="cx" style="display: block; padding: 0 10px">                        $link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __('Register') . '</a>' . $after;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -600,12 +593,13 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 0.71

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $show Blog info to retrieve.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global string $wp_version

+ *

+ * @param string $show   Blog info to retrieve.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param string $filter How to filter what is retrieved.

<span class="cx" style="display: block; padding: 0 10px">  * @return string Mostly string values, might be empty.

</span><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function get_bloginfo( $show = '', $filter = 'raw' ) {

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-

</del><span class="cx" style="display: block; padding: 0 10px">         switch( $show ) {

</span><span class="cx" style="display: block; padding: 0 10px">                case 'home' : // DEPRECATED

</span><span class="cx" style="display: block; padding: 0 10px">                case 'siteurl' : // DEPRECATED

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -766,12 +760,16 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 1.0.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $sep Optional, default is '&raquo;'. How to separate the various items within the page title.

- * @param bool $display Optional, default is true. Whether to display or retrieve title.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Locale $wp_locale

+ * @global int       $page

+ * @global int       $paged

+ *

+ * @param string $sep         Optional, default is '&raquo;'. How to separate the various items within the page title.

+ * @param bool   $display     Optional, default is true. Whether to display or retrieve title.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param string $seplocation Optional. Direction to display title, 'right'.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string|null String on retrieve, null when displaying.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string|void String on retrieve.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_title($sep = '&raquo;', $display = true, $seplocation = '') {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_title( $sep = '&raquo;', $display = true, $seplocation = '' ) {

</ins><span class="cx" style="display: block; padding: 0 10px">         global $wp_locale, $page, $paged;

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">        $m = get_query_var('m');

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -916,11 +914,11 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 0.71

</span><span class="cx" style="display: block; padding: 0 10px">  *