123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416 |
- <?php
- /**
- * WP_Block Tests
- *
- * @package WordPress
- * @subpackage Blocks
- * @since 5.5.0
- */
- /**
- * Tests for WP_Block
- *
- * @since 5.5.0
- *
- * @group blocks
- */
- class WP_Block_Test extends WP_UnitTestCase {
- /**
- * Fake block type registry.
- *
- * @var WP_Block_Type_Registry
- */
- private $registry = null;
- /**
- * Set up each test method.
- */
- public function setUp() {
- parent::setUp();
- $this->registry = new WP_Block_Type_Registry();
- }
- /**
- * Tear down each test method.
- */
- public function tearDown() {
- $this->registry = null;
- parent::tearDown();
- }
- function filter_render_block( $content, $parsed_block ) {
- return 'Original: "' . $content . '", from block "' . $parsed_block['blockName'] . '"';
- }
- /**
- * @ticket 49927
- */
- function test_constructor_assigns_properties_from_parsed_block() {
- $this->registry->register( 'core/example', array() );
- $parsed_blocks = parse_blocks( '<!-- wp:example {"ok":true} -->a<!-- wp:example /-->b<!-- /wp:example -->' );
- $parsed_block = $parsed_blocks[0];
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame( $parsed_block, $block->parsed_block );
- $this->assertSame( $parsed_block['blockName'], $block->name );
- $this->assertSame( $parsed_block['attrs'], $block->attributes );
- $this->assertSame( $parsed_block['innerContent'], $block->inner_content );
- $this->assertSame( $parsed_block['innerHTML'], $block->inner_html );
- }
- /**
- * @ticket 49927
- */
- function test_constructor_assigns_block_type_from_registry() {
- $block_type_settings = array(
- 'attributes' => array(
- 'defaulted' => array(
- 'type' => 'number',
- 'default' => 10,
- ),
- ),
- );
- $this->registry->register( 'core/example', $block_type_settings );
- $parsed_block = array( 'blockName' => 'core/example' );
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertInstanceOf( WP_Block_Type::class, $block->block_type );
- $this->assertSame(
- $block_type_settings['attributes'],
- $block->block_type->attributes
- );
- }
- /**
- * @ticket 49927
- */
- function test_lazily_assigns_attributes_with_defaults() {
- $this->registry->register(
- 'core/example',
- array(
- 'attributes' => array(
- 'defaulted' => array(
- 'type' => 'number',
- 'default' => 10,
- ),
- ),
- )
- );
- $parsed_block = array(
- 'blockName' => 'core/example',
- 'attrs' => array(
- 'explicit' => 20,
- ),
- );
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame(
- array(
- 'explicit' => 20,
- 'defaulted' => 10,
- ),
- $block->attributes
- );
- }
- /**
- * @ticket 49927
- */
- function test_lazily_assigns_attributes_with_only_defaults() {
- $this->registry->register(
- 'core/example',
- array(
- 'attributes' => array(
- 'defaulted' => array(
- 'type' => 'number',
- 'default' => 10,
- ),
- ),
- )
- );
- $parsed_block = array(
- 'blockName' => 'core/example',
- 'attrs' => array(),
- );
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame( array( 'defaulted' => 10 ), $block->attributes );
- // Intentionally call a second time, to ensure property was assigned.
- $this->assertSame( array( 'defaulted' => 10 ), $block->attributes );
- }
- /**
- * @ticket 49927
- */
- function test_constructor_assigns_context_from_block_type() {
- $this->registry->register(
- 'core/example',
- array(
- 'uses_context' => array( 'requested' ),
- )
- );
- $parsed_block = array( 'blockName' => 'core/example' );
- $context = array(
- 'requested' => 'included',
- 'unrequested' => 'not included',
- );
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame( array( 'requested' => 'included' ), $block->context );
- }
- /**
- * @ticket 49927
- */
- function test_constructor_maps_inner_blocks() {
- $this->registry->register( 'core/example', array() );
- $parsed_blocks = parse_blocks( '<!-- wp:example {"ok":true} -->a<!-- wp:example /-->b<!-- /wp:example -->' );
- $parsed_block = $parsed_blocks[0];
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertCount( 1, $block->inner_blocks );
- $this->assertInstanceOf( WP_Block::class, $block->inner_blocks[0] );
- $this->assertSame( 'core/example', $block->inner_blocks[0]->name );
- }
- /**
- * @ticket 49927
- */
- function test_constructor_prepares_context_for_inner_blocks() {
- $this->registry->register(
- 'core/outer',
- array(
- 'attributes' => array(
- 'recordId' => array(
- 'type' => 'number',
- ),
- ),
- 'provides_context' => array(
- 'core/recordId' => 'recordId',
- ),
- )
- );
- $this->registry->register(
- 'core/inner',
- array(
- 'uses_context' => array( 'core/recordId' ),
- )
- );
- $parsed_blocks = parse_blocks( '<!-- wp:outer {"recordId":10} --><!-- wp:inner /--><!-- /wp:outer -->' );
- $parsed_block = $parsed_blocks[0];
- $context = array( 'unrequested' => 'not included' );
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertCount( 0, $block->context );
- $this->assertSame(
- array( 'core/recordId' => 10 ),
- $block->inner_blocks[0]->context
- );
- }
- /**
- * @ticket 49927
- */
- function test_constructor_assigns_merged_context() {
- $this->registry->register(
- 'core/example',
- array(
- 'attributes' => array(
- 'value' => array(
- 'type' => array( 'string', 'null' ),
- ),
- ),
- 'provides_context' => array(
- 'core/value' => 'value',
- ),
- 'uses_context' => array( 'core/value' ),
- )
- );
- $parsed_blocks = parse_blocks(
- '<!-- wp:example {"value":"merged"} -->' .
- '<!-- wp:example {"value":null} -->' .
- '<!-- wp:example /-->' .
- '<!-- /wp:example -->' .
- '<!-- /wp:example -->'
- );
- $parsed_block = $parsed_blocks[0];
- $context = array( 'core/value' => 'original' );
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame(
- array( 'core/value' => 'original' ),
- $block->context
- );
- $this->assertSame(
- array( 'core/value' => 'merged' ),
- $block->inner_blocks[0]->context
- );
- $this->assertSame(
- array( 'core/value' => null ),
- $block->inner_blocks[0]->inner_blocks[0]->context
- );
- }
- /**
- * @ticket 49927
- */
- function test_render_static_block_type_returns_own_content() {
- $this->registry->register( 'core/static', array() );
- $this->registry->register(
- 'core/dynamic',
- array(
- 'render_callback' => function() {
- return 'b';
- },
- )
- );
- $parsed_blocks = parse_blocks( '<!-- wp:static -->a<!-- wp:dynamic /-->c<!-- /wp:static -->' );
- $parsed_block = $parsed_blocks[0];
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame( 'abc', $block->render() );
- }
- /**
- * @ticket 49927
- */
- function test_render_passes_block_for_render_callback() {
- $this->registry->register(
- 'core/greeting',
- array(
- 'render_callback' => function( $attributes, $content, $block ) {
- return sprintf( 'Hello from %s', $block->name );
- },
- )
- );
- $parsed_blocks = parse_blocks( '<!-- wp:greeting /-->' );
- $parsed_block = $parsed_blocks[0];
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame( 'Hello from core/greeting', $block->render() );
- }
- /**
- * @ticket 49927
- */
- function test_render_applies_render_block_filter() {
- $this->registry->register( 'core/example', array() );
- add_filter( 'render_block', array( $this, 'filter_render_block' ), 10, 2 );
- $parsed_blocks = parse_blocks( '<!-- wp:example -->Static<!-- wp:example -->Inner<!-- /wp:example --><!-- /wp:example -->' );
- $parsed_block = $parsed_blocks[0];
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $rendered_content = $block->render();
- remove_filter( 'render_block', array( $this, 'filter_render_block' ) );
- $this->assertSame( 'Original: "StaticOriginal: "Inner", from block "core/example"", from block "core/example"', $rendered_content );
- }
- /**
- * @ticket 46187
- */
- function test_render_applies_dynamic_render_block_filter() {
- $this->registry->register( 'core/example', array() );
- add_filter( 'render_block_core/example', array( $this, 'filter_render_block' ), 10, 2 );
- $parsed_blocks = parse_blocks( '<!-- wp:example -->Static<!-- wp:example -->Inner<!-- /wp:example --><!-- /wp:example -->' );
- $parsed_block = $parsed_blocks[0];
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $rendered_content = $block->render();
- remove_filter( 'render_block_core/example', array( $this, 'filter_render_block' ) );
- $this->assertSame( 'Original: "StaticOriginal: "Inner", from block "core/example"", from block "core/example"', $rendered_content );
- }
- /**
- * @ticket 49927
- */
- function test_passes_attributes_to_render_callback() {
- $this->registry->register(
- 'core/greeting',
- array(
- 'attributes' => array(
- 'toWhom' => array(
- 'type' => 'string',
- ),
- 'punctuation' => array(
- 'type' => 'string',
- 'default' => '!',
- ),
- ),
- 'render_callback' => function( $block_attributes ) {
- return sprintf(
- 'Hello %s%s',
- $block_attributes['toWhom'],
- $block_attributes['punctuation']
- );
- },
- )
- );
- $parsed_blocks = parse_blocks( '<!-- wp:greeting {"toWhom":"world"} /-->' );
- $parsed_block = $parsed_blocks[0];
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame( 'Hello world!', $block->render() );
- }
- /**
- * @ticket 49927
- */
- function test_passes_content_to_render_callback() {
- $this->registry->register(
- 'core/outer',
- array(
- 'render_callback' => function( $block_attributes, $content ) {
- return $content;
- },
- )
- );
- $this->registry->register(
- 'core/inner',
- array(
- 'render_callback' => function() {
- return 'b';
- },
- )
- );
- $parsed_blocks = parse_blocks( '<!-- wp:outer -->a<!-- wp:inner /-->c<!-- /wp:outer -->' );
- $parsed_block = $parsed_blocks[0];
- $context = array();
- $block = new WP_Block( $parsed_block, $context, $this->registry );
- $this->assertSame( 'abc', $block->render() );
- }
- }
|