<!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>[53927] trunk: Editor: Ensure `get_block_templates()` returns unique templates or template parts.</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/53927">53927</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/53927","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-08-23 14:50:56 +0000 (Tue, 23 Aug 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'>Editor: Ensure `get_block_templates()` returns unique templates or template parts.
The function was using the `array_column()` PHP function on an array of objects, which works as expected on PHP 7 or later, but not on PHP 5.6.
This resulted in customized templates being listed multiple times on the Templates and Template Parts screens, and being repeatedly added between lists when switching between the screens.
The issue is now resolved by replacing `array_column()` with the `wp_list_pluck()` WordPress core function, which provides consistent behavior beetween PHP versions.
Reference: [https://github.com/php/php-src/blob/PHP-7.0.0/UPGRADING#L626 PHP 7.0 Upgrade Notes: array_column()].
Props uofaberdeendarren, antonvlasenko, ironprogrammer, jonmackintosh, costdev, hellofromTonya, swissspidy, rudlinkon.
Fixes <a href="https://core.trac.wordpress.org/ticket/56271">#56271</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplateutilsphp">trunk/src/wp-includes/block-template-utils.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsblocksgetBlockTemplatesphp">trunk/tests/phpunit/tests/blocks/getBlockTemplates.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-08-23 13:55:32 UTC (rev 53926)
+++ trunk/src/wp-includes/block-template-utils.php 2022-08-23 14:50:56 UTC (rev 53927)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -696,7 +696,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $is_not_custom = false === array_search(
</span><span class="cx" style="display: block; padding: 0 10px"> wp_get_theme()->get_stylesheet() . '//' . $template_file['slug'],
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- array_column( $query_result, 'id' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_list_pluck( $query_result, 'id' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> true
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $fits_slug_query =
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksgetBlockTemplatesphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/blocks/getBlockTemplates.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/getBlockTemplates.php (rev 0)
+++ trunk/tests/phpunit/tests/blocks/getBlockTemplates.php 2022-08-23 14:50:56 UTC (rev 53927)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,116 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * @group block-templates
+ *
+ * @covers ::get_block_templates
+ */
+class Tests_Blocks_GetBlockTemplates extends WP_UnitTestCase {
+
+ const TEST_THEME = 'block-theme';
+
+ /**
+ * @var WP_Post
+ */
+ private static $template;
+
+ /**
+ * @var WP_Post
+ */
+ private static $template_part;
+
+ public static function set_up_before_class() {
+ parent::set_up_before_class();
+
+ /*
+ * This template has to have the same ID ("block-theme/index") as the template
+ * that is shipped with the "block-theme" theme. This is needed for testing purposes.
+ */
+ static::$template = self::factory()->post->create_and_get(
+ array(
+ 'post_type' => 'wp_template',
+ 'post_name' => 'index',
+ 'tax_input' => array(
+ 'wp_theme' => array(
+ static::TEST_THEME,
+ ),
+ ),
+ )
+ );
+
+ wp_set_post_terms( static::$template->ID, static::TEST_THEME, 'wp_theme' );
+
+ /*
+ * This template part has to have the same ID ("block-theme/small-header") as the template part
+ * that is shipped with the "block-theme" theme. This is needed for testing purposes.
+ */
+ self::$template_part = self::factory()->post->create_and_get(
+ array(
+ 'post_type' => 'wp_template_part',
+ 'post_name' => 'small-header',
+ 'tax_input' => array(
+ 'wp_theme' => array(
+ static::TEST_THEME,
+ ),
+ 'wp_template_part_area' => array(
+ WP_TEMPLATE_PART_AREA_HEADER,
+ ),
+ ),
+ )
+ );
+
+ wp_set_post_terms( self::$template_part->ID, WP_TEMPLATE_PART_AREA_HEADER, 'wp_template_part_area' );
+ wp_set_post_terms( self::$template_part->ID, static::TEST_THEME, 'wp_theme' );
+ }
+
+ public static function tear_down_after_class() {
+ wp_delete_post( static::$template->ID );
+ wp_delete_post( static::$template_part->ID );
+
+ parent::tear_down_after_class();
+ }
+
+ public function set_up() {
+ parent::set_up();
+ switch_theme( static::TEST_THEME );
+ }
+
+ /**
+ * @ticket 56271
+ *
+ * @dataProvider data_get_block_templates_returns_unique_entities
+ *
+ * @param string $template_type The template type.
+ * @param string $original_template_id ID (slug) of the default entity.
+ * @param string $error_message An error message to display if the test fails.
+ */
+ public function test_get_block_templates_returns_unique_entities( $template_type, $original_template_id, $error_message ) {
+ $original_template = _get_block_template_file( $template_type, $original_template_id );
+ $this->assertNotEmpty( $original_template, 'An original (non-duplicate) template must exist for this test to work correctly.' );
+
+ $block_templates = get_block_templates( array(), $template_type );
+ $this->assertNotEmpty( $block_templates, 'get_block_templates() must return a non-empty value.' );
+
+ $block_template_ids = wp_list_pluck( $block_templates, 'id' );
+ $this->assertSame( count( array_unique( $block_template_ids ) ), count( $block_template_ids ), $error_message );
+ }
+
+ /**
+ * Data provider for test_get_block_templates_returns_unique_entities().
+ *
+ * @return array
+ */
+ public function data_get_block_templates_returns_unique_entities() {
+ return array(
+ 'wp_template template type' => array(
+ 'template_type' => 'wp_template',
+ 'original_template_id' => 'index',
+ 'error_message' => 'get_block_templates() must return unique templates.',
+ ),
+ 'wp_template_part template type' => array(
+ 'template_type' => 'wp_template_part',
+ 'original_template_id' => 'small-header',
+ 'error_message' => 'get_block_templates() must return unique template parts.',
+ ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/blocks/getBlockTemplates.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>