| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * REST API: WP_REST_Block_Types_Controller class 4 * 5 * @package WordPress 6 * @subpackage REST_API 7 * @since 5.5.0 8 */ 9 10 /** 11 * Core class used to access block types via the REST API. 12 * 13 * @since 5.5.0 14 * 15 * @see WP_REST_Controller 16 */ 17 class WP_REST_Block_Types_Controller extends WP_REST_Controller { 18 19 const NAME_PATTERN = '^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$'; 20 21 /** 22 * Instance of WP_Block_Type_Registry. 23 * 24 * @since 5.5.0 25 * @var WP_Block_Type_Registry 26 */ 27 protected $block_registry; 28 29 /** 30 * Instance of WP_Block_Styles_Registry. 31 * 32 * @since 5.5.0 33 * @var WP_Block_Styles_Registry 34 */ 35 protected $style_registry; 36 37 /** 38 * Constructor. 39 * 40 * @since 5.5.0 41 */ 42 public function __construct() { 43 $this->namespace = 'wp/v2'; 44 $this->rest_base = 'block-types'; 45 $this->block_registry = WP_Block_Type_Registry::get_instance(); 46 $this->style_registry = WP_Block_Styles_Registry::get_instance(); 47 } 48 49 /** 50 * Registers the routes for block types. 51 * 52 * @since 5.5.0 53 * 54 * @see register_rest_route() 55 */ 56 public function register_routes() { 57 58 register_rest_route( 59 $this->namespace, 60 '/' . $this->rest_base, 61 array( 62 array( 63 'methods' => WP_REST_Server::READABLE, 64 'callback' => array( $this, 'get_items' ), 65 'permission_callback' => array( $this, 'get_items_permissions_check' ), 66 'args' => $this->get_collection_params(), 67 ), 68 'schema' => array( $this, 'get_public_item_schema' ), 69 ) 70 ); 71 72 register_rest_route( 73 $this->namespace, 74 '/' . $this->rest_base . '/(?P<namespace>[a-zA-Z0-9_-]+)', 75 array( 76 array( 77 'methods' => WP_REST_Server::READABLE, 78 'callback' => array( $this, 'get_items' ), 79 'permission_callback' => array( $this, 'get_items_permissions_check' ), 80 'args' => $this->get_collection_params(), 81 ), 82 'schema' => array( $this, 'get_public_item_schema' ), 83 ) 84 ); 85 86 register_rest_route( 87 $this->namespace, 88 '/' . $this->rest_base . '/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)', 89 array( 90 'args' => array( 91 'name' => array( 92 'description' => __( 'Block name.' ), 93 'type' => 'string', 94 ), 95 'namespace' => array( 96 'description' => __( 'Block namespace.' ), 97 'type' => 'string', 98 ), 99 ), 100 array( 101 'methods' => WP_REST_Server::READABLE, 102 'callback' => array( $this, 'get_item' ), 103 'permission_callback' => array( $this, 'get_item_permissions_check' ), 104 'args' => array( 105 'context' => $this->get_context_param( array( 'default' => 'view' ) ), 106 ), 107 ), 108 'schema' => array( $this, 'get_public_item_schema' ), 109 ) 110 ); 111 } 112 113 /** 114 * Checks whether a given request has permission to read post block types. 115 * 116 * @since 5.5.0 117 * 118 * @param WP_REST_Request $request Full details about the request. 119 * @return true|WP_Error True if the request has read access, WP_Error object otherwise. 120 */ 121 public function get_items_permissions_check( $request ) { 122 return $this->check_read_permission(); 123 } 124 125 /** 126 * Retrieves all post block types, depending on user context. 127 * 128 * @since 5.5.0 129 * 130 * @param WP_REST_Request $request Full details about the request. 131 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. 132 */ 133 public function get_items( $request ) { 134 if ( $request->is_method( 'HEAD' ) ) { 135 // Return early as this handler doesn't add any response headers. 136 return new WP_REST_Response( array() ); 137 } 138 139 $data = array(); 140 $block_types = $this->block_registry->get_all_registered(); 141 142 // Retrieve the list of registered collection query parameters. 143 $registered = $this->get_collection_params(); 144 $namespace = ''; 145 if ( isset( $registered['namespace'] ) && ! empty( $request['namespace'] ) ) { 146 $namespace = $request['namespace']; 147 } 148 149 foreach ( $block_types as $obj ) { 150 if ( $namespace ) { 151 list ( $block_namespace ) = explode( '/', $obj->name ); 152 153 if ( $namespace !== $block_namespace ) { 154 continue; 155 } 156 } 157 $block_type = $this->prepare_item_for_response( $obj, $request ); 158 $data[] = $this->prepare_response_for_collection( $block_type ); 159 } 160 161 return rest_ensure_response( $data ); 162 } 163 164 /** 165 * Checks if a given request has access to read a block type. 166 * 167 * @since 5.5.0 168 * 169 * @param WP_REST_Request $request Full details about the request. 170 * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise. 171 */ 172 public function get_item_permissions_check( $request ) { 173 $check = $this->check_read_permission(); 174 if ( is_wp_error( $check ) ) { 175 return $check; 176 } 177 $block_name = sprintf( '%s/%s', $request['namespace'], $request['name'] ); 178 $block_type = $this->get_block( $block_name ); 179 if ( is_wp_error( $block_type ) ) { 180 return $block_type; 181 } 182 183 return true; 184 } 185 186 /** 187 * Checks whether a given block type should be visible. 188 * 189 * @since 5.5.0 190 * 191 * @return true|WP_Error True if the block type is visible, WP_Error otherwise. 192 */ 193 protected function check_read_permission() { 194 if ( current_user_can( 'edit_posts' ) ) { 195 return true; 196 } 197 foreach ( get_post_types( array( 'show_in_rest' => true ), 'objects' ) as $post_type ) { 198 if ( current_user_can( $post_type->cap->edit_posts ) ) { 199 return true; 200 } 201 } 202 203 return new WP_Error( 'rest_block_type_cannot_view', __( 'Sorry, you are not allowed to manage block types.' ), array( 'status' => rest_authorization_required_code() ) ); 204 } 205 206 /** 207 * Get the block, if the name is valid. 208 * 209 * @since 5.5.0 210 * 211 * @param string $name Block name. 212 * @return WP_Block_Type|WP_Error Block type object if name is valid, WP_Error otherwise. 213 */ 214 protected function get_block( $name ) { 215 $block_type = $this->block_registry->get_registered( $name ); 216 if ( empty( $block_type ) ) { 217 return new WP_Error( 'rest_block_type_invalid', __( 'Invalid block type.' ), array( 'status' => 404 ) ); 218 } 219 220 return $block_type; 221 } 222 223 /** 224 * Retrieves a specific block type. 225 * 226 * @since 5.5.0 227 * 228 * @param WP_REST_Request $request Full details about the request. 229 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. 230 */ 231 public function get_item( $request ) { 232 $block_name = sprintf( '%s/%s', $request['namespace'], $request['name'] ); 233 $block_type = $this->get_block( $block_name ); 234 if ( is_wp_error( $block_type ) ) { 235 return $block_type; 236 } 237 $data = $this->prepare_item_for_response( $block_type, $request ); 238 239 return rest_ensure_response( $data ); 240 } 241 242 /** 243 * Prepares a block type object for serialization. 244 * 245 * @since 5.5.0 246 * @since 5.9.0 Renamed `$block_type` to `$item` to match parent class for PHP 8 named parameter support. 247 * @since 6.3.0 Added `selectors` field. 248 * @since 6.5.0 Added `view_script_module_ids` field. 249 * 250 * @param WP_Block_Type $item Block type data. 251 * @param WP_REST_Request $request Full details about the request. 252 * @return WP_REST_Response Block type data. 253 */ 254 public function prepare_item_for_response( $item, $request ) { 255 // Restores the more descriptive, specific name for use within this method. 256 $block_type = $item; 257 258 // Don't prepare the response body for HEAD requests. 259 if ( $request->is_method( 'HEAD' ) ) { 260 /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php */ 261 return apply_filters( 'rest_prepare_block_type', new WP_REST_Response( array() ), $block_type, $request ); 262 } 263 264 $fields = $this->get_fields_for_response( $request ); 265 $data = array(); 266 267 if ( rest_is_field_included( 'attributes', $fields ) ) { 268 $data['attributes'] = $block_type->get_attributes(); 269 } 270 271 if ( rest_is_field_included( 'is_dynamic', $fields ) ) { 272 $data['is_dynamic'] = $block_type->is_dynamic(); 273 } 274 275 $schema = $this->get_item_schema(); 276 // Fields deprecated in WordPress 6.1, but left in the schema for backwards compatibility. 277 $deprecated_fields = array( 278 'editor_script', 279 'script', 280 'view_script', 281 'editor_style', 282 'style', 283 ); 284 $extra_fields = array_merge( 285 array( 286 'api_version', 287 'name', 288 'title', 289 'description', 290 'icon', 291 'category', 292 'keywords', 293 'parent', 294 'ancestor', 295 'allowed_blocks', 296 'provides_context', 297 'uses_context', 298 'selectors', 299 'supports', 300 'styles', 301 'textdomain', 302 'example', 303 'editor_script_handles', 304 'script_handles', 305 'view_script_handles', 306 'view_script_module_ids', 307 'editor_style_handles', 308 'style_handles', 309 'view_style_handles', 310 'variations', 311 'block_hooks', 312 ), 313 $deprecated_fields 314 ); 315 foreach ( $extra_fields as $extra_field ) { 316 if ( rest_is_field_included( $extra_field, $fields ) ) { 317 if ( isset( $block_type->$extra_field ) ) { 318 $field = $block_type->$extra_field; 319 if ( in_array( $extra_field, $deprecated_fields, true ) && is_array( $field ) ) { 320 // Since the schema only allows strings or null (but no arrays), we return the first array item. 321 $field = ! empty( $field ) ? array_shift( $field ) : ''; 322 } 323 } elseif ( array_key_exists( 'default', $schema['properties'][ $extra_field ] ) ) { 324 $field = $schema['properties'][ $extra_field ]['default']; 325 } else { 326 $field = ''; 327 } 328 $data[ $extra_field ] = rest_sanitize_value_from_schema( $field, $schema['properties'][ $extra_field ] ); 329 } 330 } 331 332 if ( rest_is_field_included( 'styles', $fields ) ) { 333 $styles = $this->style_registry->get_registered_styles_for_block( $block_type->name ); 334 $styles = array_values( $styles ); 335 $data['styles'] = wp_parse_args( $styles, $data['styles'] ); 336 $data['styles'] = array_filter( $data['styles'] ); 337 } 338 339 $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; 340 $data = $this->add_additional_fields_to_object( $data, $request ); 341 $data = $this->filter_response_by_context( $data, $context ); 342 343 $response = rest_ensure_response( $data ); 344 345 if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) { 346 $response->add_links( $this->prepare_links( $block_type ) ); 347 } 348 349 /** 350 * Filters a block type returned from the REST API. 351 * 352 * Allows modification of the block type data right before it is returned. 353 * 354 * @since 5.5.0 355 * 356 * @param WP_REST_Response $response The response object. 357 * @param WP_Block_Type $block_type The original block type object. 358 * @param WP_REST_Request $request Request used to generate the response. 359 */ 360 return apply_filters( 'rest_prepare_block_type', $response, $block_type, $request ); 361 } 362 363 /** 364 * Prepares links for the request. 365 * 366 * @since 5.5.0 367 * 368 * @param WP_Block_Type $block_type Block type data. 369 * @return array Links for the given block type. 370 */ 371 protected function prepare_links( $block_type ) { 372 list( $namespace ) = explode( '/', $block_type->name ); 373 374 $links = array( 375 'collection' => array( 376 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), 377 ), 378 'self' => array( 379 'href' => rest_url( sprintf( '%s/%s/%s', $this->namespace, $this->rest_base, $block_type->name ) ), 380 ), 381 'up' => array( 382 'href' => rest_url( sprintf( '%s/%s/%s', $this->namespace, $this->rest_base, $namespace ) ), 383 ), 384 ); 385 386 if ( $block_type->is_dynamic() ) { 387 $links['https://api.w.org/render-block'] = array( 388 'href' => add_query_arg( 389 'context', 390 'edit', 391 rest_url( sprintf( '%s/%s/%s', 'wp/v2', 'block-renderer', $block_type->name ) ) 392 ), 393 ); 394 } 395 396 return $links; 397 } 398 399 /** 400 * Retrieves the block type' schema, conforming to JSON Schema. 401 * 402 * @since 5.5.0 403 * @since 6.3.0 Added `selectors` field. 404 * 405 * @return array Item schema data. 406 */ 407 public function get_item_schema() { 408 if ( $this->schema ) { 409 return $this->add_additional_fields_schema( $this->schema ); 410 } 411 412 // rest_validate_value_from_schema doesn't understand $refs, pull out reused definitions for readability. 413 $inner_blocks_definition = array( 414 'description' => __( 'The list of inner blocks used in the example.' ), 415 'type' => 'array', 416 'items' => array( 417 'type' => 'object', 418 'properties' => array( 419 'name' => array( 420 'description' => __( 'The name of the inner block.' ), 421 'type' => 'string', 422 'pattern' => self::NAME_PATTERN, 423 'required' => true, 424 ), 425 'attributes' => array( 426 'description' => __( 'The attributes of the inner block.' ), 427 'type' => 'object', 428 ), 429 'innerBlocks' => array( 430 'description' => __( "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema." ), 431 'type' => 'array', 432 ), 433 ), 434 ), 435 ); 436 437 $example_definition = array( 438 'description' => __( 'Block example.' ), 439 'type' => array( 'object', 'null' ), 440 'default' => null, 441 'properties' => array( 442 'attributes' => array( 443 'description' => __( 'The attributes used in the example.' ), 444 'type' => 'object', 445 ), 446 'innerBlocks' => $inner_blocks_definition, 447 ), 448 'context' => array( 'embed', 'view', 'edit' ), 449 'readonly' => true, 450 ); 451 452 $keywords_definition = array( 453 'description' => __( 'Block keywords.' ), 454 'type' => 'array', 455 'items' => array( 456 'type' => 'string', 457 ), 458 'default' => array(), 459 'context' => array( 'embed', 'view', 'edit' ), 460 'readonly' => true, 461 ); 462 463 $icon_definition = array( 464 'description' => __( 'Icon of block type.' ), 465 'type' => array( 'string', 'null' ), 466 'default' => null, 467 'context' => array( 'embed', 'view', 'edit' ), 468 'readonly' => true, 469 ); 470 471 $category_definition = array( 472 'description' => __( 'Block category.' ), 473 'type' => array( 'string', 'null' ), 474 'default' => null, 475 'context' => array( 'embed', 'view', 'edit' ), 476 'readonly' => true, 477 ); 478 479 $this->schema = array( 480 '$schema' => 'http://json-schema.org/draft-04/schema#', 481 'title' => 'block-type', 482 'type' => 'object', 483 'properties' => array( 484 'api_version' => array( 485 'description' => __( 'Version of block API.' ), 486 'type' => 'integer', 487 'default' => 1, 488 'context' => array( 'embed', 'view', 'edit' ), 489 'readonly' => true, 490 ), 491 'title' => array( 492 'description' => __( 'Title of block type.' ), 493 'type' => 'string', 494 'default' => '', 495 'context' => array( 'embed', 'view', 'edit' ), 496 'readonly' => true, 497 ), 498 'name' => array( 499 'description' => __( 'Unique name identifying the block type.' ), 500 'type' => 'string', 501 'pattern' => self::NAME_PATTERN, 502 'required' => true, 503 'context' => array( 'embed', 'view', 'edit' ), 504 'readonly' => true, 505 ), 506 'description' => array( 507 'description' => __( 'Description of block type.' ), 508 'type' => 'string', 509 'default' => '', 510 'context' => array( 'embed', 'view', 'edit' ), 511 'readonly' => true, 512 ), 513 'icon' => $icon_definition, 514 'attributes' => array( 515 'description' => __( 'Block attributes.' ), 516 'type' => array( 'object', 'null' ), 517 'properties' => array(), 518 'default' => null, 519 'additionalProperties' => array( 520 'type' => 'object', 521 ), 522 'context' => array( 'embed', 'view', 'edit' ), 523 'readonly' => true, 524 ), 525 'provides_context' => array( 526 'description' => __( 'Context provided by blocks of this type.' ), 527 'type' => 'object', 528 'properties' => array(), 529 'additionalProperties' => array( 530 'type' => 'string', 531 ), 532 'default' => array(), 533 'context' => array( 'embed', 'view', 'edit' ), 534 'readonly' => true, 535 ), 536 'uses_context' => array( 537 'description' => __( 'Context values inherited by blocks of this type.' ), 538 'type' => 'array', 539 'default' => array(), 540 'items' => array( 541 'type' => 'string', 542 ), 543 'context' => array( 'embed', 'view', 'edit' ), 544 'readonly' => true, 545 ), 546 'selectors' => array( 547 'description' => __( 'Custom CSS selectors.' ), 548 'type' => 'object', 549 'default' => array(), 550 'properties' => array(), 551 'context' => array( 'embed', 'view', 'edit' ), 552 'readonly' => true, 553 ), 554 'supports' => array( 555 'description' => __( 'Block supports.' ), 556 'type' => 'object', 557 'default' => array(), 558 'properties' => array(), 559 'context' => array( 'embed', 'view', 'edit' ), 560 'readonly' => true, 561 ), 562 'category' => $category_definition, 563 'is_dynamic' => array( 564 'description' => __( 'Is the block dynamically rendered.' ), 565 'type' => 'boolean', 566 'default' => false, 567 'context' => array( 'embed', 'view', 'edit' ), 568 'readonly' => true, 569 ), 570 'editor_script_handles' => array( 571 'description' => __( 'Editor script handles.' ), 572 'type' => array( 'array' ), 573 'default' => array(), 574 'items' => array( 575 'type' => 'string', 576 ), 577 'context' => array( 'embed', 'view', 'edit' ), 578 'readonly' => true, 579 ), 580 'script_handles' => array( 581 'description' => __( 'Public facing and editor script handles.' ), 582 'type' => array( 'array' ), 583 'default' => array(), 584 'items' => array( 585 'type' => 'string', 586 ), 587 'context' => array( 'embed', 'view', 'edit' ), 588 'readonly' => true, 589 ), 590 'view_script_handles' => array( 591 'description' => __( 'Public facing script handles.' ), 592 'type' => array( 'array' ), 593 'default' => array(), 594 'items' => array( 595 'type' => 'string', 596 ), 597 'context' => array( 'embed', 'view', 'edit' ), 598 'readonly' => true, 599 ), 600 'view_script_module_ids' => array( 601 'description' => __( 'Public facing script module IDs.' ), 602 'type' => array( 'array' ), 603 'default' => array(), 604 'items' => array( 605 'type' => 'string', 606 ), 607 'context' => array( 'embed', 'view', 'edit' ), 608 'readonly' => true, 609 ), 610 'editor_style_handles' => array( 611 'description' => __( 'Editor style handles.' ), 612 'type' => array( 'array' ), 613 'default' => array(), 614 'items' => array( 615 'type' => 'string', 616 ), 617 'context' => array( 'embed', 'view', 'edit' ), 618 'readonly' => true, 619 ), 620 'style_handles' => array( 621 'description' => __( 'Public facing and editor style handles.' ), 622 'type' => array( 'array' ), 623 'default' => array(), 624 'items' => array( 625 'type' => 'string', 626 ), 627 'context' => array( 'embed', 'view', 'edit' ), 628 'readonly' => true, 629 ), 630 'view_style_handles' => array( 631 'description' => __( 'Public facing style handles.' ), 632 'type' => array( 'array' ), 633 'default' => array(), 634 'items' => array( 635 'type' => 'string', 636 ), 637 'context' => array( 'embed', 'view', 'edit' ), 638 'readonly' => true, 639 ), 640 'styles' => array( 641 'description' => __( 'Block style variations.' ), 642 'type' => 'array', 643 'items' => array( 644 'type' => 'object', 645 'properties' => array( 646 'name' => array( 647 'description' => __( 'Unique name identifying the style.' ), 648 'type' => 'string', 649 'required' => true, 650 ), 651 'label' => array( 652 'description' => __( 'The human-readable label for the style.' ), 653 'type' => 'string', 654 ), 655 'inline_style' => array( 656 'description' => __( 'Inline CSS code that registers the CSS class required for the style.' ), 657 'type' => 'string', 658 ), 659 'style_handle' => array( 660 'description' => __( 'Contains the handle that defines the block style.' ), 661 'type' => 'string', 662 ), 663 ), 664 ), 665 'default' => array(), 666 'context' => array( 'embed', 'view', 'edit' ), 667 'readonly' => true, 668 ), 669 'variations' => array( 670 'description' => __( 'Block variations.' ), 671 'type' => 'array', 672 'items' => array( 673 'type' => 'object', 674 'properties' => array( 675 'name' => array( 676 'description' => __( 'The unique and machine-readable name.' ), 677 'type' => 'string', 678 'required' => true, 679 ), 680 'title' => array( 681 'description' => __( 'A human-readable variation title.' ), 682 'type' => 'string', 683 'required' => true, 684 ), 685 'description' => array( 686 'description' => __( 'A detailed variation description.' ), 687 'type' => 'string', 688 'required' => false, 689 ), 690 'category' => $category_definition, 691 'icon' => $icon_definition, 692 'isDefault' => array( 693 'description' => __( 'Indicates whether the current variation is the default one.' ), 694 'type' => 'boolean', 695 'required' => false, 696 'default' => false, 697 ), 698 'attributes' => array( 699 'description' => __( 'The initial values for attributes.' ), 700 'type' => 'object', 701 ), 702 'innerBlocks' => $inner_blocks_definition, 703 'example' => $example_definition, 704 'scope' => array( 705 'description' => __( 'The list of scopes where the variation is applicable. When not provided, it assumes all available scopes.' ), 706 'type' => array( 'array', 'null' ), 707 'default' => null, 708 'items' => array( 709 'type' => 'string', 710 'enum' => array( 'block', 'inserter', 'transform' ), 711 ), 712 'readonly' => true, 713 ), 714 'keywords' => $keywords_definition, 715 ), 716 ), 717 'readonly' => true, 718 'context' => array( 'embed', 'view', 'edit' ), 719 'default' => null, 720 ), 721 'textdomain' => array( 722 'description' => __( 'Public text domain.' ), 723 'type' => array( 'string', 'null' ), 724 'default' => null, 725 'context' => array( 'embed', 'view', 'edit' ), 726 'readonly' => true, 727 ), 728 'parent' => array( 729 'description' => __( 'Parent blocks.' ), 730 'type' => array( 'array', 'null' ), 731 'items' => array( 732 'type' => 'string', 733 'pattern' => self::NAME_PATTERN, 734 ), 735 'default' => null, 736 'context' => array( 'embed', 'view', 'edit' ), 737 'readonly' => true, 738 ), 739 'ancestor' => array( 740 'description' => __( 'Ancestor blocks.' ), 741 'type' => array( 'array', 'null' ), 742 'items' => array( 743 'type' => 'string', 744 'pattern' => self::NAME_PATTERN, 745 ), 746 'default' => null, 747 'context' => array( 'embed', 'view', 'edit' ), 748 'readonly' => true, 749 ), 750 'allowed_blocks' => array( 751 'description' => __( 'Allowed child block types.' ), 752 'type' => array( 'array', 'null' ), 753 'items' => array( 754 'type' => 'string', 755 'pattern' => self::NAME_PATTERN, 756 ), 757 'default' => null, 758 'context' => array( 'embed', 'view', 'edit' ), 759 'readonly' => true, 760 ), 761 'keywords' => $keywords_definition, 762 'example' => $example_definition, 763 'block_hooks' => array( 764 'description' => __( 'This block is automatically inserted near any occurrence of the block types used as keys of this map, into a relative position given by the corresponding value.' ), 765 'type' => 'object', 766 'patternProperties' => array( 767 self::NAME_PATTERN => array( 768 'type' => 'string', 769 'enum' => array( 'before', 'after', 'first_child', 'last_child' ), 770 ), 771 ), 772 'default' => array(), 773 'context' => array( 'embed', 'view', 'edit' ), 774 'readonly' => true, 775 ), 776 ), 777 ); 778 779 // Properties deprecated in WordPress 6.1, but left in the schema for backwards compatibility. 780 $deprecated_properties = array( 781 'editor_script' => array( 782 'description' => __( 'Editor script handle. DEPRECATED: Use `editor_script_handles` instead.' ), 783 'type' => array( 'string', 'null' ), 784 'default' => null, 785 'context' => array( 'embed', 'view', 'edit' ), 786 'readonly' => true, 787 ), 788 'script' => array( 789 'description' => __( 'Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.' ), 790 'type' => array( 'string', 'null' ), 791 'default' => null, 792 'context' => array( 'embed', 'view', 'edit' ), 793 'readonly' => true, 794 ), 795 'view_script' => array( 796 'description' => __( 'Public facing script handle. DEPRECATED: Use `view_script_handles` instead.' ), 797 'type' => array( 'string', 'null' ), 798 'default' => null, 799 'context' => array( 'embed', 'view', 'edit' ), 800 'readonly' => true, 801 ), 802 'editor_style' => array( 803 'description' => __( 'Editor style handle. DEPRECATED: Use `editor_style_handles` instead.' ), 804 'type' => array( 'string', 'null' ), 805 'default' => null, 806 'context' => array( 'embed', 'view', 'edit' ), 807 'readonly' => true, 808 ), 809 'style' => array( 810 'description' => __( 'Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.' ), 811 'type' => array( 'string', 'null' ), 812 'default' => null, 813 'context' => array( 'embed', 'view', 'edit' ), 814 'readonly' => true, 815 ), 816 ); 817 $this->schema['properties'] = array_merge( $this->schema['properties'], $deprecated_properties ); 818 819 return $this->add_additional_fields_schema( $this->schema ); 820 } 821 822 /** 823 * Retrieves the query params for collections. 824 * 825 * @since 5.5.0 826 * 827 * @return array Collection parameters. 828 */ 829 public function get_collection_params() { 830 return array( 831 'context' => $this->get_context_param( array( 'default' => 'view' ) ), 832 'namespace' => array( 833 'description' => __( 'Block namespace.' ), 834 'type' => 'string', 835 ), 836 ); 837 } 838 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu Apr 3 08:20:01 2025 | Cross-referenced by PHPXref |