mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2025-10-16 12:05:38 +00:00
f034bc832e
- First pass at adding the site editor from the Gutenberg plugin to wp-admin/site-editor.php. - Adds miscellaneous PHP changes from Gutenberg 10.1 - 11.9. Follows [52042]. See #54337. Props youknowriad, aristath, hellofromtonya, gziolo. git-svn-id: https://develop.svn.wordpress.org/trunk@52069 602fd350-edb4-49c9-b593-d223f7449a82
313 lines
12 KiB
PHP
313 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* Block_Template_Utils_Test class
|
|
*
|
|
* @package WordPress
|
|
*/
|
|
|
|
/**
|
|
* Tests for the Block Templates abstraction layer.
|
|
*/
|
|
class Block_Template_Utils_Test extends WP_UnitTestCase {
|
|
private static $post;
|
|
private static $template_part_post;
|
|
|
|
public static function wpSetUpBeforeClass() {
|
|
// We may need a block theme.
|
|
// switch_theme( 'tt1-blocks' );
|
|
|
|
// Set up a template post corresponding to a different theme.
|
|
// We do this to ensure resolution and slug creation works as expected,
|
|
// even with another post of that same name present for another theme.
|
|
$args = array(
|
|
'post_type' => 'wp_template',
|
|
'post_name' => 'my_template',
|
|
'post_title' => 'My Template',
|
|
'post_content' => 'Content',
|
|
'post_excerpt' => 'Description of my template',
|
|
'tax_input' => array(
|
|
'wp_theme' => array(
|
|
'this-theme-should-not-resolve',
|
|
),
|
|
),
|
|
);
|
|
self::$post = self::factory()->post->create_and_get( $args );
|
|
wp_set_post_terms( self::$post->ID, 'this-theme-should-not-resolve', 'wp_theme' );
|
|
|
|
// Set up template post.
|
|
$args = array(
|
|
'post_type' => 'wp_template',
|
|
'post_name' => 'my_template',
|
|
'post_title' => 'My Template',
|
|
'post_content' => 'Content',
|
|
'post_excerpt' => 'Description of my template',
|
|
'tax_input' => array(
|
|
'wp_theme' => array(
|
|
get_stylesheet(),
|
|
),
|
|
),
|
|
);
|
|
self::$post = self::factory()->post->create_and_get( $args );
|
|
wp_set_post_terms( self::$post->ID, get_stylesheet(), 'wp_theme' );
|
|
|
|
// Set up template part post.
|
|
$template_part_args = array(
|
|
'post_type' => 'wp_template_part',
|
|
'post_name' => 'my_template_part',
|
|
'post_title' => 'My Template Part',
|
|
'post_content' => 'Content',
|
|
'post_excerpt' => 'Description of my template part',
|
|
'tax_input' => array(
|
|
'wp_theme' => array(
|
|
get_stylesheet(),
|
|
),
|
|
'wp_template_part_area' => array(
|
|
WP_TEMPLATE_PART_AREA_HEADER,
|
|
),
|
|
),
|
|
);
|
|
self::$template_part_post = self::factory()->post->create_and_get( $template_part_args );
|
|
wp_set_post_terms( self::$template_part_post->ID, WP_TEMPLATE_PART_AREA_HEADER, 'wp_template_part_area' );
|
|
wp_set_post_terms( self::$template_part_post->ID, get_stylesheet(), 'wp_theme' );
|
|
}
|
|
|
|
public static function wpTearDownAfterClass() {
|
|
wp_delete_post( self::$post->ID );
|
|
}
|
|
|
|
public function test_build_block_template_result_from_post() {
|
|
$template = _build_block_template_result_from_post(
|
|
self::$post,
|
|
'wp_template'
|
|
);
|
|
|
|
$this->assertNotWPError( $template );
|
|
$this->assertEquals( get_stylesheet() . '//my_template', $template->id );
|
|
$this->assertEquals( get_stylesheet(), $template->theme );
|
|
$this->assertEquals( 'my_template', $template->slug );
|
|
$this->assertEquals( 'publish', $template->status );
|
|
$this->assertEquals( 'custom', $template->source );
|
|
$this->assertEquals( 'My Template', $template->title );
|
|
$this->assertEquals( 'Description of my template', $template->description );
|
|
$this->assertEquals( 'wp_template', $template->type );
|
|
|
|
// Test template parts.
|
|
$template_part = _build_block_template_result_from_post(
|
|
self::$template_part_post,
|
|
'wp_template_part'
|
|
);
|
|
$this->assertNotWPError( $template_part );
|
|
$this->assertEquals( get_stylesheet() . '//my_template_part', $template_part->id );
|
|
$this->assertEquals( get_stylesheet(), $template_part->theme );
|
|
$this->assertEquals( 'my_template_part', $template_part->slug );
|
|
$this->assertEquals( 'publish', $template_part->status );
|
|
$this->assertEquals( 'custom', $template_part->source );
|
|
$this->assertEquals( 'My Template Part', $template_part->title );
|
|
$this->assertEquals( 'Description of my template part', $template_part->description );
|
|
$this->assertEquals( 'wp_template_part', $template_part->type );
|
|
$this->assertEquals( WP_TEMPLATE_PART_AREA_HEADER, $template_part->area );
|
|
}
|
|
|
|
function test_build_block_template_result_from_file() {
|
|
$template = _build_block_template_result_from_file(
|
|
array(
|
|
'slug' => 'single',
|
|
'path' => __DIR__ . '/../data/templates/template.html',
|
|
),
|
|
'wp_template'
|
|
);
|
|
|
|
$this->assertEquals( get_stylesheet() . '//single', $template->id );
|
|
$this->assertEquals( get_stylesheet(), $template->theme );
|
|
$this->assertEquals( 'single', $template->slug );
|
|
$this->assertEquals( 'publish', $template->status );
|
|
$this->assertEquals( 'theme', $template->source );
|
|
$this->assertEquals( 'Single Post', $template->title );
|
|
$this->assertEquals( 'Template used to display a single blog post.', $template->description );
|
|
$this->assertEquals( 'wp_template', $template->type );
|
|
|
|
// Test template parts.
|
|
$template_part = _build_block_template_result_from_file(
|
|
array(
|
|
'slug' => 'header',
|
|
'path' => __DIR__ . '/../data/templates/template.html',
|
|
'area' => WP_TEMPLATE_PART_AREA_HEADER,
|
|
),
|
|
'wp_template_part'
|
|
);
|
|
$this->assertEquals( get_stylesheet() . '//header', $template_part->id );
|
|
$this->assertEquals( get_stylesheet(), $template_part->theme );
|
|
$this->assertEquals( 'header', $template_part->slug );
|
|
$this->assertEquals( 'publish', $template_part->status );
|
|
$this->assertEquals( 'theme', $template_part->source );
|
|
$this->assertEquals( 'header', $template_part->title );
|
|
$this->assertEquals( '', $template_part->description );
|
|
$this->assertEquals( 'wp_template_part', $template_part->type );
|
|
$this->assertEquals( WP_TEMPLATE_PART_AREA_HEADER, $template_part->area );
|
|
}
|
|
|
|
function test_inject_theme_attribute_in_block_template_content() {
|
|
$theme = get_stylesheet();
|
|
$content_without_theme_attribute = '<!-- wp:template-part {"slug":"header","align":"full", "tagName":"header","className":"site-header"} /-->';
|
|
$template_content = _inject_theme_attribute_in_block_template_content(
|
|
$content_without_theme_attribute,
|
|
$theme
|
|
);
|
|
$expected = sprintf(
|
|
'<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->',
|
|
get_stylesheet()
|
|
);
|
|
$this->assertEquals( $expected, $template_content );
|
|
|
|
$content_without_theme_attribute_nested = '<!-- wp:group --><!-- wp:template-part {"slug":"header","align":"full", "tagName":"header","className":"site-header"} /--><!-- /wp:group -->';
|
|
$template_content = _inject_theme_attribute_in_block_template_content(
|
|
$content_without_theme_attribute_nested,
|
|
$theme
|
|
);
|
|
$expected = sprintf(
|
|
'<!-- wp:group --><!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /--><!-- /wp:group -->',
|
|
get_stylesheet()
|
|
);
|
|
$this->assertEquals( $expected, $template_content );
|
|
|
|
// Does not inject theme when there is an existing theme attribute.
|
|
$content_with_existing_theme_attribute = '<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full", "tagName":"header","className":"site-header"} /-->';
|
|
$template_content = _inject_theme_attribute_in_block_template_content(
|
|
$content_with_existing_theme_attribute,
|
|
$theme
|
|
);
|
|
$this->assertEquals( $content_with_existing_theme_attribute, $template_content );
|
|
|
|
// Does not inject theme when there is no template part.
|
|
$content_with_no_template_part = '<!-- wp:post-content /-->';
|
|
$template_content = _inject_theme_attribute_in_block_template_content(
|
|
$content_with_no_template_part,
|
|
$theme
|
|
);
|
|
$this->assertEquals( $content_with_no_template_part, $template_content );
|
|
}
|
|
|
|
/**
|
|
* Should retrieve the template from the theme files.
|
|
*/
|
|
function test_get_block_template_from_file() {
|
|
$this->markTestIncomplete();
|
|
// Requires switching to a block theme.
|
|
/* $id = get_stylesheet() . '//' . 'index';
|
|
$template = get_block_template( $id, 'wp_template' );
|
|
$this->assertEquals( $id, $template->id );
|
|
$this->assertEquals( get_stylesheet(), $template->theme );
|
|
$this->assertEquals( 'index', $template->slug );
|
|
$this->assertEquals( 'publish', $template->status );
|
|
$this->assertEquals( 'theme', $template->source );
|
|
$this->assertEquals( 'wp_template', $template->type );
|
|
|
|
// Test template parts.
|
|
$id = get_stylesheet() . '//' . 'header';
|
|
$template = get_block_template( $id, 'wp_template_part' );
|
|
$this->assertEquals( $id, $template->id );
|
|
$this->assertEquals( get_stylesheet(), $template->theme );
|
|
$this->assertEquals( 'header', $template->slug );
|
|
$this->assertEquals( 'publish', $template->status );
|
|
$this->assertEquals( 'theme', $template->source );
|
|
$this->assertEquals( 'wp_template_part', $template->type );
|
|
$this->assertEquals( WP_TEMPLATE_PART_AREA_HEADER, $template->area );
|
|
*/
|
|
}
|
|
|
|
/**
|
|
* Should retrieve the template from the CPT.
|
|
*/
|
|
public function test_get_block_template_from_post() {
|
|
$id = get_stylesheet() . '//' . 'my_template';
|
|
$template = get_block_template( $id, 'wp_template' );
|
|
$this->assertEquals( $id, $template->id );
|
|
$this->assertEquals( get_stylesheet(), $template->theme );
|
|
$this->assertEquals( 'my_template', $template->slug );
|
|
$this->assertEquals( 'publish', $template->status );
|
|
$this->assertEquals( 'custom', $template->source );
|
|
$this->assertEquals( 'wp_template', $template->type );
|
|
|
|
// Test template parts.
|
|
$id = get_stylesheet() . '//' . 'my_template_part';
|
|
$template = get_block_template( $id, 'wp_template_part' );
|
|
$this->assertEquals( $id, $template->id );
|
|
$this->assertEquals( get_stylesheet(), $template->theme );
|
|
$this->assertEquals( 'my_template_part', $template->slug );
|
|
$this->assertEquals( 'publish', $template->status );
|
|
$this->assertEquals( 'custom', $template->source );
|
|
$this->assertEquals( 'wp_template_part', $template->type );
|
|
$this->assertEquals( WP_TEMPLATE_PART_AREA_HEADER, $template->area );
|
|
}
|
|
|
|
/**
|
|
* Should retrieve block templates (file and CPT)
|
|
*/
|
|
public function test_get_block_templates() {
|
|
function get_template_ids( $templates ) {
|
|
return array_map(
|
|
static function( $template ) {
|
|
return $template->id;
|
|
},
|
|
$templates
|
|
);
|
|
}
|
|
|
|
// All results.
|
|
$templates = get_block_templates( array(), 'wp_template' );
|
|
$template_ids = get_template_ids( $templates );
|
|
|
|
// Avoid testing the entire array because the theme might add/remove templates.
|
|
$this->assertContains( get_stylesheet() . '//' . 'my_template', $template_ids );
|
|
|
|
// The result might change in a block theme.
|
|
// $this->assertContains( get_stylesheet() . '//' . 'index', $template_ids );
|
|
|
|
// Filter by slug.
|
|
$templates = get_block_templates( array( 'slug__in' => array( 'my_template' ) ), 'wp_template' );
|
|
$template_ids = get_template_ids( $templates );
|
|
$this->assertEquals( array( get_stylesheet() . '//' . 'my_template' ), $template_ids );
|
|
|
|
// Filter by CPT ID.
|
|
$templates = get_block_templates( array( 'wp_id' => self::$post->ID ), 'wp_template' );
|
|
$template_ids = get_template_ids( $templates );
|
|
$this->assertEquals( array( get_stylesheet() . '//' . 'my_template' ), $template_ids );
|
|
|
|
// Filter template part by area.
|
|
// Requires a block theme.
|
|
/*$templates = get_block_templates( array( 'area' => WP_TEMPLATE_PART_AREA_HEADER ), 'wp_template_part' );
|
|
$template_ids = get_template_ids( $templates );
|
|
$this->assertEquals(
|
|
array(
|
|
get_stylesheet() . '//' . 'my_template_part',
|
|
get_stylesheet() . '//' . 'header',
|
|
),
|
|
$template_ids
|
|
);
|
|
*/
|
|
}
|
|
|
|
/**
|
|
* Should flatten nested blocks
|
|
*/
|
|
function test_flatten_blocks() {
|
|
$content_template_part_inside_group = '<!-- wp:group --><!-- wp:template-part {"slug":"header"} /--><!-- /wp:group -->';
|
|
$blocks = parse_blocks( $content_template_part_inside_group );
|
|
$actual = _flatten_blocks( $blocks );
|
|
$expected = array( $blocks[0], $blocks[0]['innerBlocks'][0] );
|
|
$this->assertEquals( $expected, $actual );
|
|
|
|
$content_template_part_inside_group_inside_group = '<!-- wp:group --><!-- wp:group --><!-- wp:template-part {"slug":"header"} /--><!-- /wp:group --><!-- /wp:group -->';
|
|
$blocks = parse_blocks( $content_template_part_inside_group_inside_group );
|
|
$actual = _flatten_blocks( $blocks );
|
|
$expected = array( $blocks[0], $blocks[0]['innerBlocks'][0], $blocks[0]['innerBlocks'][0]['innerBlocks'][0] );
|
|
$this->assertEquals( $expected, $actual );
|
|
|
|
$content_without_inner_blocks = '<!-- wp:group /-->';
|
|
$blocks = parse_blocks( $content_without_inner_blocks );
|
|
$actual = _flatten_blocks( $blocks );
|
|
$expected = array( $blocks[0] );
|
|
$this->assertEquals( $expected, $actual );
|
|
}
|
|
}
|