<!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>[60139] Docs: Update inline docs for various general template functions.</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 { white-space: pre-line; 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/60139">60139</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/60139","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-04-08 01:59:10 +0000 (Tue, 08 Apr 2025)</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: Update inline docs for various general template functions.
Reviewed By peterwilsoncc, jorbin.
Merges <a href="https://core.trac.wordpress.org/changeset/60120">[60120]</a> and <a href="https://core.trac.wordpress.org/changeset/60121">[60121]</a> to the 6.8 branch.
Props dilipbheda, mukesh27, SergeyBiryukov, audrasjb.
Fixes <a href="https://core.trac.wordpress.org/ticket/63215">#63215</a>.
See <a href="https://core.trac.wordpress.org/ticket/63166">#63166</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches68srcwpincludesgeneraltemplatephp">branches/6.8/src/wp-includes/general-template.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches68">branches/6.8/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.8
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.8 2025-04-08 01:05:09 UTC (rev 60138)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.8 2025-04-08 01:59:10 UTC (rev 60139)
</ins><a id="branches68"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.8</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/6.7:59437
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:60098,60104,60113-60114,60123-60124,60128,60134,60136
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:60098,60104,60113-60114,60120-60121,60123-60124,60128,60134,60136
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches68srcwpincludesgeneraltemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.8/src/wp-includes/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.8/src/wp-includes/general-template.php 2025-04-08 01:05:09 UTC (rev 60138)
+++ branches/6.8/src/wp-includes/general-template.php 2025-04-08 01:59:10 UTC (rev 60139)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,9 +19,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 A return value was added.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 The `$args` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $name The name of the specialized header.
- * @param array $args Optional. Additional arguments passed to the header template.
- * Default empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|null $name The name of the specialized header. Default null.
+ * @param array $args Optional. Additional arguments passed to the header template.
+ * Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return void|false Void on success, false if the template does not exist.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_header( $name = null, $args = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -63,9 +63,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 A return value was added.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 The `$args` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $name The name of the specialized footer.
- * @param array $args Optional. Additional arguments passed to the footer template.
- * Default empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|null $name The name of the specialized footer. Default null.
+ * @param array $args Optional. Additional arguments passed to the footer template.
+ * Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return void|false Void on success, false if the template does not exist.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_footer( $name = null, $args = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,9 +107,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 A return value was added.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 The `$args` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $name The name of the specialized sidebar.
- * @param array $args Optional. Additional arguments passed to the sidebar template.
- * Default empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|null $name The name of the specialized sidebar. Default null.
+ * @param array $args Optional. Additional arguments passed to the sidebar template.
+ * Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return void|false Void on success, false if the template does not exist.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_sidebar( $name = null, $args = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,7 +159,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 The `$args` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $slug The slug name for the generic template.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|null $name Optional. The name of the specialized template.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|null $name Optional. The name of the specialized template. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Additional arguments passed to the template.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void|false Void on success, false if the template does not exist.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,8 +175,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 The `$args` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $slug The slug name for the generic template.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|null $name The name of the specialized template or null if
- * there is none.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|null $name The name of the specialized template
+ * or null if there is none.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Additional arguments passed to the template.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( "get_template_part_{$slug}", $slug, $name, $args );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,8 +196,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 The `$args` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $slug The slug name for the generic template.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $name The name of the specialized template or an empty
- * string if there is none.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $name The name of the specialized template
+ * or an empty string if there is none.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $templates Array of template files to search for, in order.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Additional arguments passed to the template.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1916,7 +1916,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format Optional. Can be 'link', 'option', 'html', or custom. Default 'html'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $before Optional. Content to prepend to the description. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $after Optional. Content to append to the description. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $selected Optional. Set to true if the current page is the selected archive page.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $selected Optional. Set to true if the current page is the selected archive page. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML link content for archive.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_archives_link( $url, $text, $format = 'html', $before = '', $after = '', $selected = false ) {
</span></span></pre>
</div>
</div>
</body>
</html>