<!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>[37541] trunk/src/wp-includes/general-template.php: Docs: Apply inline `@see` tags to hooks referenced in DocBlocks in wp-includes/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/37541">37541</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/37541","name":"Review Commit"}}</script></dd>

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

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-05-23 18:56:06 +0000 (Mon, 23 May 2016)</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'>Docs: Apply inline `@see` tags to hooks referenced in DocBlocks in wp-includes/general-template.php.

Applying these specially-crafted `@see` tags allows the Code Reference parser to recognize and link these elements as actions and filters.

See <a href="https://core.trac.wordpress.org/ticket/36921">#36921</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        2016-05-23 18:55:17 UTC (rev 37540)

+++ trunk/src/wp-includes/general-template.php  2016-05-23 18:56:06 UTC (rev 37541)

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

</span><span class="cx" style="display: block; padding: 0 10px">  * the parent, then load it. If it doesn't exist, then the default search form

<span class="cx" style="display: block; padding: 0 10px">  * will be displayed. The default search form is HTML, which will be displayed.

</span><span class="cx" style="display: block; padding: 0 10px">  * There is a filter applied to the search form HTML in order to edit or replace

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * it. The filter is 'get_search_form'.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * it. The filter is {@see 'get_search_form'}.

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

</span><span class="cx" style="display: block; padding: 0 10px">  * This function is primarily used by themes which want to hardcode the search

<span class="cx" style="display: block; padding: 0 10px">  * form into the sidebar and also by the search widget in WordPress.

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

</span><span class="cx" style="display: block; padding: 0 10px">  * There is also an action that is called whenever the function is run called,

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'pre_get_search_form'. This can be useful for outputting JavaScript that the

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the

</ins><span class="cx" style="display: block; padding: 0 10px">  * search relies on or various formatting that applies to the beginning of the

<span class="cx" style="display: block; padding: 0 10px">  * search. To give a few examples of what it can be used for.

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Theme container function for the 'wp_meta' action.

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

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The 'wp_meta' action can have several purposes, depending on how you use it,

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The {@see 'wp_meta'} action can have several purposes, depending on how you use it,

</ins><span class="cx" style="display: block; padding: 0 10px">  * but one purpose might have been to allow for theme switching.

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Retrieve the date on which the post was written.

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

<span class="cx" style="display: block; padding: 0 10px">  * Unlike the_date() this function will always return the date.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Modify output with 'get_the_date' filter.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Modify output with the {@see 'get_the_date'} filter.

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

</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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2515,8 +2515,10 @@

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

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

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fire the wp_head action.

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

<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * See {@see 'wp_head'}.

+ *

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

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

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

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

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

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

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fire the wp_footer action.

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

<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * See {@see 'wp_footer'}.

+ *

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

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

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

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

</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">- * Display a noindex meta tag if required by the blog configuration.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Displays a noindex meta tag if required by the blog configuration.

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

</span><span class="cx" style="display: block; padding: 0 10px">  * If a blog is marked as not being public then the noindex meta tag will be

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * output to tell web robots not to index the page content. Add this to the wp_head action.

- * Typical usage is as a wp_head callback. add_action( 'wp_head', 'noindex' );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * output to tell web robots not to index the page content. Add this to the

+ * {@see 'wp_head'} action.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Typical usage is as a {@see 'wp_head'} callback:

+ *

+ *     add_action( 'wp_head', 'noindex' );

+ *

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

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

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

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

</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">- * Display the URL of a WordPress admin CSS file.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Displays the URL of a WordPress admin CSS file.

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see WP_Styles::_css_href and its style_loader_src filter.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see WP_Styles::_css_href and its {@see 'style_loader_src'} filter.

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

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Enqueues or directly prints a stylesheet link to the specified CSS file.

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

</span><span class="cx" style="display: block; padding: 0 10px">  * "Intelligently" decides to enqueue or to print the CSS file. If the

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'wp_print_styles' action has *not* yet been called, the CSS file will be

- * enqueued. If the wp_print_styles action *has* been called, the CSS link will

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * {@see 'wp_print_styles'} action has *not* yet been called, the CSS file will be

+ * enqueued. If the {@see 'wp_print_styles'} action has been called, the CSS link will

</ins><span class="cx" style="display: block; padding: 0 10px">  * be printed. Printing may be forced by passing true as the $force_echo

<span class="cx" style="display: block; padding: 0 10px">  * (second) parameter.

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

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

</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">- * Display the XHTML generator that is generated on the wp_head hook.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Displays the XHTML generator that is generated on the wp_head hook.

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

<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * See {@see 'wp_head'}.

+ *

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

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Display the generator XML or Comment for RSS, ATOM, etc.

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

</span><span class="cx" style="display: block; padding: 0 10px">  * Returns the correct generator type for the requested output format. Allows

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * for a plugin to filter generators overall the the_generator filter.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * for a plugin to filter generators overall the {@see 'the_generator'} filter.

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

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

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

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

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

</span><span class="cx" style="display: block; padding: 0 10px">  * Returns the correct generator type for the requested output format. Allows

</span><span class="cx" style="display: block; padding: 0 10px">  * for a plugin to filter generators on an individual basis using the

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'get_the_generator_{$type}' filter.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * {@see 'get_the_generator_$type'} filter.

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

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

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

</span></span></pre>

</div>

</div>

</body>

</html>