<!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>[52631] trunk/src/wp-includes/block-template-utils.php: Docs: Docblock corrections for `get_block_file_template()`.</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/52631">52631</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/52631","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-01-24 15:26:56 +0000 (Mon, 24 Jan 2022)</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: Docblock corrections for `get_block_file_template()`.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/52324">[52324]</a>.
Props johnbillion, SergeyBiryukov, costdev.
Fixes <a href="https://core.trac.wordpress.org/ticket/54879">#54879</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplateutilsphp">trunk/src/wp-includes/block-template-utils.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocktemplateutilsphp"></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/block-template-utils.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-template-utils.php 2022-01-24 12:54:16 UTC (rev 52630)
+++ trunk/src/wp-includes/block-template-utils.php 2022-01-24 15:26:56 UTC (rev 52631)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -498,8 +498,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</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 array $template_file Theme file.
- * @param array $template_type 'wp_template' or 'wp_template_part'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $template_file Theme file.
+ * @param string $template_type 'wp_template' or 'wp_template_part'.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Block_Template Template.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -600,7 +600,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</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 array $query {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $query {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Optional. Arguments to retrieve templates.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $slug__in List of slugs to include.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -608,7 +608,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $area A 'wp_template_part_area' taxonomy value to filter by (for wp_template_part template type only).
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $post_type Post type to get the templates for.
</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 array $template_type 'wp_template' or 'wp_template_part'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $template_type 'wp_template' or 'wp_template_part'.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Templates.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -622,7 +622,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Block_Template[]|null $block_templates Return an array of block templates to short-circuit the default query,
</span><span class="cx" style="display: block; padding: 0 10px"> * or null to allow WP to run it's normal queries.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $query {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $query {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Optional. Arguments to retrieve templates.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $slug__in List of slugs to include.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -629,7 +629,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $wp_id Post ID of customized template.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $post_type Post type to get the templates for.
</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 array $template_type wp_template or wp_template_part.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $template_type wp_template or wp_template_part.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $templates = apply_filters( 'pre_get_block_templates', null, $query, $template_type );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $templates ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -725,13 +725,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Block_Template[] $query_result Array of found block templates.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $query {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $query {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Optional. Arguments to retrieve templates.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $slug__in List of slugs to include.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $wp_id Post ID of customized template.
</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 array $template_type wp_template or wp_template_part.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $template_type wp_template or wp_template_part.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'get_block_templates', $query_result, $query, $template_type );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -742,7 +742,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $id Template unique identifier (example: theme_slug//template_slug).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $template_type Optional. Template type: `'wp_template'` or '`wp_template_part'`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $template_type Optional. Template type: `'wp_template'` or '`wp_template_part'`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default `'wp_template'`.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Block_Template|null Template.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -758,7 +758,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Block_Template|null $block_template Return block template object to short-circuit the default query,
</span><span class="cx" style="display: block; padding: 0 10px"> * or null to allow WP to run its normal queries.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $id Template unique identifier (example: theme_slug//template_slug).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $template_type Template type: `'wp_template'` or '`wp_template_part'`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $template_type Template type: `'wp_template'` or '`wp_template_part'`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $block_template = apply_filters( 'pre_get_block_template', null, $id, $template_type );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $block_template ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -815,8 +815,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $id Template unique identifier (example: theme_slug//template_slug).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $template_type Optional. Template type: `'wp_template'` or '`wp_template_part'`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $template_type Optional. Template type: `'wp_template'` or '`wp_template_part'`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default `'wp_template'`.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Block_Template|null The found block template, or null if there isn't one.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_block_file_template( $id, $template_type = 'wp_template' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -824,13 +825,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Return a non-null value to bypass the WordPress queries.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Block_Template|null $block_template Return block template object to short-circuit the default query,
</span><span class="cx" style="display: block; padding: 0 10px"> * or null to allow WP to run its normal queries.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $id Template unique identifier (example: theme_slug//template_slug).
- * @param array $template_type Template type: `'wp_template'` or '`wp_template_part'`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $id Template unique identifier (example: theme_slug//template_slug).
+ * @param string $template_type Template type: `'wp_template'` or '`wp_template_part'`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $block_template = apply_filters( 'pre_get_block_file_template', null, $id, $template_type );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $block_template ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -839,19 +839,19 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $parts = explode( '//', $id, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( count( $parts ) < 2 ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This filter is documented at the end of this function */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/block-template-utils.php */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'get_block_file_template', null, $id, $template_type );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> list( $theme, $slug ) = $parts;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( wp_get_theme()->get_stylesheet() !== $theme ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This filter is documented at the end of this function */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/block-template-utils.php */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'get_block_file_template', null, $id, $template_type );
</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"> $template_file = _get_block_template_file( $template_type, $slug );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( null === $template_file ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This filter is documented at the end of this function */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/block-template-utils.php */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'get_block_file_template', null, $id, $template_type );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -862,9 +862,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</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 WP_Block_Template $block_template The found block template.
- * @param string $id Template unique identifier (example: theme_slug//template_slug).
- * @param array $template_type Template type: `'wp_template'` or '`wp_template_part'`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Block_Template|null $block_template The found block template, or null if there is none.
+ * @param string $id Template unique identifier (example: theme_slug//template_slug).
+ * @param string $template_type Template type: `'wp_template'` or '`wp_template_part'`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'get_block_file_template', $block_template, $id, $template_type );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>