mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-08-11 12:20:22 +00:00
REST API: Introduce Block Types endpoint.
This endpoint allows a user to retrieve the block type definition for all server-side registered block types. Props spacedmonkey, aduth, gziolo, ocean90, TimothyBlynJacobs. Fixes #47620. git-svn-id: https://develop.svn.wordpress.org/trunk@48173 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs
@@ -0,0 +1,481 @@
|
||||
<?php
|
||||
/**
|
||||
* WP_REST_Block_Types_Controller tests.
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage REST_API
|
||||
* @since 5.5.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Tests for WP_REST_Block_Types_Controller.
|
||||
*
|
||||
* @since 5.5.0
|
||||
*
|
||||
* @covers WP_REST_Block_Types_Controller
|
||||
*
|
||||
* @group restapi-blocks
|
||||
* @group restapi
|
||||
*/
|
||||
class REST_Block_Type_Controller_Test extends WP_Test_REST_Controller_Testcase {
|
||||
|
||||
/**
|
||||
* Admin user ID.
|
||||
*
|
||||
* @since 5.5.0
|
||||
*
|
||||
* @var int $subscriber_id
|
||||
*/
|
||||
protected static $admin_id;
|
||||
|
||||
/**
|
||||
* Subscriber user ID.
|
||||
*
|
||||
* @since 5.5.0
|
||||
*
|
||||
* @var int $subscriber_id
|
||||
*/
|
||||
protected static $subscriber_id;
|
||||
|
||||
/**
|
||||
* Create fake data before our tests run.
|
||||
*
|
||||
* @since 5.5.0
|
||||
*
|
||||
* @param WP_UnitTest_Factory $factory Helper that lets us create fake data.
|
||||
*/
|
||||
public static function wpSetUpBeforeClass( $factory ) {
|
||||
self::$admin_id = $factory->user->create(
|
||||
array(
|
||||
'role' => 'administrator',
|
||||
)
|
||||
);
|
||||
self::$subscriber_id = $factory->user->create(
|
||||
array(
|
||||
'role' => 'subscriber',
|
||||
)
|
||||
);
|
||||
|
||||
$name = 'fake/test';
|
||||
$settings = array(
|
||||
'icon' => 'text',
|
||||
);
|
||||
|
||||
register_block_type( $name, $settings );
|
||||
}
|
||||
|
||||
public static function wpTearDownAfterClass() {
|
||||
self::delete_user( self::$admin_id );
|
||||
self::delete_user( self::$subscriber_id );
|
||||
unregister_block_type( 'fake/test' );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_register_routes() {
|
||||
$routes = rest_get_server()->get_routes();
|
||||
$this->assertArrayHasKey( '/wp/v2/block-types', $routes );
|
||||
$this->assertCount( 1, $routes['/wp/v2/block-types'] );
|
||||
$this->assertArrayHasKey( '/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)', $routes );
|
||||
$this->assertCount( 1, $routes['/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)'] );
|
||||
$this->assertArrayHasKey( '/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)', $routes );
|
||||
$this->assertCount( 1, $routes['/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_context_param() {
|
||||
// Collection.
|
||||
$request = new WP_REST_Request( 'OPTIONS', '/wp/v2/block-types' );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$data = $response->get_data();
|
||||
$this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] );
|
||||
$this->assertEquals( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );
|
||||
// Single.
|
||||
$request = new WP_REST_Request( 'OPTIONS', '/wp/v2/block-types/fake/test' );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$data = $response->get_data();
|
||||
$this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] );
|
||||
$this->assertEquals( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_items() {
|
||||
$block_name = 'fake/test';
|
||||
wp_set_current_user( self::$admin_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/fake' );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$data = $response->get_data();
|
||||
$this->assertCount( 1, $data );
|
||||
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_name );
|
||||
$this->check_block_type_object( $block_type, $data[0], $data[0]['_links'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_item() {
|
||||
$block_name = 'fake/test';
|
||||
wp_set_current_user( self::$admin_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_name );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_name );
|
||||
$this->check_block_type_object( $block_type, $response->get_data(), $response->get_links() );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_item_with_styles() {
|
||||
$block_name = 'fake/styles';
|
||||
$block_styles = array(
|
||||
'name' => 'fancy-quote',
|
||||
'label' => 'Fancy Quote',
|
||||
'style_handle' => 'myguten-style',
|
||||
);
|
||||
register_block_type( $block_name );
|
||||
register_block_style( $block_name, $block_styles );
|
||||
wp_set_current_user( self::$admin_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_name );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$data = $response->get_data();
|
||||
$this->assertEqualSets( array( $block_styles ), $data['styles'] );
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_item_with_styles_merge() {
|
||||
$block_name = 'fake/styles2';
|
||||
$block_styles = array(
|
||||
'name' => 'fancy-quote',
|
||||
'label' => 'Fancy Quote',
|
||||
'style_handle' => 'myguten-style',
|
||||
);
|
||||
$settings = array(
|
||||
'styles' => array(
|
||||
array(
|
||||
'name' => 'blue-quote',
|
||||
'label' => 'Blue Quote',
|
||||
'style_handle' => 'myguten-style',
|
||||
),
|
||||
),
|
||||
);
|
||||
register_block_type( $block_name, $settings );
|
||||
register_block_style( $block_name, $block_styles );
|
||||
wp_set_current_user( self::$admin_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_name );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$data = $response->get_data();
|
||||
$expected = array(
|
||||
array(
|
||||
'name' => 'fancy-quote',
|
||||
'label' => 'Fancy Quote',
|
||||
'style_handle' => 'myguten-style',
|
||||
),
|
||||
array(
|
||||
'name' => 'blue-quote',
|
||||
'label' => 'Blue Quote',
|
||||
'style_handle' => 'myguten-style',
|
||||
),
|
||||
);
|
||||
$this->assertEqualSets( $expected, $data['styles'] );
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_block_invalid_name() {
|
||||
$block_type = 'fake/block';
|
||||
wp_set_current_user( self::$admin_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_type );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
|
||||
$this->assertErrorResponse( 'rest_block_type_invalid', $response, 404 );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_item_invalid() {
|
||||
$block_type = 'fake/invalid';
|
||||
$settings = array(
|
||||
'title' => true,
|
||||
'description' => true,
|
||||
'icon' => true,
|
||||
'attributes' => 'invalid_attributes',
|
||||
'provides_context' => 'invalid_provides_context',
|
||||
'uses_context' => 'invalid_uses_context',
|
||||
'category' => true,
|
||||
'editor_script' => true,
|
||||
'script' => true,
|
||||
'editor_style' => true,
|
||||
'style' => true,
|
||||
'keywords' => 'invalid_keywords',
|
||||
'example' => 'invalid_example',
|
||||
'parent' => 'invalid_parent',
|
||||
'supports' => 'invalid_supports',
|
||||
'styles' => 'invalid_styles',
|
||||
'render_callback' => 'invalid_callback',
|
||||
'textdomain' => true,
|
||||
);
|
||||
register_block_type( $block_type, $settings );
|
||||
wp_set_current_user( self::$admin_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_type );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$data = $response->get_data();
|
||||
$this->assertEquals( $block_type, $data['name'] );
|
||||
$this->assertEquals( '1', $data['title'] );
|
||||
$this->assertEquals( '1', $data['description'] );
|
||||
$this->assertEquals( null, $data['icon'] );
|
||||
$this->assertEquals( null, $data['editor_script'] );
|
||||
$this->assertEquals( null, $data['script'] );
|
||||
$this->assertEquals( null, $data['editor_style'] );
|
||||
$this->assertEquals( null, $data['style'] );
|
||||
$this->assertEqualSets( array(), $data['provides_context'] );
|
||||
$this->assertEqualSets( array(), $data['attributes'] );
|
||||
$this->assertEqualSets( array( 'invalid_uses_context' ), $data['uses_context'] );
|
||||
$this->assertEqualSets( array( 'invalid_keywords' ), $data['keywords'] );
|
||||
$this->assertEqualSets( array( 'invalid_parent' ), $data['parent'] );
|
||||
$this->assertEqualSets( array(), $data['supports'] );
|
||||
$this->assertEqualSets( array(), $data['styles'] );
|
||||
$this->assertEquals( null, $data['example'] );
|
||||
$this->assertEquals( null, $data['category'] );
|
||||
$this->assertEquals( null, $data['textdomain'] );
|
||||
$this->assertFalse( false, $data['is_dynamic'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_item_defaults() {
|
||||
$block_type = 'fake/false';
|
||||
$settings = array(
|
||||
'title' => false,
|
||||
'description' => false,
|
||||
'icon' => false,
|
||||
'attributes' => false,
|
||||
'provides_context' => false,
|
||||
'uses_context' => false,
|
||||
'category' => false,
|
||||
'editor_script' => false,
|
||||
'script' => false,
|
||||
'editor_style' => false,
|
||||
'style' => false,
|
||||
'keywords' => false,
|
||||
'parent' => false,
|
||||
'supports' => false,
|
||||
'styles' => false,
|
||||
'render_callback' => false,
|
||||
'textdomain' => false,
|
||||
'example' => false,
|
||||
);
|
||||
register_block_type( $block_type, $settings );
|
||||
wp_set_current_user( self::$admin_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_type );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$data = $response->get_data();
|
||||
$this->assertEquals( $block_type, $data['name'] );
|
||||
$this->assertEquals( '', $data['title'] );
|
||||
$this->assertEquals( '', $data['description'] );
|
||||
$this->assertEquals( null, $data['icon'] );
|
||||
$this->assertEquals( null, $data['editor_script'] );
|
||||
$this->assertEquals( null, $data['script'] );
|
||||
$this->assertEquals( null, $data['editor_style'] );
|
||||
$this->assertEquals( null, $data['style'] );
|
||||
$this->assertEqualSets( array(), $data['attributes'] );
|
||||
$this->assertEqualSets( array(), $data['provides_context'] );
|
||||
$this->assertEqualSets( array(), $data['uses_context'] );
|
||||
$this->assertEqualSets( array(), $data['keywords'] );
|
||||
$this->assertEqualSets( array(), $data['parent'] );
|
||||
$this->assertEqualSets( array(), $data['supports'] );
|
||||
$this->assertEqualSets( array(), $data['styles'] );
|
||||
$this->assertEquals( null, $data['example'] );
|
||||
$this->assertEquals( null, $data['category'] );
|
||||
$this->assertEquals( null, $data['example'] );
|
||||
$this->assertEquals( null, $data['textdomain'] );
|
||||
$this->assertFalse( false, $data['is_dynamic'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_item_schema() {
|
||||
wp_set_current_user( self::$admin_id );
|
||||
$request = new WP_REST_Request( 'OPTIONS', '/wp/v2/block-types' );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$data = $response->get_data();
|
||||
$properties = $data['schema']['properties'];
|
||||
$this->assertCount( 19, $properties );
|
||||
$this->assertArrayHasKey( 'title', $properties );
|
||||
$this->assertArrayHasKey( 'icon', $properties );
|
||||
$this->assertArrayHasKey( 'description', $properties );
|
||||
$this->assertArrayHasKey( 'keywords', $properties );
|
||||
$this->assertArrayHasKey( 'styles', $properties );
|
||||
$this->assertArrayHasKey( 'textdomain', $properties );
|
||||
$this->assertArrayHasKey( 'name', $properties );
|
||||
$this->assertArrayHasKey( 'attributes', $properties );
|
||||
$this->assertArrayHasKey( 'supports', $properties );
|
||||
$this->assertArrayHasKey( 'category', $properties );
|
||||
$this->assertArrayHasKey( 'is_dynamic', $properties );
|
||||
$this->assertArrayHasKey( 'editor_script', $properties );
|
||||
$this->assertArrayHasKey( 'script', $properties );
|
||||
$this->assertArrayHasKey( 'editor_style', $properties );
|
||||
$this->assertArrayHasKey( 'style', $properties );
|
||||
$this->assertArrayHasKey( 'parent', $properties );
|
||||
$this->assertArrayHasKey( 'example', $properties );
|
||||
$this->assertArrayHasKey( 'uses_context', $properties );
|
||||
$this->assertArrayHasKey( 'provides_context', $properties );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_items_wrong_permission() {
|
||||
wp_set_current_user( self::$subscriber_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types' );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$this->assertErrorResponse( 'rest_block_type_cannot_view', $response, 403 );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_item_wrong_permission() {
|
||||
wp_set_current_user( self::$subscriber_id );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/fake/test' );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$this->assertErrorResponse( 'rest_block_type_cannot_view', $response, 403 );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_items_no_permission() {
|
||||
wp_set_current_user( 0 );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types' );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$this->assertErrorResponse( 'rest_block_type_cannot_view', $response, 401 );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_get_item_no_permission() {
|
||||
wp_set_current_user( 0 );
|
||||
$request = new WP_REST_Request( 'GET', '/wp/v2/block-types/fake/test' );
|
||||
$response = rest_get_server()->dispatch( $request );
|
||||
$this->assertErrorResponse( 'rest_block_type_cannot_view', $response, 401 );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_prepare_item() {
|
||||
$registry = new WP_Block_Type_Registry;
|
||||
$settings = array(
|
||||
'icon' => 'text',
|
||||
'render_callback' => '__return_null',
|
||||
);
|
||||
$registry->register( 'fake/line', $settings );
|
||||
$block_type = $registry->get_registered( 'fake/line' );
|
||||
$endpoint = new WP_REST_Block_Types_Controller;
|
||||
$request = new WP_REST_Request;
|
||||
$request->set_param( 'context', 'edit' );
|
||||
$response = $endpoint->prepare_item_for_response( $block_type, $request );
|
||||
$this->check_block_type_object( $block_type, $response->get_data(), $response->get_links() );
|
||||
}
|
||||
|
||||
/**
|
||||
* @ticket 47620
|
||||
*/
|
||||
public function test_prepare_item_limit_fields() {
|
||||
$registry = new WP_Block_Type_Registry;
|
||||
$settings = array(
|
||||
'icon' => 'text',
|
||||
'render_callback' => '__return_null',
|
||||
);
|
||||
$registry->register( 'fake/line', $settings );
|
||||
$block_type = $registry->get_registered( 'fake/line' );
|
||||
$request = new WP_REST_Request;
|
||||
$endpoint = new WP_REST_Block_Types_Controller;
|
||||
$request->set_param( 'context', 'edit' );
|
||||
$request->set_param( '_fields', 'name' );
|
||||
$response = $endpoint->prepare_item_for_response( $block_type, $request );
|
||||
$this->assertEquals(
|
||||
array(
|
||||
'name',
|
||||
),
|
||||
array_keys( $response->get_data() )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Util check block type object against.
|
||||
*
|
||||
* @since 5.5.0
|
||||
*
|
||||
* @param WP_Block_Type $block_type Sample block type.
|
||||
* @param array $data Data to compare against.
|
||||
* @param array $links Links to compare again.
|
||||
*/
|
||||
protected function check_block_type_object( $block_type, $data, $links ) {
|
||||
// Test data.
|
||||
$this->assertEquals( $data['attributes'], $block_type->get_attributes() );
|
||||
$this->assertEquals( $data['is_dynamic'], $block_type->is_dynamic() );
|
||||
|
||||
$extra_fields = array(
|
||||
'name',
|
||||
'category',
|
||||
'editor_script',
|
||||
'script',
|
||||
'editor_style',
|
||||
'style',
|
||||
'title',
|
||||
'icon',
|
||||
'description',
|
||||
'keywords',
|
||||
'parent',
|
||||
'provides_context',
|
||||
'uses_context',
|
||||
'supports',
|
||||
'styles',
|
||||
'textdomain',
|
||||
'example',
|
||||
);
|
||||
|
||||
foreach ( $extra_fields as $extra_field ) {
|
||||
if ( isset( $block_type->$extra_field ) ) {
|
||||
$this->assertEquals( $data[ $extra_field ], $block_type->$extra_field );
|
||||
}
|
||||
}
|
||||
|
||||
// Test links.
|
||||
$this->assertEquals( rest_url( 'wp/v2/block-types' ), $links['collection'][0]['href'] );
|
||||
$this->assertEquals( rest_url( 'wp/v2/block-types/' . $block_type->name ), $links['self'][0]['href'] );
|
||||
if ( $block_type->is_dynamic() ) {
|
||||
$this->assertArrayHasKey( 'https://api.w.org/render-block', $links );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The test_create_item() method does not exist for block types.
|
||||
*/
|
||||
public function test_create_item() {}
|
||||
|
||||
/**
|
||||
* The test_update_item() method does not exist for block types.
|
||||
*/
|
||||
public function test_update_item() {}
|
||||
|
||||
/**
|
||||
* The test_delete_item() method does not exist for block types.
|
||||
*/
|
||||
public function test_delete_item() {}
|
||||
}
|
||||
@@ -121,6 +121,9 @@ class WP_Test_REST_Schema_Initialization extends WP_Test_REST_TestCase {
|
||||
'/wp/v2/comments/(?P<id>[\\d]+)',
|
||||
'/wp/v2/search',
|
||||
'/wp/v2/block-renderer/(?P<name>[a-z0-9-]+/[a-z0-9-]+)',
|
||||
'/wp/v2/block-types',
|
||||
'/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)',
|
||||
'/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)',
|
||||
'/wp/v2/settings',
|
||||
'/wp/v2/themes',
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user