<!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>[52317] trunk/src/wp-includes/block-template-utils.php: Docs: Miscellaneous Docblock corrections for `block-template-utils.php` file.</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/52317">52317</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/52317","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>2021-12-03 22:08:31 +0000 (Fri, 03 Dec 2021)</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: Miscellaneous Docblock corrections for `block-template-utils.php` file.

Follow-up to <a href="https://core.trac.wordpress.org/changeset/52275">[52275]</a>, <a href="https://core.trac.wordpress.org/changeset/52062">[52062]</a>.

See <a href="https://core.trac.wordpress.org/ticket/53399">#53399</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    2021-12-03 19:37:32 UTC (rev 52316)

+++ trunk/src/wp-includes/block-template-utils.php      2021-12-03 22:08:31 UTC (rev 52317)

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param array $default_areas An array of supported area objects.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param array $default_area_definitions An array of supported area objects.

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

</span><span class="cx" style="display: block; padding: 0 10px">        return apply_filters( 'default_wp_template_part_areas', $default_area_definitions );

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Checks whether the input 'area' is a supported value.

<span class="cx" style="display: block; padding: 0 10px">  * Returns the input if supported, otherwise returns the 'uncategorized' value.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param string $type Template part area name.

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Finds all nested template part file paths in a theme's directory.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param string $base_directory The theme's file path.

<span class="cx" style="display: block; padding: 0 10px">  * @return array $path_list A list of paths to all template part files.

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Retrieves the template file from the theme for a given slug.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $template_type wp_template or wp_template_part.

- * @param string $slug template slug.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $template_type 'wp_template' or 'wp_template_part'.

+ * @param string $slug          Template slug.

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

<span class="cx" style="display: block; padding: 0 10px">  * @return array|null Template.

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

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -284,12 +284,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">- * Retrieves the template files from  the theme.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the template files from the theme.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $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 class="cx" style="display: block; padding: 0 10px">  * @return array Template.

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Attempts to add custom template information to the template item.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param array $template_item Template to add information to (requires 'slug' field).

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

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array Template item.

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

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

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Attempts to add the template part's area information to the input template.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param array $template_info Template to add information to (requires 'type' and 'slug' fields).

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Template.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array Template info.

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

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

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

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

</span><span class="cx" style="display: block; padding: 0 10px">  * Returns an array containing the references of

<span class="cx" style="display: block; padding: 0 10px">  * the passed blocks and their inner blocks.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param array $blocks array of blocks.

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

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

</span><span class="cx" style="display: block; padding: 0 10px">  * Parses wp_template content and injects the current theme's

</span><span class="cx" style="display: block; padding: 0 10px">  * stylesheet as a theme attribute into each wp_template_part

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param string $template_content serialized wp_template content.

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

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Updated wp_template content.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Updated 'wp_template' content.

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

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

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Parses a block template and removes the theme attribute from each template part.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param string $template_content Serialized block template content.

<span class="cx" style="display: block; padding: 0 10px">  * @return string Updated block template content.

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

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

<span class="cx" style="display: block; padding: 0 10px">  * Build a unified template object based on a theme file.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param array $template_file Theme file.

<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 array $template_type 'wp_template' or 'wp_template_part'.

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

<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">@@ -535,8 +535,8 @@

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

<span class="cx" style="display: block; padding: 0 10px">  * Build a unified template object based a post Object.

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

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0

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

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

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

<span class="cx" style="display: block; padding: 0 10px">  * @param WP_Post $post Template post.

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

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

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

<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 array $template_type 'wp_template' or 'wp_template_part'.

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

<span class="cx" style="display: block; padding: 0 10px">  * @return array Templates.

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

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

</div>

</div>

</body>

</html>