| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Functions related to registering and parsing blocks. 4 * 5 * @package WordPress 6 * @subpackage Blocks 7 * @since 5.0.0 8 */ 9 10 /** 11 * Removes the block asset's path prefix if provided. 12 * 13 * @since 5.5.0 14 * 15 * @param string $asset_handle_or_path Asset handle or prefixed path. 16 * @return string Path without the prefix or the original value. 17 */ 18 function remove_block_asset_path_prefix( $asset_handle_or_path ) { 19 $path_prefix = 'file:'; 20 if ( ! str_starts_with( $asset_handle_or_path, $path_prefix ) ) { 21 return $asset_handle_or_path; 22 } 23 $path = substr( 24 $asset_handle_or_path, 25 strlen( $path_prefix ) 26 ); 27 if ( str_starts_with( $path, './' ) ) { 28 $path = substr( $path, 2 ); 29 } 30 return $path; 31 } 32 33 /** 34 * Generates the name for an asset based on the name of the block 35 * and the field name provided. 36 * 37 * @since 5.5.0 38 * @since 6.1.0 Added `$index` parameter. 39 * @since 6.5.0 Added support for `viewScriptModule` field. 40 * 41 * @param string $block_name Name of the block. 42 * @param string $field_name Name of the metadata field. 43 * @param int $index Optional. Index of the asset when multiple items passed. 44 * Default 0. 45 * @return string Generated asset name for the block's field. 46 */ 47 function generate_block_asset_handle( $block_name, $field_name, $index = 0 ) { 48 if ( str_starts_with( $block_name, 'core/' ) ) { 49 $asset_handle = str_replace( 'core/', 'wp-block-', $block_name ); 50 if ( str_starts_with( $field_name, 'editor' ) ) { 51 $asset_handle .= '-editor'; 52 } 53 if ( str_starts_with( $field_name, 'view' ) ) { 54 $asset_handle .= '-view'; 55 } 56 if ( str_ends_with( strtolower( $field_name ), 'scriptmodule' ) ) { 57 $asset_handle .= '-script-module'; 58 } 59 if ( $index > 0 ) { 60 $asset_handle .= '-' . ( $index + 1 ); 61 } 62 return $asset_handle; 63 } 64 65 $field_mappings = array( 66 'editorScript' => 'editor-script', 67 'editorStyle' => 'editor-style', 68 'script' => 'script', 69 'style' => 'style', 70 'viewScript' => 'view-script', 71 'viewScriptModule' => 'view-script-module', 72 'viewStyle' => 'view-style', 73 ); 74 $asset_handle = str_replace( '/', '-', $block_name ) . 75 '-' . $field_mappings[ $field_name ]; 76 if ( $index > 0 ) { 77 $asset_handle .= '-' . ( $index + 1 ); 78 } 79 return $asset_handle; 80 } 81 82 /** 83 * Gets the URL to a block asset. 84 * 85 * @since 6.4.0 86 * 87 * @param string $path A normalized path to a block asset. 88 * @return string|false The URL to the block asset or false on failure. 89 */ 90 function get_block_asset_url( $path ) { 91 if ( empty( $path ) ) { 92 return false; 93 } 94 95 // Path needs to be normalized to work in Windows env. 96 static $wpinc_path_norm = ''; 97 if ( ! $wpinc_path_norm ) { 98 $wpinc_path_norm = wp_normalize_path( realpath( ABSPATH . WPINC ) ); 99 } 100 101 if ( str_starts_with( $path, $wpinc_path_norm ) ) { 102 return includes_url( str_replace( $wpinc_path_norm, '', $path ) ); 103 } 104 105 static $template_paths_norm = array(); 106 107 $template = get_template(); 108 if ( ! isset( $template_paths_norm[ $template ] ) ) { 109 $template_paths_norm[ $template ] = wp_normalize_path( realpath( get_template_directory() ) ); 110 } 111 112 if ( str_starts_with( $path, trailingslashit( $template_paths_norm[ $template ] ) ) ) { 113 return get_theme_file_uri( str_replace( $template_paths_norm[ $template ], '', $path ) ); 114 } 115 116 if ( is_child_theme() ) { 117 $stylesheet = get_stylesheet(); 118 if ( ! isset( $template_paths_norm[ $stylesheet ] ) ) { 119 $template_paths_norm[ $stylesheet ] = wp_normalize_path( realpath( get_stylesheet_directory() ) ); 120 } 121 122 if ( str_starts_with( $path, trailingslashit( $template_paths_norm[ $stylesheet ] ) ) ) { 123 return get_theme_file_uri( str_replace( $template_paths_norm[ $stylesheet ], '', $path ) ); 124 } 125 } 126 127 return plugins_url( basename( $path ), $path ); 128 } 129 130 /** 131 * Finds a script module ID for the selected block metadata field. It detects 132 * when a path to file was provided and optionally finds a corresponding asset 133 * file with details necessary to register the script module under with an 134 * automatically generated module ID. It returns unprocessed script module 135 * ID otherwise. 136 * 137 * @since 6.5.0 138 * 139 * @param array $metadata Block metadata. 140 * @param string $field_name Field name to pick from metadata. 141 * @param int $index Optional. Index of the script module ID to register when multiple 142 * items passed. Default 0. 143 * @return string|false Script module ID or false on failure. 144 */ 145 function register_block_script_module_id( $metadata, $field_name, $index = 0 ) { 146 if ( empty( $metadata[ $field_name ] ) ) { 147 return false; 148 } 149 150 $module_id = $metadata[ $field_name ]; 151 if ( is_array( $module_id ) ) { 152 if ( empty( $module_id[ $index ] ) ) { 153 return false; 154 } 155 $module_id = $module_id[ $index ]; 156 } 157 158 $module_path = remove_block_asset_path_prefix( $module_id ); 159 if ( $module_id === $module_path ) { 160 return $module_id; 161 } 162 163 $path = dirname( $metadata['file'] ); 164 $module_asset_raw_path = $path . '/' . substr_replace( $module_path, '.asset.php', - strlen( '.js' ) ); 165 $module_id = generate_block_asset_handle( $metadata['name'], $field_name, $index ); 166 $module_asset_path = wp_normalize_path( 167 realpath( $module_asset_raw_path ) 168 ); 169 170 $module_path_norm = wp_normalize_path( realpath( $path . '/' . $module_path ) ); 171 $module_uri = get_block_asset_url( $module_path_norm ); 172 173 $module_asset = ! empty( $module_asset_path ) ? require $module_asset_path : array(); 174 $module_dependencies = isset( $module_asset['dependencies'] ) ? $module_asset['dependencies'] : array(); 175 $block_version = isset( $metadata['version'] ) ? $metadata['version'] : false; 176 $module_version = isset( $module_asset['version'] ) ? $module_asset['version'] : $block_version; 177 178 wp_register_script_module( 179 $module_id, 180 $module_uri, 181 $module_dependencies, 182 $module_version 183 ); 184 185 return $module_id; 186 } 187 188 /** 189 * Finds a script handle for the selected block metadata field. It detects 190 * when a path to file was provided and optionally finds a corresponding asset 191 * file with details necessary to register the script under automatically 192 * generated handle name. It returns unprocessed script handle otherwise. 193 * 194 * @since 5.5.0 195 * @since 6.1.0 Added `$index` parameter. 196 * @since 6.5.0 The asset file is optional. Added script handle support in the asset file. 197 * 198 * @param array $metadata Block metadata. 199 * @param string $field_name Field name to pick from metadata. 200 * @param int $index Optional. Index of the script to register when multiple items passed. 201 * Default 0. 202 * @return string|false Script handle provided directly or created through 203 * script's registration, or false on failure. 204 */ 205 function register_block_script_handle( $metadata, $field_name, $index = 0 ) { 206 if ( empty( $metadata[ $field_name ] ) ) { 207 return false; 208 } 209 210 $script_handle_or_path = $metadata[ $field_name ]; 211 if ( is_array( $script_handle_or_path ) ) { 212 if ( empty( $script_handle_or_path[ $index ] ) ) { 213 return false; 214 } 215 $script_handle_or_path = $script_handle_or_path[ $index ]; 216 } 217 218 $script_path = remove_block_asset_path_prefix( $script_handle_or_path ); 219 if ( $script_handle_or_path === $script_path ) { 220 return $script_handle_or_path; 221 } 222 223 $path = dirname( $metadata['file'] ); 224 $script_asset_raw_path = $path . '/' . substr_replace( $script_path, '.asset.php', - strlen( '.js' ) ); 225 $script_asset_path = wp_normalize_path( 226 realpath( $script_asset_raw_path ) 227 ); 228 229 // Asset file for blocks is optional. See https://core.trac.wordpress.org/ticket/60460. 230 $script_asset = ! empty( $script_asset_path ) ? require $script_asset_path : array(); 231 $script_handle = isset( $script_asset['handle'] ) ? 232 $script_asset['handle'] : 233 generate_block_asset_handle( $metadata['name'], $field_name, $index ); 234 if ( wp_script_is( $script_handle, 'registered' ) ) { 235 return $script_handle; 236 } 237 238 $script_path_norm = wp_normalize_path( realpath( $path . '/' . $script_path ) ); 239 $script_uri = get_block_asset_url( $script_path_norm ); 240 $script_dependencies = isset( $script_asset['dependencies'] ) ? $script_asset['dependencies'] : array(); 241 $block_version = isset( $metadata['version'] ) ? $metadata['version'] : false; 242 $script_version = isset( $script_asset['version'] ) ? $script_asset['version'] : $block_version; 243 $script_args = array(); 244 if ( 'viewScript' === $field_name && $script_uri ) { 245 $script_args['strategy'] = 'defer'; 246 } 247 248 $result = wp_register_script( 249 $script_handle, 250 $script_uri, 251 $script_dependencies, 252 $script_version, 253 $script_args 254 ); 255 if ( ! $result ) { 256 return false; 257 } 258 259 if ( ! empty( $metadata['textdomain'] ) && in_array( 'wp-i18n', $script_dependencies, true ) ) { 260 wp_set_script_translations( $script_handle, $metadata['textdomain'] ); 261 } 262 263 return $script_handle; 264 } 265 266 /** 267 * Finds a style handle for the block metadata field. It detects when a path 268 * to file was provided and registers the style under automatically 269 * generated handle name. It returns unprocessed style handle otherwise. 270 * 271 * @since 5.5.0 272 * @since 6.1.0 Added `$index` parameter. 273 * 274 * @param array $metadata Block metadata. 275 * @param string $field_name Field name to pick from metadata. 276 * @param int $index Optional. Index of the style to register when multiple items passed. 277 * Default 0. 278 * @return string|false Style handle provided directly or created through 279 * style's registration, or false on failure. 280 */ 281 function register_block_style_handle( $metadata, $field_name, $index = 0 ) { 282 if ( empty( $metadata[ $field_name ] ) ) { 283 return false; 284 } 285 286 $style_handle = $metadata[ $field_name ]; 287 if ( is_array( $style_handle ) ) { 288 if ( empty( $style_handle[ $index ] ) ) { 289 return false; 290 } 291 $style_handle = $style_handle[ $index ]; 292 } 293 294 $style_handle_name = generate_block_asset_handle( $metadata['name'], $field_name, $index ); 295 // If the style handle is already registered, skip re-registering. 296 if ( wp_style_is( $style_handle_name, 'registered' ) ) { 297 return $style_handle_name; 298 } 299 300 static $wpinc_path_norm = ''; 301 if ( ! $wpinc_path_norm ) { 302 $wpinc_path_norm = wp_normalize_path( realpath( ABSPATH . WPINC ) ); 303 } 304 305 $is_core_block = isset( $metadata['file'] ) && str_starts_with( $metadata['file'], $wpinc_path_norm ); 306 // Skip registering individual styles for each core block when a bundled version provided. 307 if ( $is_core_block && ! wp_should_load_separate_core_block_assets() ) { 308 return false; 309 } 310 311 $style_path = remove_block_asset_path_prefix( $style_handle ); 312 $is_style_handle = $style_handle === $style_path; 313 // Allow only passing style handles for core blocks. 314 if ( $is_core_block && ! $is_style_handle ) { 315 return false; 316 } 317 // Return the style handle unless it's the first item for every core block that requires special treatment. 318 if ( $is_style_handle && ! ( $is_core_block && 0 === $index ) ) { 319 return $style_handle; 320 } 321 322 // Check whether styles should have a ".min" suffix or not. 323 $suffix = SCRIPT_DEBUG ? '' : '.min'; 324 if ( $is_core_block ) { 325 $style_path = ( 'editorStyle' === $field_name ) ? "editor{$suffix}.css" : "style{$suffix}.css"; 326 } 327 328 $style_path_norm = wp_normalize_path( realpath( dirname( $metadata['file'] ) . '/' . $style_path ) ); 329 $style_uri = get_block_asset_url( $style_path_norm ); 330 331 $version = ! $is_core_block && isset( $metadata['version'] ) ? $metadata['version'] : false; 332 $result = wp_register_style( 333 $style_handle_name, 334 $style_uri, 335 array(), 336 $version 337 ); 338 if ( ! $result ) { 339 return false; 340 } 341 342 if ( $style_uri ) { 343 wp_style_add_data( $style_handle_name, 'path', $style_path_norm ); 344 345 if ( $is_core_block ) { 346 $rtl_file = str_replace( "{$suffix}.css", "-rtl{$suffix}.css", $style_path_norm ); 347 } else { 348 $rtl_file = str_replace( '.css', '-rtl.css', $style_path_norm ); 349 } 350 351 if ( is_rtl() && file_exists( $rtl_file ) ) { 352 wp_style_add_data( $style_handle_name, 'rtl', 'replace' ); 353 wp_style_add_data( $style_handle_name, 'suffix', $suffix ); 354 wp_style_add_data( $style_handle_name, 'path', $rtl_file ); 355 } 356 } 357 358 return $style_handle_name; 359 } 360 361 /** 362 * Gets i18n schema for block's metadata read from `block.json` file. 363 * 364 * @since 5.9.0 365 * 366 * @return object The schema for block's metadata. 367 */ 368 function get_block_metadata_i18n_schema() { 369 static $i18n_block_schema; 370 371 if ( ! isset( $i18n_block_schema ) ) { 372 $i18n_block_schema = wp_json_file_decode( __DIR__ . '/block-i18n.json' ); 373 } 374 375 return $i18n_block_schema; 376 } 377 378 /** 379 * Registers all block types from a block metadata collection. 380 * 381 * This can either reference a previously registered metadata collection or, if the `$manifest` parameter is provided, 382 * register the metadata collection directly within the same function call. 383 * 384 * @since 6.8.0 385 * @see wp_register_block_metadata_collection() 386 * @see register_block_type_from_metadata() 387 * 388 * @param string $path The absolute base path for the collection ( e.g., WP_PLUGIN_DIR . '/my-plugin/blocks/' ). 389 * @param string $manifest Optional. The absolute path to the manifest file containing the metadata collection, in 390 * order to register the collection. If this parameter is not provided, the `$path` parameter 391 * must reference a previously registered block metadata collection. 392 */ 393 function wp_register_block_types_from_metadata_collection( $path, $manifest = '' ) { 394 if ( $manifest ) { 395 wp_register_block_metadata_collection( $path, $manifest ); 396 } 397 398 $block_metadata_files = WP_Block_Metadata_Registry::get_collection_block_metadata_files( $path ); 399 foreach ( $block_metadata_files as $block_metadata_file ) { 400 register_block_type_from_metadata( $block_metadata_file ); 401 } 402 } 403 404 /** 405 * Registers a block metadata collection. 406 * 407 * This function allows core and third-party plugins to register their block metadata 408 * collections in a centralized location. Registering collections can improve performance 409 * by avoiding multiple reads from the filesystem and parsing JSON. 410 * 411 * @since 6.7.0 412 * 413 * @param string $path The base path in which block files for the collection reside. 414 * @param string $manifest The path to the manifest file for the collection. 415 */ 416 function wp_register_block_metadata_collection( $path, $manifest ) { 417 WP_Block_Metadata_Registry::register_collection( $path, $manifest ); 418 } 419 420 /** 421 * Registers a block type from the metadata stored in the `block.json` file. 422 * 423 * @since 5.5.0 424 * @since 5.7.0 Added support for `textdomain` field and i18n handling for all translatable fields. 425 * @since 5.9.0 Added support for `variations` and `viewScript` fields. 426 * @since 6.1.0 Added support for `render` field. 427 * @since 6.3.0 Added `selectors` field. 428 * @since 6.4.0 Added support for `blockHooks` field. 429 * @since 6.5.0 Added support for `allowedBlocks`, `viewScriptModule`, and `viewStyle` fields. 430 * @since 6.7.0 Allow PHP filename as `variations` argument. 431 * 432 * @param string $file_or_folder Path to the JSON file with metadata definition for 433 * the block or path to the folder where the `block.json` file is located. 434 * If providing the path to a JSON file, the filename must end with `block.json`. 435 * @param array $args Optional. Array of block type arguments. Accepts any public property 436 * of `WP_Block_Type`. See WP_Block_Type::__construct() for information 437 * on accepted arguments. Default empty array. 438 * @return WP_Block_Type|false The registered block type on success, or false on failure. 439 */ 440 function register_block_type_from_metadata( $file_or_folder, $args = array() ) { 441 /* 442 * Get an array of metadata from a PHP file. 443 * This improves performance for core blocks as it's only necessary to read a single PHP file 444 * instead of reading a JSON file per-block, and then decoding from JSON to PHP. 445 * Using a static variable ensures that the metadata is only read once per request. 446 */ 447 448 $file_or_folder = wp_normalize_path( $file_or_folder ); 449 450 $metadata_file = ( ! str_ends_with( $file_or_folder, 'block.json' ) ) ? 451 trailingslashit( $file_or_folder ) . 'block.json' : 452 $file_or_folder; 453 454 $is_core_block = str_starts_with( $file_or_folder, wp_normalize_path( ABSPATH . WPINC ) ); 455 $metadata_file_exists = $is_core_block || file_exists( $metadata_file ); 456 $registry_metadata = WP_Block_Metadata_Registry::get_metadata( $file_or_folder ); 457 458 if ( $registry_metadata ) { 459 $metadata = $registry_metadata; 460 } elseif ( $metadata_file_exists ) { 461 $metadata = wp_json_file_decode( $metadata_file, array( 'associative' => true ) ); 462 } else { 463 $metadata = array(); 464 } 465 466 if ( ! is_array( $metadata ) || ( empty( $metadata['name'] ) && empty( $args['name'] ) ) ) { 467 return false; 468 } 469 470 $metadata['file'] = $metadata_file_exists ? wp_normalize_path( realpath( $metadata_file ) ) : null; 471 472 /** 473 * Filters the metadata provided for registering a block type. 474 * 475 * @since 5.7.0 476 * 477 * @param array $metadata Metadata for registering a block type. 478 */ 479 $metadata = apply_filters( 'block_type_metadata', $metadata ); 480 481 // Add `style` and `editor_style` for core blocks if missing. 482 if ( ! empty( $metadata['name'] ) && str_starts_with( $metadata['name'], 'core/' ) ) { 483 $block_name = str_replace( 'core/', '', $metadata['name'] ); 484 485 if ( ! isset( $metadata['style'] ) ) { 486 $metadata['style'] = "wp-block-$block_name"; 487 } 488 if ( current_theme_supports( 'wp-block-styles' ) && wp_should_load_separate_core_block_assets() ) { 489 $metadata['style'] = (array) $metadata['style']; 490 $metadata['style'][] = "wp-block-{$block_name}-theme"; 491 } 492 if ( ! isset( $metadata['editorStyle'] ) ) { 493 $metadata['editorStyle'] = "wp-block-{$block_name}-editor"; 494 } 495 } 496 497 $settings = array(); 498 $property_mappings = array( 499 'apiVersion' => 'api_version', 500 'name' => 'name', 501 'title' => 'title', 502 'category' => 'category', 503 'parent' => 'parent', 504 'ancestor' => 'ancestor', 505 'icon' => 'icon', 506 'description' => 'description', 507 'keywords' => 'keywords', 508 'attributes' => 'attributes', 509 'providesContext' => 'provides_context', 510 'usesContext' => 'uses_context', 511 'selectors' => 'selectors', 512 'supports' => 'supports', 513 'styles' => 'styles', 514 'variations' => 'variations', 515 'example' => 'example', 516 'allowedBlocks' => 'allowed_blocks', 517 ); 518 $textdomain = ! empty( $metadata['textdomain'] ) ? $metadata['textdomain'] : null; 519 $i18n_schema = get_block_metadata_i18n_schema(); 520 521 foreach ( $property_mappings as $key => $mapped_key ) { 522 if ( isset( $metadata[ $key ] ) ) { 523 $settings[ $mapped_key ] = $metadata[ $key ]; 524 if ( $metadata_file_exists && $textdomain && isset( $i18n_schema->$key ) ) { 525 $settings[ $mapped_key ] = translate_settings_using_i18n_schema( $i18n_schema->$key, $settings[ $key ], $textdomain ); 526 } 527 } 528 } 529 530 if ( ! empty( $metadata['render'] ) ) { 531 $template_path = wp_normalize_path( 532 realpath( 533 dirname( $metadata['file'] ) . '/' . 534 remove_block_asset_path_prefix( $metadata['render'] ) 535 ) 536 ); 537 if ( $template_path ) { 538 /** 539 * Renders the block on the server. 540 * 541 * @since 6.1.0 542 * 543 * @param array $attributes Block attributes. 544 * @param string $content Block default content. 545 * @param WP_Block $block Block instance. 546 * 547 * @return string Returns the block content. 548 */ 549 $settings['render_callback'] = static function ( $attributes, $content, $block ) use ( $template_path ) { 550 ob_start(); 551 require $template_path; 552 return ob_get_clean(); 553 }; 554 } 555 } 556 557 // If `variations` is a string, it's the name of a PHP file that 558 // generates the variations. 559 if ( ! empty( $metadata['variations'] ) && is_string( $metadata['variations'] ) ) { 560 $variations_path = wp_normalize_path( 561 realpath( 562 dirname( $metadata['file'] ) . '/' . 563 remove_block_asset_path_prefix( $metadata['variations'] ) 564 ) 565 ); 566 if ( $variations_path ) { 567 /** 568 * Generates the list of block variations. 569 * 570 * @since 6.7.0 571 * 572 * @return string Returns the list of block variations. 573 */ 574 $settings['variation_callback'] = static function () use ( $variations_path ) { 575 $variations = require $variations_path; 576 return $variations; 577 }; 578 // The block instance's `variations` field is only allowed to be an array 579 // (of known block variations). We unset it so that the block instance will 580 // provide a getter that returns the result of the `variation_callback` instead. 581 unset( $settings['variations'] ); 582 } 583 } 584 585 $settings = array_merge( $settings, $args ); 586 587 $script_fields = array( 588 'editorScript' => 'editor_script_handles', 589 'script' => 'script_handles', 590 'viewScript' => 'view_script_handles', 591 ); 592 foreach ( $script_fields as $metadata_field_name => $settings_field_name ) { 593 if ( ! empty( $settings[ $metadata_field_name ] ) ) { 594 $metadata[ $metadata_field_name ] = $settings[ $metadata_field_name ]; 595 } 596 if ( ! empty( $metadata[ $metadata_field_name ] ) ) { 597 $scripts = $metadata[ $metadata_field_name ]; 598 $processed_scripts = array(); 599 if ( is_array( $scripts ) ) { 600 for ( $index = 0; $index < count( $scripts ); $index++ ) { 601 $result = register_block_script_handle( 602 $metadata, 603 $metadata_field_name, 604 $index 605 ); 606 if ( $result ) { 607 $processed_scripts[] = $result; 608 } 609 } 610 } else { 611 $result = register_block_script_handle( 612 $metadata, 613 $metadata_field_name 614 ); 615 if ( $result ) { 616 $processed_scripts[] = $result; 617 } 618 } 619 $settings[ $settings_field_name ] = $processed_scripts; 620 } 621 } 622 623 $module_fields = array( 624 'viewScriptModule' => 'view_script_module_ids', 625 ); 626 foreach ( $module_fields as $metadata_field_name => $settings_field_name ) { 627 if ( ! empty( $settings[ $metadata_field_name ] ) ) { 628 $metadata[ $metadata_field_name ] = $settings[ $metadata_field_name ]; 629 } 630 if ( ! empty( $metadata[ $metadata_field_name ] ) ) { 631 $modules = $metadata[ $metadata_field_name ]; 632 $processed_modules = array(); 633 if ( is_array( $modules ) ) { 634 for ( $index = 0; $index < count( $modules ); $index++ ) { 635 $result = register_block_script_module_id( 636 $metadata, 637 $metadata_field_name, 638 $index 639 ); 640 if ( $result ) { 641 $processed_modules[] = $result; 642 } 643 } 644 } else { 645 $result = register_block_script_module_id( 646 $metadata, 647 $metadata_field_name 648 ); 649 if ( $result ) { 650 $processed_modules[] = $result; 651 } 652 } 653 $settings[ $settings_field_name ] = $processed_modules; 654 } 655 } 656 657 $style_fields = array( 658 'editorStyle' => 'editor_style_handles', 659 'style' => 'style_handles', 660 'viewStyle' => 'view_style_handles', 661 ); 662 foreach ( $style_fields as $metadata_field_name => $settings_field_name ) { 663 if ( ! empty( $settings[ $metadata_field_name ] ) ) { 664 $metadata[ $metadata_field_name ] = $settings[ $metadata_field_name ]; 665 } 666 if ( ! empty( $metadata[ $metadata_field_name ] ) ) { 667 $styles = $metadata[ $metadata_field_name ]; 668 $processed_styles = array(); 669 if ( is_array( $styles ) ) { 670 for ( $index = 0; $index < count( $styles ); $index++ ) { 671 $result = register_block_style_handle( 672 $metadata, 673 $metadata_field_name, 674 $index 675 ); 676 if ( $result ) { 677 $processed_styles[] = $result; 678 } 679 } 680 } else { 681 $result = register_block_style_handle( 682 $metadata, 683 $metadata_field_name 684 ); 685 if ( $result ) { 686 $processed_styles[] = $result; 687 } 688 } 689 $settings[ $settings_field_name ] = $processed_styles; 690 } 691 } 692 693 if ( ! empty( $metadata['blockHooks'] ) ) { 694 /** 695 * Map camelCased position string (from block.json) to snake_cased block type position. 696 * 697 * @var array 698 */ 699 $position_mappings = array( 700 'before' => 'before', 701 'after' => 'after', 702 'firstChild' => 'first_child', 703 'lastChild' => 'last_child', 704 ); 705 706 $settings['block_hooks'] = array(); 707 foreach ( $metadata['blockHooks'] as $anchor_block_name => $position ) { 708 // Avoid infinite recursion (hooking to itself). 709 if ( $metadata['name'] === $anchor_block_name ) { 710 _doing_it_wrong( 711 __METHOD__, 712 __( 'Cannot hook block to itself.' ), 713 '6.4.0' 714 ); 715 continue; 716 } 717 718 if ( ! isset( $position_mappings[ $position ] ) ) { 719 continue; 720 } 721 722 $settings['block_hooks'][ $anchor_block_name ] = $position_mappings[ $position ]; 723 } 724 } 725 726 /** 727 * Filters the settings determined from the block type metadata. 728 * 729 * @since 5.7.0 730 * 731 * @param array $settings Array of determined settings for registering a block type. 732 * @param array $metadata Metadata provided for registering a block type. 733 */ 734 $settings = apply_filters( 'block_type_metadata_settings', $settings, $metadata ); 735 736 $metadata['name'] = ! empty( $settings['name'] ) ? $settings['name'] : $metadata['name']; 737 738 return WP_Block_Type_Registry::get_instance()->register( 739 $metadata['name'], 740 $settings 741 ); 742 } 743 744 /** 745 * Registers a block type. The recommended way is to register a block type using 746 * the metadata stored in the `block.json` file. 747 * 748 * @since 5.0.0 749 * @since 5.8.0 First parameter now accepts a path to the `block.json` file. 750 * 751 * @param string|WP_Block_Type $block_type Block type name including namespace, or alternatively 752 * a path to the JSON file with metadata definition for the block, 753 * or a path to the folder where the `block.json` file is located, 754 * or a complete WP_Block_Type instance. 755 * In case a WP_Block_Type is provided, the $args parameter will be ignored. 756 * @param array $args Optional. Array of block type arguments. Accepts any public property 757 * of `WP_Block_Type`. See WP_Block_Type::__construct() for information 758 * on accepted arguments. Default empty array. 759 * 760 * @return WP_Block_Type|false The registered block type on success, or false on failure. 761 */ 762 function register_block_type( $block_type, $args = array() ) { 763 if ( is_string( $block_type ) && file_exists( $block_type ) ) { 764 return register_block_type_from_metadata( $block_type, $args ); 765 } 766 767 return WP_Block_Type_Registry::get_instance()->register( $block_type, $args ); 768 } 769 770 /** 771 * Unregisters a block type. 772 * 773 * @since 5.0.0 774 * 775 * @param string|WP_Block_Type $name Block type name including namespace, or alternatively 776 * a complete WP_Block_Type instance. 777 * @return WP_Block_Type|false The unregistered block type on success, or false on failure. 778 */ 779 function unregister_block_type( $name ) { 780 return WP_Block_Type_Registry::get_instance()->unregister( $name ); 781 } 782 783 /** 784 * Determines whether a post or content string has blocks. 785 * 786 * This test optimizes for performance rather than strict accuracy, detecting 787 * the pattern of a block but not validating its structure. For strict accuracy, 788 * you should use the block parser on post content. 789 * 790 * @since 5.0.0 791 * 792 * @see parse_blocks() 793 * 794 * @param int|string|WP_Post|null $post Optional. Post content, post ID, or post object. 795 * Defaults to global $post. 796 * @return bool Whether the post has blocks. 797 */ 798 function has_blocks( $post = null ) { 799 if ( ! is_string( $post ) ) { 800 $wp_post = get_post( $post ); 801 802 if ( ! $wp_post instanceof WP_Post ) { 803 return false; 804 } 805 806 $post = $wp_post->post_content; 807 } 808 809 return str_contains( (string) $post, '<!-- wp:' ); 810 } 811 812 /** 813 * Determines whether a $post or a string contains a specific block type. 814 * 815 * This test optimizes for performance rather than strict accuracy, detecting 816 * whether the block type exists but not validating its structure and not checking 817 * synced patterns (formerly called reusable blocks). For strict accuracy, 818 * you should use the block parser on post content. 819 * 820 * @since 5.0.0 821 * 822 * @see parse_blocks() 823 * 824 * @param string $block_name Full block type to look for. 825 * @param int|string|WP_Post|null $post Optional. Post content, post ID, or post object. 826 * Defaults to global $post. 827 * @return bool Whether the post content contains the specified block. 828 */ 829 function has_block( $block_name, $post = null ) { 830 if ( ! has_blocks( $post ) ) { 831 return false; 832 } 833 834 if ( ! is_string( $post ) ) { 835 $wp_post = get_post( $post ); 836 if ( $wp_post instanceof WP_Post ) { 837 $post = $wp_post->post_content; 838 } 839 } 840 841 /* 842 * Normalize block name to include namespace, if provided as non-namespaced. 843 * This matches behavior for WordPress 5.0.0 - 5.3.0 in matching blocks by 844 * their serialized names. 845 */ 846 if ( ! str_contains( $block_name, '/' ) ) { 847 $block_name = 'core/' . $block_name; 848 } 849 850 // Test for existence of block by its fully qualified name. 851 $has_block = str_contains( $post, '<!-- wp:' . $block_name . ' ' ); 852 853 if ( ! $has_block ) { 854 /* 855 * If the given block name would serialize to a different name, test for 856 * existence by the serialized form. 857 */ 858 $serialized_block_name = strip_core_block_namespace( $block_name ); 859 if ( $serialized_block_name !== $block_name ) { 860 $has_block = str_contains( $post, '<!-- wp:' . $serialized_block_name . ' ' ); 861 } 862 } 863 864 return $has_block; 865 } 866 867 /** 868 * Returns an array of the names of all registered dynamic block types. 869 * 870 * @since 5.0.0 871 * 872 * @return string[] Array of dynamic block names. 873 */ 874 function get_dynamic_block_names() { 875 $dynamic_block_names = array(); 876 877 $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered(); 878 foreach ( $block_types as $block_type ) { 879 if ( $block_type->is_dynamic() ) { 880 $dynamic_block_names[] = $block_type->name; 881 } 882 } 883 884 return $dynamic_block_names; 885 } 886 887 /** 888 * Retrieves block types hooked into the given block, grouped by anchor block type and the relative position. 889 * 890 * @since 6.4.0 891 * 892 * @return array[] Array of block types grouped by anchor block type and the relative position. 893 */ 894 function get_hooked_blocks() { 895 $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered(); 896 $hooked_blocks = array(); 897 foreach ( $block_types as $block_type ) { 898 if ( ! ( $block_type instanceof WP_Block_Type ) || ! is_array( $block_type->block_hooks ) ) { 899 continue; 900 } 901 foreach ( $block_type->block_hooks as $anchor_block_type => $relative_position ) { 902 if ( ! isset( $hooked_blocks[ $anchor_block_type ] ) ) { 903 $hooked_blocks[ $anchor_block_type ] = array(); 904 } 905 if ( ! isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) ) { 906 $hooked_blocks[ $anchor_block_type ][ $relative_position ] = array(); 907 } 908 $hooked_blocks[ $anchor_block_type ][ $relative_position ][] = $block_type->name; 909 } 910 } 911 912 return $hooked_blocks; 913 } 914 915 /** 916 * Returns the markup for blocks hooked to the given anchor block in a specific relative position. 917 * 918 * @since 6.5.0 919 * @access private 920 * 921 * @param array $parsed_anchor_block The anchor block, in parsed block array format. 922 * @param string $relative_position The relative position of the hooked blocks. 923 * Can be one of 'before', 'after', 'first_child', or 'last_child'. 924 * @param array $hooked_blocks An array of hooked block types, grouped by anchor block and relative position. 925 * @param WP_Block_Template|WP_Post|array $context The block template, template part, or pattern that the anchor block belongs to. 926 * @return string 927 */ 928 function insert_hooked_blocks( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) { 929 $anchor_block_type = $parsed_anchor_block['blockName']; 930 $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) 931 ? $hooked_blocks[ $anchor_block_type ][ $relative_position ] 932 : array(); 933 934 /** 935 * Filters the list of hooked block types for a given anchor block type and relative position. 936 * 937 * @since 6.4.0 938 * 939 * @param string[] $hooked_block_types The list of hooked block types. 940 * @param string $relative_position The relative position of the hooked blocks. 941 * Can be one of 'before', 'after', 'first_child', or 'last_child'. 942 * @param string $anchor_block_type The anchor block type. 943 * @param WP_Block_Template|WP_Post|array $context The block template, template part, post object, 944 * or pattern that the anchor block belongs to. 945 */ 946 $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context ); 947 948 $markup = ''; 949 foreach ( $hooked_block_types as $hooked_block_type ) { 950 $parsed_hooked_block = array( 951 'blockName' => $hooked_block_type, 952 'attrs' => array(), 953 'innerBlocks' => array(), 954 'innerContent' => array(), 955 ); 956 957 /** 958 * Filters the parsed block array for a given hooked block. 959 * 960 * @since 6.5.0 961 * 962 * @param array|null $parsed_hooked_block The parsed block array for the given hooked block type, or null to suppress the block. 963 * @param string $hooked_block_type The hooked block type name. 964 * @param string $relative_position The relative position of the hooked block. 965 * @param array $parsed_anchor_block The anchor block, in parsed block array format. 966 * @param WP_Block_Template|WP_Post|array $context The block template, template part, post object, 967 * or pattern that the anchor block belongs to. 968 */ 969 $parsed_hooked_block = apply_filters( 'hooked_block', $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context ); 970 971 /** 972 * Filters the parsed block array for a given hooked block. 973 * 974 * The dynamic portion of the hook name, `$hooked_block_type`, refers to the block type name of the specific hooked block. 975 * 976 * @since 6.5.0 977 * 978 * @param array|null $parsed_hooked_block The parsed block array for the given hooked block type, or null to suppress the block. 979 * @param string $hooked_block_type The hooked block type name. 980 * @param string $relative_position The relative position of the hooked block. 981 * @param array $parsed_anchor_block The anchor block, in parsed block array format. 982 * @param WP_Block_Template|WP_Post|array $context The block template, template part, post object, 983 * or pattern that the anchor block belongs to. 984 */ 985 $parsed_hooked_block = apply_filters( "hooked_block_{$hooked_block_type}", $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context ); 986 987 if ( null === $parsed_hooked_block ) { 988 continue; 989 } 990 991 // It's possible that the filter returned a block of a different type, so we explicitly 992 // look for the original `$hooked_block_type` in the `ignoredHookedBlocks` metadata. 993 if ( 994 ! isset( $parsed_anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ) || 995 ! in_array( $hooked_block_type, $parsed_anchor_block['attrs']['metadata']['ignoredHookedBlocks'], true ) 996 ) { 997 $markup .= serialize_block( $parsed_hooked_block ); 998 } 999 } 1000 1001 return $markup; 1002 } 1003 1004 /** 1005 * Adds a list of hooked block types to an anchor block's ignored hooked block types. 1006 * 1007 * This function is meant for internal use only. 1008 * 1009 * @since 6.5.0 1010 * @access private 1011 * 1012 * @param array $parsed_anchor_block The anchor block, in parsed block array format. 1013 * @param string $relative_position The relative position of the hooked blocks. 1014 * Can be one of 'before', 'after', 'first_child', or 'last_child'. 1015 * @param array $hooked_blocks An array of hooked block types, grouped by anchor block and relative position. 1016 * @param WP_Block_Template|WP_Post|array $context The block template, template part, or pattern that the anchor block belongs to. 1017 * @return string Empty string. 1018 */ 1019 function set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) { 1020 $anchor_block_type = $parsed_anchor_block['blockName']; 1021 $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) 1022 ? $hooked_blocks[ $anchor_block_type ][ $relative_position ] 1023 : array(); 1024 1025 /** This filter is documented in wp-includes/blocks.php */ 1026 $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context ); 1027 if ( empty( $hooked_block_types ) ) { 1028 return ''; 1029 } 1030 1031 foreach ( $hooked_block_types as $index => $hooked_block_type ) { 1032 $parsed_hooked_block = array( 1033 'blockName' => $hooked_block_type, 1034 'attrs' => array(), 1035 'innerBlocks' => array(), 1036 'innerContent' => array(), 1037 ); 1038 1039 /** This filter is documented in wp-includes/blocks.php */ 1040 $parsed_hooked_block = apply_filters( 'hooked_block', $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context ); 1041 1042 /** This filter is documented in wp-includes/blocks.php */ 1043 $parsed_hooked_block = apply_filters( "hooked_block_{$hooked_block_type}", $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context ); 1044 1045 if ( null === $parsed_hooked_block ) { 1046 unset( $hooked_block_types[ $index ] ); 1047 } 1048 } 1049 1050 $previously_ignored_hooked_blocks = isset( $parsed_anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ) 1051 ? $parsed_anchor_block['attrs']['metadata']['ignoredHookedBlocks'] 1052 : array(); 1053 1054 $parsed_anchor_block['attrs']['metadata']['ignoredHookedBlocks'] = array_unique( 1055 array_merge( 1056 $previously_ignored_hooked_blocks, 1057 $hooked_block_types 1058 ) 1059 ); 1060 1061 // Markup for the hooked blocks has already been created (in `insert_hooked_blocks`). 1062 return ''; 1063 } 1064 1065 /** 1066 * Runs the hooked blocks algorithm on the given content. 1067 * 1068 * @since 6.6.0 1069 * @since 6.7.0 Injects the `theme` attribute into Template Part blocks, even if no hooked blocks are registered. 1070 * @since 6.8.0 Have the `$context` parameter default to `null`, in which case `get_post()` will be called to use the current post as context. 1071 * @access private 1072 * 1073 * @param string $content Serialized content. 1074 * @param WP_Block_Template|WP_Post|array|null $context A block template, template part, post object, or pattern 1075 * that the blocks belong to. If set to `null`, `get_post()` 1076 * will be called to use the current post as context. 1077 * Default: `null`. 1078 * @param callable $callback A function that will be called for each block to generate 1079 * the markup for a given list of blocks that are hooked to it. 1080 * Default: 'insert_hooked_blocks'. 1081 * @return string The serialized markup. 1082 */ 1083 function apply_block_hooks_to_content( $content, $context = null, $callback = 'insert_hooked_blocks' ) { 1084 // Default to the current post if no context is provided. 1085 if ( null === $context ) { 1086 $context = get_post(); 1087 } 1088 1089 $hooked_blocks = get_hooked_blocks(); 1090 1091 $before_block_visitor = '_inject_theme_attribute_in_template_part_block'; 1092 $after_block_visitor = null; 1093 if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) { 1094 $before_block_visitor = make_before_block_visitor( $hooked_blocks, $context, $callback ); 1095 $after_block_visitor = make_after_block_visitor( $hooked_blocks, $context, $callback ); 1096 } 1097 1098 $block_allows_multiple_instances = array(); 1099 /* 1100 * Remove hooked blocks from `$hooked_block_types` if they have `multiple` set to false and 1101 * are already present in `$content`. 1102 */ 1103 foreach ( $hooked_blocks as $anchor_block_type => $relative_positions ) { 1104 foreach ( $relative_positions as $relative_position => $hooked_block_types ) { 1105 foreach ( $hooked_block_types as $index => $hooked_block_type ) { 1106 $hooked_block_type_definition = 1107 WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type ); 1108 1109 $block_allows_multiple_instances[ $hooked_block_type ] = 1110 block_has_support( $hooked_block_type_definition, 'multiple', true ); 1111 1112 if ( 1113 ! $block_allows_multiple_instances[ $hooked_block_type ] && 1114 has_block( $hooked_block_type, $content ) 1115 ) { 1116 unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ][ $index ] ); 1117 } 1118 } 1119 if ( empty( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) ) { 1120 unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ); 1121 } 1122 } 1123 if ( empty( $hooked_blocks[ $anchor_block_type ] ) ) { 1124 unset( $hooked_blocks[ $anchor_block_type ] ); 1125 } 1126 } 1127 1128 /* 1129 * We also need to cover the case where the hooked block is not present in 1130 * `$content` at first and we're allowed to insert it once -- but not again. 1131 */ 1132 $suppress_single_instance_blocks = static function ( $hooked_block_types ) use ( &$block_allows_multiple_instances, $content ) { 1133 static $single_instance_blocks_present_in_content = array(); 1134 foreach ( $hooked_block_types as $index => $hooked_block_type ) { 1135 if ( ! isset( $block_allows_multiple_instances[ $hooked_block_type ] ) ) { 1136 $hooked_block_type_definition = 1137 WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type ); 1138 1139 $block_allows_multiple_instances[ $hooked_block_type ] = 1140 block_has_support( $hooked_block_type_definition, 'multiple', true ); 1141 } 1142 1143 if ( $block_allows_multiple_instances[ $hooked_block_type ] ) { 1144 continue; 1145 } 1146 1147 // The block doesn't allow multiple instances, so we need to check if it's already present. 1148 if ( 1149 in_array( $hooked_block_type, $single_instance_blocks_present_in_content, true ) || 1150 has_block( $hooked_block_type, $content ) 1151 ) { 1152 unset( $hooked_block_types[ $index ] ); 1153 } else { 1154 // We can insert the block once, but need to remember not to insert it again. 1155 $single_instance_blocks_present_in_content[] = $hooked_block_type; 1156 } 1157 } 1158 return $hooked_block_types; 1159 }; 1160 add_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX ); 1161 $content = traverse_and_serialize_blocks( 1162 parse_blocks( $content ), 1163 $before_block_visitor, 1164 $after_block_visitor 1165 ); 1166 remove_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX ); 1167 1168 return $content; 1169 } 1170 1171 /** 1172 * Run the Block Hooks algorithm on a post object's content. 1173 * 1174 * This function is different from `apply_block_hooks_to_content` in that 1175 * it takes ignored hooked block information from the post's metadata into 1176 * account. This ensures that any blocks hooked as first or last child 1177 * of the block that corresponds to the post type are handled correctly. 1178 * 1179 * @since 6.8.0 1180 * @access private 1181 * 1182 * @param string $content Serialized content. 1183 * @param WP_Post|null $post A post object that the content belongs to. If set to `null`, 1184 * `get_post()` will be called to use the current post as context. 1185 * Default: `null`. 1186 * @param callable $callback A function that will be called for each block to generate 1187 * the markup for a given list of blocks that are hooked to it. 1188 * Default: 'insert_hooked_blocks'. 1189 * @return string The serialized markup. 1190 */ 1191 function apply_block_hooks_to_content_from_post_object( $content, $post = null, $callback = 'insert_hooked_blocks' ) { 1192 // Default to the current post if no context is provided. 1193 if ( null === $post ) { 1194 $post = get_post(); 1195 } 1196 1197 if ( ! $post instanceof WP_Post ) { 1198 return apply_block_hooks_to_content( $content, $post, $callback ); 1199 } 1200 1201 /* 1202 * If the content was created using the classic editor or using a single Classic block 1203 * (`core/freeform`), it might not contain any block markup at all. 1204 * However, we still might need to inject hooked blocks in the first child or last child 1205 * positions of the parent block. To be able to apply the Block Hooks algorithm, we wrap 1206 * the content in a `core/freeform` wrapper block. 1207 */ 1208 if ( ! has_blocks( $content ) ) { 1209 $original_content = $content; 1210 1211 $content_wrapped_in_classic_block = get_comment_delimited_block_content( 1212 'core/freeform', 1213 array(), 1214 $content 1215 ); 1216 1217 $content = $content_wrapped_in_classic_block; 1218 } 1219 1220 $attributes = array(); 1221 1222 // If context is a post object, `ignoredHookedBlocks` information is stored in its post meta. 1223 $ignored_hooked_blocks = get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true ); 1224 if ( ! empty( $ignored_hooked_blocks ) ) { 1225 $ignored_hooked_blocks = json_decode( $ignored_hooked_blocks, true ); 1226 $attributes['metadata'] = array( 1227 'ignoredHookedBlocks' => $ignored_hooked_blocks, 1228 ); 1229 } 1230 1231 /* 1232 * We need to wrap the content in a temporary wrapper block with that metadata 1233 * so the Block Hooks algorithm can insert blocks that are hooked as first or last child 1234 * of the wrapper block. 1235 * To that end, we need to determine the wrapper block type based on the post type. 1236 */ 1237 if ( 'wp_navigation' === $post->post_type ) { 1238 $wrapper_block_type = 'core/navigation'; 1239 } elseif ( 'wp_block' === $post->post_type ) { 1240 $wrapper_block_type = 'core/block'; 1241 } else { 1242 $wrapper_block_type = 'core/post-content'; 1243 } 1244 1245 $content = get_comment_delimited_block_content( 1246 $wrapper_block_type, 1247 $attributes, 1248 $content 1249 ); 1250 1251 // Apply Block Hooks. 1252 $content = apply_block_hooks_to_content( $content, $post, $callback ); 1253 1254 // Finally, we need to remove the temporary wrapper block. 1255 $content = remove_serialized_parent_block( $content ); 1256 1257 // If we wrapped the content in a `core/freeform` block, we also need to remove that. 1258 if ( ! empty( $content_wrapped_in_classic_block ) ) { 1259 /* 1260 * We cannot simply use remove_serialized_parent_block() here, 1261 * as that function assumes that the block wrapper is at the top level. 1262 * However, there might now be a hooked block inserted next to it 1263 * (as first or last child of the parent). 1264 */ 1265 $content = str_replace( $content_wrapped_in_classic_block, $original_content, $content ); 1266 } 1267 1268 return $content; 1269 } 1270 1271 /** 1272 * Accepts the serialized markup of a block and its inner blocks, and returns serialized markup of the inner blocks. 1273 * 1274 * @since 6.6.0 1275 * @access private 1276 * 1277 * @param string $serialized_block The serialized markup of a block and its inner blocks. 1278 * @return string The serialized markup of the inner blocks. 1279 */ 1280 function remove_serialized_parent_block( $serialized_block ) { 1281 $start = strpos( $serialized_block, '-->' ) + strlen( '-->' ); 1282 $end = strrpos( $serialized_block, '<!--' ); 1283 return substr( $serialized_block, $start, $end - $start ); 1284 } 1285 1286 /** 1287 * Accepts the serialized markup of a block and its inner blocks, and returns serialized markup of the wrapper block. 1288 * 1289 * @since 6.7.0 1290 * @access private 1291 * 1292 * @see remove_serialized_parent_block() 1293 * 1294 * @param string $serialized_block The serialized markup of a block and its inner blocks. 1295 * @return string The serialized markup of the wrapper block. 1296 */ 1297 function extract_serialized_parent_block( $serialized_block ) { 1298 $start = strpos( $serialized_block, '-->' ) + strlen( '-->' ); 1299 $end = strrpos( $serialized_block, '<!--' ); 1300 return substr( $serialized_block, 0, $start ) . substr( $serialized_block, $end ); 1301 } 1302 1303 /** 1304 * Updates the wp_postmeta with the list of ignored hooked blocks 1305 * where the inner blocks are stored as post content. 1306 * 1307 * @since 6.6.0 1308 * @since 6.8.0 Support non-`wp_navigation` post types. 1309 * @access private 1310 * 1311 * @param stdClass $post Post object. 1312 * @return stdClass The updated post object. 1313 */ 1314 function update_ignored_hooked_blocks_postmeta( $post ) { 1315 /* 1316 * In this scenario the user has likely tried to create a new post object via the REST API. 1317 * In which case we won't have a post ID to work with and store meta against. 1318 */ 1319 if ( empty( $post->ID ) ) { 1320 return $post; 1321 } 1322 1323 /* 1324 * Skip meta generation when consumers intentionally update specific fields 1325 * and omit the content update. 1326 */ 1327 if ( ! isset( $post->post_content ) ) { 1328 return $post; 1329 } 1330 1331 /* 1332 * Skip meta generation if post type is not set. 1333 */ 1334 if ( ! isset( $post->post_type ) ) { 1335 return $post; 1336 } 1337 1338 $attributes = array(); 1339 1340 $ignored_hooked_blocks = get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true ); 1341 if ( ! empty( $ignored_hooked_blocks ) ) { 1342 $ignored_hooked_blocks = json_decode( $ignored_hooked_blocks, true ); 1343 $attributes['metadata'] = array( 1344 'ignoredHookedBlocks' => $ignored_hooked_blocks, 1345 ); 1346 } 1347 1348 if ( 'wp_navigation' === $post->post_type ) { 1349 $wrapper_block_type = 'core/navigation'; 1350 } elseif ( 'wp_block' === $post->post_type ) { 1351 $wrapper_block_type = 'core/block'; 1352 } else { 1353 $wrapper_block_type = 'core/post-content'; 1354 } 1355 1356 $markup = get_comment_delimited_block_content( 1357 $wrapper_block_type, 1358 $attributes, 1359 $post->post_content 1360 ); 1361 1362 $existing_post = get_post( $post->ID ); 1363 // Merge the existing post object with the updated post object to pass to the block hooks algorithm for context. 1364 $context = (object) array_merge( (array) $existing_post, (array) $post ); 1365 $context = new WP_Post( $context ); // Convert to WP_Post object. 1366 $serialized_block = apply_block_hooks_to_content( $markup, $context, 'set_ignored_hooked_blocks_metadata' ); 1367 $root_block = parse_blocks( $serialized_block )[0]; 1368 1369 $ignored_hooked_blocks = isset( $root_block['attrs']['metadata']['ignoredHookedBlocks'] ) 1370 ? $root_block['attrs']['metadata']['ignoredHookedBlocks'] 1371 : array(); 1372 1373 if ( ! empty( $ignored_hooked_blocks ) ) { 1374 $existing_ignored_hooked_blocks = get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true ); 1375 if ( ! empty( $existing_ignored_hooked_blocks ) ) { 1376 $existing_ignored_hooked_blocks = json_decode( $existing_ignored_hooked_blocks, true ); 1377 $ignored_hooked_blocks = array_unique( array_merge( $ignored_hooked_blocks, $existing_ignored_hooked_blocks ) ); 1378 } 1379 1380 if ( ! isset( $post->meta_input ) ) { 1381 $post->meta_input = array(); 1382 } 1383 $post->meta_input['_wp_ignored_hooked_blocks'] = json_encode( $ignored_hooked_blocks ); 1384 } 1385 1386 $post->post_content = remove_serialized_parent_block( $serialized_block ); 1387 return $post; 1388 } 1389 1390 /** 1391 * Returns the markup for blocks hooked to the given anchor block in a specific relative position and then 1392 * adds a list of hooked block types to an anchor block's ignored hooked block types. 1393 * 1394 * This function is meant for internal use only. 1395 * 1396 * @since 6.6.0 1397 * @access private 1398 * 1399 * @param array $parsed_anchor_block The anchor block, in parsed block array format. 1400 * @param string $relative_position The relative position of the hooked blocks. 1401 * Can be one of 'before', 'after', 'first_child', or 'last_child'. 1402 * @param array $hooked_blocks An array of hooked block types, grouped by anchor block and relative position. 1403 * @param WP_Block_Template|WP_Post|array $context The block template, template part, or pattern that the anchor block belongs to. 1404 * @return string 1405 */ 1406 function insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) { 1407 $markup = insert_hooked_blocks( $parsed_anchor_block, $relative_position, $hooked_blocks, $context ); 1408 $markup .= set_ignored_hooked_blocks_metadata( $parsed_anchor_block, $relative_position, $hooked_blocks, $context ); 1409 1410 return $markup; 1411 } 1412 1413 /** 1414 * Hooks into the REST API response for the Posts endpoint and adds the first and last inner blocks. 1415 * 1416 * @since 6.6.0 1417 * @since 6.8.0 Support non-`wp_navigation` post types. 1418 * 1419 * @param WP_REST_Response $response The response object. 1420 * @param WP_Post $post Post object. 1421 * @return WP_REST_Response The response object. 1422 */ 1423 function insert_hooked_blocks_into_rest_response( $response, $post ) { 1424 if ( empty( $response->data['content']['raw'] ) ) { 1425 return $response; 1426 } 1427 1428 $response->data['content']['raw'] = apply_block_hooks_to_content_from_post_object( 1429 $response->data['content']['raw'], 1430 $post, 1431 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' 1432 ); 1433 1434 // If the rendered content was previously empty, we leave it like that. 1435 if ( empty( $response->data['content']['rendered'] ) ) { 1436 return $response; 1437 } 1438 1439 // `apply_block_hooks_to_content` is called above. Ensure it is not called again as a filter. 1440 $priority = has_filter( 'the_content', 'apply_block_hooks_to_content_from_post_object' ); 1441 if ( false !== $priority ) { 1442 remove_filter( 'the_content', 'apply_block_hooks_to_content_from_post_object', $priority ); 1443 } 1444 1445 /** This filter is documented in wp-includes/post-template.php */ 1446 $response->data['content']['rendered'] = apply_filters( 1447 'the_content', 1448 $response->data['content']['raw'] 1449 ); 1450 1451 // Restore the filter if it was set initially. 1452 if ( false !== $priority ) { 1453 add_filter( 'the_content', 'apply_block_hooks_to_content_from_post_object', $priority ); 1454 } 1455 1456 return $response; 1457 } 1458 1459 /** 1460 * Returns a function that injects the theme attribute into, and hooked blocks before, a given block. 1461 * 1462 * The returned function can be used as `$pre_callback` argument to `traverse_and_serialize_block(s)`, 1463 * where it will inject the `theme` attribute into all Template Part blocks, and prepend the markup for 1464 * any blocks hooked `before` the given block and as its parent's `first_child`, respectively. 1465 * 1466 * This function is meant for internal use only. 1467 * 1468 * @since 6.4.0 1469 * @since 6.5.0 Added $callback argument. 1470 * @access private 1471 * 1472 * @param array $hooked_blocks An array of blocks hooked to another given block. 1473 * @param WP_Block_Template|WP_Post|array $context A block template, template part, post object, 1474 * or pattern that the blocks belong to. 1475 * @param callable $callback A function that will be called for each block to generate 1476 * the markup for a given list of blocks that are hooked to it. 1477 * Default: 'insert_hooked_blocks'. 1478 * @return callable A function that returns the serialized markup for the given block, 1479 * including the markup for any hooked blocks before it. 1480 */ 1481 function make_before_block_visitor( $hooked_blocks, $context, $callback = 'insert_hooked_blocks' ) { 1482 /** 1483 * Injects hooked blocks before the given block, injects the `theme` attribute into Template Part blocks, and returns the serialized markup. 1484 * 1485 * If the current block is a Template Part block, inject the `theme` attribute. 1486 * Furthermore, prepend the markup for any blocks hooked `before` the given block and as its parent's 1487 * `first_child`, respectively, to the serialized markup for the given block. 1488 * 1489 * @param array $block The block to inject the theme attribute into, and hooked blocks before. Passed by reference. 1490 * @param array $parent_block The parent block of the given block. Passed by reference. Default null. 1491 * @param array $prev The previous sibling block of the given block. Default null. 1492 * @return string The serialized markup for the given block, with the markup for any hooked blocks prepended to it. 1493 */ 1494 return function ( &$block, &$parent_block = null, $prev = null ) use ( $hooked_blocks, $context, $callback ) { 1495 _inject_theme_attribute_in_template_part_block( $block ); 1496 1497 $markup = ''; 1498 1499 if ( $parent_block && ! $prev ) { 1500 // Candidate for first-child insertion. 1501 $markup .= call_user_func_array( 1502 $callback, 1503 array( &$parent_block, 'first_child', $hooked_blocks, $context ) 1504 ); 1505 } 1506 1507 $markup .= call_user_func_array( 1508 $callback, 1509 array( &$block, 'before', $hooked_blocks, $context ) 1510 ); 1511 1512 return $markup; 1513 }; 1514 } 1515 1516 /** 1517 * Returns a function that injects the hooked blocks after a given block. 1518 * 1519 * The returned function can be used as `$post_callback` argument to `traverse_and_serialize_block(s)`, 1520 * where it will append the markup for any blocks hooked `after` the given block and as its parent's 1521 * `last_child`, respectively. 1522 * 1523 * This function is meant for internal use only. 1524 * 1525 * @since 6.4.0 1526 * @since 6.5.0 Added $callback argument. 1527 * @access private 1528 * 1529 * @param array $hooked_blocks An array of blocks hooked to another block. 1530 * @param WP_Block_Template|WP_Post|array $context A block template, template part, post object, 1531 * or pattern that the blocks belong to. 1532 * @param callable $callback A function that will be called for each block to generate 1533 * the markup for a given list of blocks that are hooked to it. 1534 * Default: 'insert_hooked_blocks'. 1535 * @return callable A function that returns the serialized markup for the given block, 1536 * including the markup for any hooked blocks after it. 1537 */ 1538 function make_after_block_visitor( $hooked_blocks, $context, $callback = 'insert_hooked_blocks' ) { 1539 /** 1540 * Injects hooked blocks after the given block, and returns the serialized markup. 1541 * 1542 * Append the markup for any blocks hooked `after` the given block and as its parent's 1543 * `last_child`, respectively, to the serialized markup for the given block. 1544 * 1545 * @param array $block The block to inject the hooked blocks after. Passed by reference. 1546 * @param array $parent_block The parent block of the given block. Passed by reference. Default null. 1547 * @param array $next The next sibling block of the given block. Default null. 1548 * @return string The serialized markup for the given block, with the markup for any hooked blocks appended to it. 1549 */ 1550 return function ( &$block, &$parent_block = null, $next = null ) use ( $hooked_blocks, $context, $callback ) { 1551 $markup = call_user_func_array( 1552 $callback, 1553 array( &$block, 'after', $hooked_blocks, $context ) 1554 ); 1555 1556 if ( $parent_block && ! $next ) { 1557 // Candidate for last-child insertion. 1558 $markup .= call_user_func_array( 1559 $callback, 1560 array( &$parent_block, 'last_child', $hooked_blocks, $context ) 1561 ); 1562 } 1563 1564 return $markup; 1565 }; 1566 } 1567 1568 /** 1569 * Given an array of attributes, returns a string in the serialized attributes 1570 * format prepared for post content. 1571 * 1572 * The serialized result is a JSON-encoded string, with unicode escape sequence 1573 * substitution for characters which might otherwise interfere with embedding 1574 * the result in an HTML comment. 1575 * 1576 * This function must produce output that remains in sync with the output of 1577 * the serializeAttributes JavaScript function in the block editor in order 1578 * to ensure consistent operation between PHP and JavaScript. 1579 * 1580 * @since 5.3.1 1581 * 1582 * @param array $block_attributes Attributes object. 1583 * @return string Serialized attributes. 1584 */ 1585 function serialize_block_attributes( $block_attributes ) { 1586 $encoded_attributes = wp_json_encode( $block_attributes, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE ); 1587 $encoded_attributes = preg_replace( '/--/', '\\u002d\\u002d', $encoded_attributes ); 1588 $encoded_attributes = preg_replace( '/</', '\\u003c', $encoded_attributes ); 1589 $encoded_attributes = preg_replace( '/>/', '\\u003e', $encoded_attributes ); 1590 $encoded_attributes = preg_replace( '/&/', '\\u0026', $encoded_attributes ); 1591 // Regex: /\\"/ 1592 $encoded_attributes = preg_replace( '/\\\\"/', '\\u0022', $encoded_attributes ); 1593 1594 return $encoded_attributes; 1595 } 1596 1597 /** 1598 * Returns the block name to use for serialization. This will remove the default 1599 * "core/" namespace from a block name. 1600 * 1601 * @since 5.3.1 1602 * 1603 * @param string|null $block_name Optional. Original block name. Null if the block name is unknown, 1604 * e.g. Classic blocks have their name set to null. Default null. 1605 * @return string Block name to use for serialization. 1606 */ 1607 function strip_core_block_namespace( $block_name = null ) { 1608 if ( is_string( $block_name ) && str_starts_with( $block_name, 'core/' ) ) { 1609 return substr( $block_name, 5 ); 1610 } 1611 1612 return $block_name; 1613 } 1614 1615 /** 1616 * Returns the content of a block, including comment delimiters. 1617 * 1618 * @since 5.3.1 1619 * 1620 * @param string|null $block_name Block name. Null if the block name is unknown, 1621 * e.g. Classic blocks have their name set to null. 1622 * @param array $block_attributes Block attributes. 1623 * @param string $block_content Block save content. 1624 * @return string Comment-delimited block content. 1625 */ 1626 function get_comment_delimited_block_content( $block_name, $block_attributes, $block_content ) { 1627 if ( is_null( $block_name ) ) { 1628 return $block_content; 1629 } 1630 1631 $serialized_block_name = strip_core_block_namespace( $block_name ); 1632 $serialized_attributes = empty( $block_attributes ) ? '' : serialize_block_attributes( $block_attributes ) . ' '; 1633 1634 if ( empty( $block_content ) ) { 1635 return sprintf( '<!-- wp:%s %s/-->', $serialized_block_name, $serialized_attributes ); 1636 } 1637 1638 return sprintf( 1639 '<!-- wp:%s %s-->%s<!-- /wp:%s -->', 1640 $serialized_block_name, 1641 $serialized_attributes, 1642 $block_content, 1643 $serialized_block_name 1644 ); 1645 } 1646 1647 /** 1648 * Returns the content of a block, including comment delimiters, serializing all 1649 * attributes from the given parsed block. 1650 * 1651 * This should be used when preparing a block to be saved to post content. 1652 * Prefer `render_block` when preparing a block for display. Unlike 1653 * `render_block`, this does not evaluate a block's `render_callback`, and will 1654 * instead preserve the markup as parsed. 1655 * 1656 * @since 5.3.1 1657 * 1658 * @param array $block { 1659 * An associative array of a single parsed block object. See WP_Block_Parser_Block. 1660 * 1661 * @type string $blockName Name of block. 1662 * @type array $attrs Attributes from block comment delimiters. 1663 * @type array[] $innerBlocks List of inner blocks. An array of arrays that 1664 * have the same structure as this one. 1665 * @type string $innerHTML HTML from inside block comment delimiters. 1666 * @type array $innerContent List of string fragments and null markers where 1667 * inner blocks were found. 1668 * } 1669 * @return string String of rendered HTML. 1670 */ 1671 function serialize_block( $block ) { 1672 $block_content = ''; 1673 1674 $index = 0; 1675 foreach ( $block['innerContent'] as $chunk ) { 1676 $block_content .= is_string( $chunk ) ? $chunk : serialize_block( $block['innerBlocks'][ $index++ ] ); 1677 } 1678 1679 if ( ! is_array( $block['attrs'] ) ) { 1680 $block['attrs'] = array(); 1681 } 1682 1683 return get_comment_delimited_block_content( 1684 $block['blockName'], 1685 $block['attrs'], 1686 $block_content 1687 ); 1688 } 1689 1690 /** 1691 * Returns a joined string of the aggregate serialization of the given 1692 * parsed blocks. 1693 * 1694 * @since 5.3.1 1695 * 1696 * @param array[] $blocks { 1697 * Array of block structures. 1698 * 1699 * @type array ...$0 { 1700 * An associative array of a single parsed block object. See WP_Block_Parser_Block. 1701 * 1702 * @type string $blockName Name of block. 1703 * @type array $attrs Attributes from block comment delimiters. 1704 * @type array[] $innerBlocks List of inner blocks. An array of arrays that 1705 * have the same structure as this one. 1706 * @type string $innerHTML HTML from inside block comment delimiters. 1707 * @type array $innerContent List of string fragments and null markers where 1708 * inner blocks were found. 1709 * } 1710 * } 1711 * @return string String of rendered HTML. 1712 */ 1713 function serialize_blocks( $blocks ) { 1714 return implode( '', array_map( 'serialize_block', $blocks ) ); 1715 } 1716 1717 /** 1718 * Traverses a parsed block tree and applies callbacks before and after serializing it. 1719 * 1720 * Recursively traverses the block and its inner blocks and applies the two callbacks provided as 1721 * arguments, the first one before serializing the block, and the second one after serializing it. 1722 * If either callback returns a string value, it will be prepended and appended to the serialized 1723 * block markup, respectively. 1724 * 1725 * The callbacks will receive a reference to the current block as their first argument, so that they 1726 * can also modify it, and the current block's parent block as second argument. Finally, the 1727 * `$pre_callback` receives the previous block, whereas the `$post_callback` receives 1728 * the next block as third argument. 1729 * 1730 * Serialized blocks are returned including comment delimiters, and with all attributes serialized. 1731 * 1732 * This function should be used when there is a need to modify the saved block, or to inject markup 1733 * into the return value. Prefer `serialize_block` when preparing a block to be saved to post content. 1734 * 1735 * This function is meant for internal use only. 1736 * 1737 * @since 6.4.0 1738 * @access private 1739 * 1740 * @see serialize_block() 1741 * 1742 * @param array $block An associative array of a single parsed block object. See WP_Block_Parser_Block. 1743 * @param callable $pre_callback Callback to run on each block in the tree before it is traversed and serialized. 1744 * It is called with the following arguments: &$block, $parent_block, $previous_block. 1745 * Its string return value will be prepended to the serialized block markup. 1746 * @param callable $post_callback Callback to run on each block in the tree after it is traversed and serialized. 1747 * It is called with the following arguments: &$block, $parent_block, $next_block. 1748 * Its string return value will be appended to the serialized block markup. 1749 * @return string Serialized block markup. 1750 */ 1751 function traverse_and_serialize_block( $block, $pre_callback = null, $post_callback = null ) { 1752 $block_content = ''; 1753 $block_index = 0; 1754 1755 foreach ( $block['innerContent'] as $chunk ) { 1756 if ( is_string( $chunk ) ) { 1757 $block_content .= $chunk; 1758 } else { 1759 $inner_block = $block['innerBlocks'][ $block_index ]; 1760 1761 if ( is_callable( $pre_callback ) ) { 1762 $prev = 0 === $block_index 1763 ? null 1764 : $block['innerBlocks'][ $block_index - 1 ]; 1765 1766 $block_content .= call_user_func_array( 1767 $pre_callback, 1768 array( &$inner_block, &$block, $prev ) 1769 ); 1770 } 1771 1772 if ( is_callable( $post_callback ) ) { 1773 $next = count( $block['innerBlocks'] ) - 1 === $block_index 1774 ? null 1775 : $block['innerBlocks'][ $block_index + 1 ]; 1776 1777 $post_markup = call_user_func_array( 1778 $post_callback, 1779 array( &$inner_block, &$block, $next ) 1780 ); 1781 } 1782 1783 $block_content .= traverse_and_serialize_block( $inner_block, $pre_callback, $post_callback ); 1784 $block_content .= isset( $post_markup ) ? $post_markup : ''; 1785 1786 ++$block_index; 1787 } 1788 } 1789 1790 if ( ! is_array( $block['attrs'] ) ) { 1791 $block['attrs'] = array(); 1792 } 1793 1794 return get_comment_delimited_block_content( 1795 $block['blockName'], 1796 $block['attrs'], 1797 $block_content 1798 ); 1799 } 1800 1801 /** 1802 * Replaces patterns in a block tree with their content. 1803 * 1804 * @since 6.6.0 1805 * 1806 * @param array $blocks An array blocks. 1807 * 1808 * @return array An array of blocks with patterns replaced by their content. 1809 */ 1810 function resolve_pattern_blocks( $blocks ) { 1811 static $inner_content; 1812 // Keep track of seen references to avoid infinite loops. 1813 static $seen_refs = array(); 1814 $i = 0; 1815 while ( $i < count( $blocks ) ) { 1816 if ( 'core/pattern' === $blocks[ $i ]['blockName'] ) { 1817 $attrs = $blocks[ $i ]['attrs']; 1818 1819 if ( empty( $attrs['slug'] ) ) { 1820 ++$i; 1821 continue; 1822 } 1823 1824 $slug = $attrs['slug']; 1825 1826 if ( isset( $seen_refs[ $slug ] ) ) { 1827 // Skip recursive patterns. 1828 array_splice( $blocks, $i, 1 ); 1829 continue; 1830 } 1831 1832 $registry = WP_Block_Patterns_Registry::get_instance(); 1833 $pattern = $registry->get_registered( $slug ); 1834 1835 // Skip unknown patterns. 1836 if ( ! $pattern ) { 1837 ++$i; 1838 continue; 1839 } 1840 1841 $blocks_to_insert = parse_blocks( $pattern['content'] ); 1842 $seen_refs[ $slug ] = true; 1843 $prev_inner_content = $inner_content; 1844 $inner_content = null; 1845 $blocks_to_insert = resolve_pattern_blocks( $blocks_to_insert ); 1846 $inner_content = $prev_inner_content; 1847 unset( $seen_refs[ $slug ] ); 1848 array_splice( $blocks, $i, 1, $blocks_to_insert ); 1849 1850 // If we have inner content, we need to insert nulls in the 1851 // inner content array, otherwise serialize_blocks will skip 1852 // blocks. 1853 if ( $inner_content ) { 1854 $null_indices = array_keys( $inner_content, null, true ); 1855 $content_index = $null_indices[ $i ]; 1856 $nulls = array_fill( 0, count( $blocks_to_insert ), null ); 1857 array_splice( $inner_content, $content_index, 1, $nulls ); 1858 } 1859 1860 // Skip inserted blocks. 1861 $i += count( $blocks_to_insert ); 1862 } else { 1863 if ( ! empty( $blocks[ $i ]['innerBlocks'] ) ) { 1864 $prev_inner_content = $inner_content; 1865 $inner_content = $blocks[ $i ]['innerContent']; 1866 $blocks[ $i ]['innerBlocks'] = resolve_pattern_blocks( 1867 $blocks[ $i ]['innerBlocks'] 1868 ); 1869 $blocks[ $i ]['innerContent'] = $inner_content; 1870 $inner_content = $prev_inner_content; 1871 } 1872 ++$i; 1873 } 1874 } 1875 return $blocks; 1876 } 1877 1878 /** 1879 * Given an array of parsed block trees, applies callbacks before and after serializing them and 1880 * returns their concatenated output. 1881 * 1882 * Recursively traverses the blocks and their inner blocks and applies the two callbacks provided as 1883 * arguments, the first one before serializing a block, and the second one after serializing. 1884 * If either callback returns a string value, it will be prepended and appended to the serialized 1885 * block markup, respectively. 1886 * 1887 * The callbacks will receive a reference to the current block as their first argument, so that they 1888 * can also modify it, and the current block's parent block as second argument. Finally, the 1889 * `$pre_callback` receives the previous block, whereas the `$post_callback` receives 1890 * the next block as third argument. 1891 * 1892 * Serialized blocks are returned including comment delimiters, and with all attributes serialized. 1893 * 1894 * This function should be used when there is a need to modify the saved blocks, or to inject markup 1895 * into the return value. Prefer `serialize_blocks` when preparing blocks to be saved to post content. 1896 * 1897 * This function is meant for internal use only. 1898 * 1899 * @since 6.4.0 1900 * @access private 1901 * 1902 * @see serialize_blocks() 1903 * 1904 * @param array[] $blocks An array of parsed blocks. See WP_Block_Parser_Block. 1905 * @param callable $pre_callback Callback to run on each block in the tree before it is traversed and serialized. 1906 * It is called with the following arguments: &$block, $parent_block, $previous_block. 1907 * Its string return value will be prepended to the serialized block markup. 1908 * @param callable $post_callback Callback to run on each block in the tree after it is traversed and serialized. 1909 * It is called with the following arguments: &$block, $parent_block, $next_block. 1910 * Its string return value will be appended to the serialized block markup. 1911 * @return string Serialized block markup. 1912 */ 1913 function traverse_and_serialize_blocks( $blocks, $pre_callback = null, $post_callback = null ) { 1914 $result = ''; 1915 $parent_block = null; // At the top level, there is no parent block to pass to the callbacks; yet the callbacks expect a reference. 1916 1917 $pre_callback_is_callable = is_callable( $pre_callback ); 1918 $post_callback_is_callable = is_callable( $post_callback ); 1919 1920 foreach ( $blocks as $index => $block ) { 1921 if ( $pre_callback_is_callable ) { 1922 $prev = 0 === $index 1923 ? null 1924 : $blocks[ $index - 1 ]; 1925 1926 $result .= call_user_func_array( 1927 $pre_callback, 1928 array( &$block, &$parent_block, $prev ) 1929 ); 1930 } 1931 1932 if ( $post_callback_is_callable ) { 1933 $next = count( $blocks ) - 1 === $index 1934 ? null 1935 : $blocks[ $index + 1 ]; 1936 1937 $post_markup = call_user_func_array( 1938 $post_callback, 1939 array( &$block, &$parent_block, $next ) 1940 ); 1941 } 1942 1943 $result .= traverse_and_serialize_block( $block, $pre_callback, $post_callback ); 1944 $result .= isset( $post_markup ) ? $post_markup : ''; 1945 } 1946 1947 return $result; 1948 } 1949 1950 /** 1951 * Filters and sanitizes block content to remove non-allowable HTML 1952 * from parsed block attribute values. 1953 * 1954 * @since 5.3.1 1955 * 1956 * @param string $text Text that may contain block content. 1957 * @param array[]|string $allowed_html Optional. An array of allowed HTML elements and attributes, 1958 * or a context name such as 'post'. See wp_kses_allowed_html() 1959 * for the list of accepted context names. Default 'post'. 1960 * @param string[] $allowed_protocols Optional. Array of allowed URL protocols. 1961 * Defaults to the result of wp_allowed_protocols(). 1962 * @return string The filtered and sanitized content result. 1963 */ 1964 function filter_block_content( $text, $allowed_html = 'post', $allowed_protocols = array() ) { 1965 $result = ''; 1966 1967 if ( str_contains( $text, '<!--' ) && str_contains( $text, '--->' ) ) { 1968 $text = preg_replace_callback( '%<!--(.*?)--->%', '_filter_block_content_callback', $text ); 1969 } 1970 1971 $blocks = parse_blocks( $text ); 1972 foreach ( $blocks as $block ) { 1973 $block = filter_block_kses( $block, $allowed_html, $allowed_protocols ); 1974 $result .= serialize_block( $block ); 1975 } 1976 1977 return $result; 1978 } 1979 1980 /** 1981 * Callback used for regular expression replacement in filter_block_content(). 1982 * 1983 * @since 6.2.1 1984 * @access private 1985 * 1986 * @param array $matches Array of preg_replace_callback matches. 1987 * @return string Replacement string. 1988 */ 1989 function _filter_block_content_callback( $matches ) { 1990 return '<!--' . rtrim( $matches[1], '-' ) . '-->'; 1991 } 1992 1993 /** 1994 * Filters and sanitizes a parsed block to remove non-allowable HTML 1995 * from block attribute values. 1996 * 1997 * @since 5.3.1 1998 * 1999 * @param WP_Block_Parser_Block $block The parsed block object. 2000 * @param array[]|string $allowed_html An array of allowed HTML elements and attributes, 2001 * or a context name such as 'post'. See wp_kses_allowed_html() 2002 * for the list of accepted context names. 2003 * @param string[] $allowed_protocols Optional. Array of allowed URL protocols. 2004 * Defaults to the result of wp_allowed_protocols(). 2005 * @return array The filtered and sanitized block object result. 2006 */ 2007 function filter_block_kses( $block, $allowed_html, $allowed_protocols = array() ) { 2008 $block['attrs'] = filter_block_kses_value( $block['attrs'], $allowed_html, $allowed_protocols, $block ); 2009 2010 if ( is_array( $block['innerBlocks'] ) ) { 2011 foreach ( $block['innerBlocks'] as $i => $inner_block ) { 2012 $block['innerBlocks'][ $i ] = filter_block_kses( $inner_block, $allowed_html, $allowed_protocols ); 2013 } 2014 } 2015 2016 return $block; 2017 } 2018 2019 /** 2020 * Filters and sanitizes a parsed block attribute value to remove 2021 * non-allowable HTML. 2022 * 2023 * @since 5.3.1 2024 * @since 6.5.5 Added the `$block_context` parameter. 2025 * 2026 * @param string[]|string $value The attribute value to filter. 2027 * @param array[]|string $allowed_html An array of allowed HTML elements and attributes, 2028 * or a context name such as 'post'. See wp_kses_allowed_html() 2029 * for the list of accepted context names. 2030 * @param string[] $allowed_protocols Optional. Array of allowed URL protocols. 2031 * Defaults to the result of wp_allowed_protocols(). 2032 * @param array $block_context Optional. The block the attribute belongs to, in parsed block array format. 2033 * @return string[]|string The filtered and sanitized result. 2034 */ 2035 function filter_block_kses_value( $value, $allowed_html, $allowed_protocols = array(), $block_context = null ) { 2036 if ( is_array( $value ) ) { 2037 foreach ( $value as $key => $inner_value ) { 2038 $filtered_key = filter_block_kses_value( $key, $allowed_html, $allowed_protocols, $block_context ); 2039 $filtered_value = filter_block_kses_value( $inner_value, $allowed_html, $allowed_protocols, $block_context ); 2040 2041 if ( isset( $block_context['blockName'] ) && 'core/template-part' === $block_context['blockName'] ) { 2042 $filtered_value = filter_block_core_template_part_attributes( $filtered_value, $filtered_key, $allowed_html ); 2043 } 2044 if ( $filtered_key !== $key ) { 2045 unset( $value[ $key ] ); 2046 } 2047 2048 $value[ $filtered_key ] = $filtered_value; 2049 } 2050 } elseif ( is_string( $value ) ) { 2051 return wp_kses( $value, $allowed_html, $allowed_protocols ); 2052 } 2053 2054 return $value; 2055 } 2056 2057 /** 2058 * Sanitizes the value of the Template Part block's `tagName` attribute. 2059 * 2060 * @since 6.5.5 2061 * 2062 * @param string $attribute_value The attribute value to filter. 2063 * @param string $attribute_name The attribute name. 2064 * @param array[]|string $allowed_html An array of allowed HTML elements and attributes, 2065 * or a context name such as 'post'. See wp_kses_allowed_html() 2066 * for the list of accepted context names. 2067 * @return string The sanitized attribute value. 2068 */ 2069 function filter_block_core_template_part_attributes( $attribute_value, $attribute_name, $allowed_html ) { 2070 if ( empty( $attribute_value ) || 'tagName' !== $attribute_name ) { 2071 return $attribute_value; 2072 } 2073 if ( ! is_array( $allowed_html ) ) { 2074 $allowed_html = wp_kses_allowed_html( $allowed_html ); 2075 } 2076 return isset( $allowed_html[ $attribute_value ] ) ? $attribute_value : ''; 2077 } 2078 2079 /** 2080 * Parses blocks out of a content string, and renders those appropriate for the excerpt. 2081 * 2082 * As the excerpt should be a small string of text relevant to the full post content, 2083 * this function renders the blocks that are most likely to contain such text. 2084 * 2085 * @since 5.0.0 2086 * 2087 * @param string $content The content to parse. 2088 * @return string The parsed and filtered content. 2089 */ 2090 function excerpt_remove_blocks( $content ) { 2091 if ( ! has_blocks( $content ) ) { 2092 return $content; 2093 } 2094 2095 $allowed_inner_blocks = array( 2096 // Classic blocks have their blockName set to null. 2097 null, 2098 'core/freeform', 2099 'core/heading', 2100 'core/html', 2101 'core/list', 2102 'core/media-text', 2103 'core/paragraph', 2104 'core/preformatted', 2105 'core/pullquote', 2106 'core/quote', 2107 'core/table', 2108 'core/verse', 2109 ); 2110 2111 $allowed_wrapper_blocks = array( 2112 'core/columns', 2113 'core/column', 2114 'core/group', 2115 ); 2116 2117 /** 2118 * Filters the list of blocks that can be used as wrapper blocks, allowing 2119 * excerpts to be generated from the `innerBlocks` of these wrappers. 2120 * 2121 * @since 5.8.0 2122 * 2123 * @param string[] $allowed_wrapper_blocks The list of names of allowed wrapper blocks. 2124 */ 2125 $allowed_wrapper_blocks = apply_filters( 'excerpt_allowed_wrapper_blocks', $allowed_wrapper_blocks ); 2126 2127 $allowed_blocks = array_merge( $allowed_inner_blocks, $allowed_wrapper_blocks ); 2128 2129 /** 2130 * Filters the list of blocks that can contribute to the excerpt. 2131 * 2132 * If a dynamic block is added to this list, it must not generate another 2133 * excerpt, as this will cause an infinite loop to occur. 2134 * 2135 * @since 5.0.0 2136 * 2137 * @param string[] $allowed_blocks The list of names of allowed blocks. 2138 */ 2139 $allowed_blocks = apply_filters( 'excerpt_allowed_blocks', $allowed_blocks ); 2140 $blocks = parse_blocks( $content ); 2141 $output = ''; 2142 2143 foreach ( $blocks as $block ) { 2144 if ( in_array( $block['blockName'], $allowed_blocks, true ) ) { 2145 if ( ! empty( $block['innerBlocks'] ) ) { 2146 if ( in_array( $block['blockName'], $allowed_wrapper_blocks, true ) ) { 2147 $output .= _excerpt_render_inner_blocks( $block, $allowed_blocks ); 2148 continue; 2149 } 2150 2151 // Skip the block if it has disallowed or nested inner blocks. 2152 foreach ( $block['innerBlocks'] as $inner_block ) { 2153 if ( 2154 ! in_array( $inner_block['blockName'], $allowed_inner_blocks, true ) || 2155 ! empty( $inner_block['innerBlocks'] ) 2156 ) { 2157 continue 2; 2158 } 2159 } 2160 } 2161 2162 $output .= render_block( $block ); 2163 } 2164 } 2165 2166 return $output; 2167 } 2168 2169 /** 2170 * Parses footnotes markup out of a content string, 2171 * and renders those appropriate for the excerpt. 2172 * 2173 * @since 6.3.0 2174 * 2175 * @param string $content The content to parse. 2176 * @return string The parsed and filtered content. 2177 */ 2178 function excerpt_remove_footnotes( $content ) { 2179 if ( ! str_contains( $content, 'data-fn=' ) ) { 2180 return $content; 2181 } 2182 2183 return preg_replace( 2184 '_<sup data-fn="[^"]+" class="[^"]+">\s*<a href="[^"]+" id="[^"]+">\d+</a>\s*</sup>_', 2185 '', 2186 $content 2187 ); 2188 } 2189 2190 /** 2191 * Renders inner blocks from the allowed wrapper blocks 2192 * for generating an excerpt. 2193 * 2194 * @since 5.8.0 2195 * @access private 2196 * 2197 * @param array $parsed_block The parsed block. 2198 * @param array $allowed_blocks The list of allowed inner blocks. 2199 * @return string The rendered inner blocks. 2200 */ 2201 function _excerpt_render_inner_blocks( $parsed_block, $allowed_blocks ) { 2202 $output = ''; 2203 2204 foreach ( $parsed_block['innerBlocks'] as $inner_block ) { 2205 if ( ! in_array( $inner_block['blockName'], $allowed_blocks, true ) ) { 2206 continue; 2207 } 2208 2209 if ( empty( $inner_block['innerBlocks'] ) ) { 2210 $output .= render_block( $inner_block ); 2211 } else { 2212 $output .= _excerpt_render_inner_blocks( $inner_block, $allowed_blocks ); 2213 } 2214 } 2215 2216 return $output; 2217 } 2218 2219 /** 2220 * Renders a single block into a HTML string. 2221 * 2222 * @since 5.0.0 2223 * 2224 * @global WP_Post $post The post to edit. 2225 * 2226 * @param array $parsed_block { 2227 * An associative array of the block being rendered. See WP_Block_Parser_Block. 2228 * 2229 * @type string $blockName Name of block. 2230 * @type array $attrs Attributes from block comment delimiters. 2231 * @type array[] $innerBlocks List of inner blocks. An array of arrays that 2232 * have the same structure as this one. 2233 * @type string $innerHTML HTML from inside block comment delimiters. 2234 * @type array $innerContent List of string fragments and null markers where 2235 * inner blocks were found. 2236 * } 2237 * @return string String of rendered HTML. 2238 */ 2239 function render_block( $parsed_block ) { 2240 global $post; 2241 $parent_block = null; 2242 2243 /** 2244 * Allows render_block() to be short-circuited, by returning a non-null value. 2245 * 2246 * @since 5.1.0 2247 * @since 5.9.0 The `$parent_block` parameter was added. 2248 * 2249 * @param string|null $pre_render The pre-rendered content. Default null. 2250 * @param array $parsed_block { 2251 * An associative array of the block being rendered. See WP_Block_Parser_Block. 2252 * 2253 * @type string $blockName Name of block. 2254 * @type array $attrs Attributes from block comment delimiters. 2255 * @type array[] $innerBlocks List of inner blocks. An array of arrays that 2256 * have the same structure as this one. 2257 * @type string $innerHTML HTML from inside block comment delimiters. 2258 * @type array $innerContent List of string fragments and null markers where 2259 * inner blocks were found. 2260 * } 2261 * @param WP_Block|null $parent_block If this is a nested block, a reference to the parent block. 2262 */ 2263 $pre_render = apply_filters( 'pre_render_block', null, $parsed_block, $parent_block ); 2264 if ( ! is_null( $pre_render ) ) { 2265 return $pre_render; 2266 } 2267 2268 $source_block = $parsed_block; 2269 2270 /** 2271 * Filters the block being rendered in render_block(), before it's processed. 2272 * 2273 * @since 5.1.0 2274 * @since 5.9.0 The `$parent_block` parameter was added. 2275 * 2276 * @param array $parsed_block { 2277 * An associative array of the block being rendered. See WP_Block_Parser_Block. 2278 * 2279 * @type string $blockName Name of block. 2280 * @type array $attrs Attributes from block comment delimiters. 2281 * @type array[] $innerBlocks List of inner blocks. An array of arrays that 2282 * have the same structure as this one. 2283 * @type string $innerHTML HTML from inside block comment delimiters. 2284 * @type array $innerContent List of string fragments and null markers where 2285 * inner blocks were found. 2286 * } 2287 * @param array $source_block { 2288 * An un-modified copy of `$parsed_block`, as it appeared in the source content. 2289 * See WP_Block_Parser_Block. 2290 * 2291 * @type string $blockName Name of block. 2292 * @type array $attrs Attributes from block comment delimiters. 2293 * @type array[] $innerBlocks List of inner blocks. An array of arrays that 2294 * have the same structure as this one. 2295 * @type string $innerHTML HTML from inside block comment delimiters. 2296 * @type array $innerContent List of string fragments and null markers where 2297 * inner blocks were found. 2298 * } 2299 * @param WP_Block|null $parent_block If this is a nested block, a reference to the parent block. 2300 */ 2301 $parsed_block = apply_filters( 'render_block_data', $parsed_block, $source_block, $parent_block ); 2302 2303 $context = array(); 2304 2305 if ( $post instanceof WP_Post ) { 2306 $context['postId'] = $post->ID; 2307 2308 /* 2309 * The `postType` context is largely unnecessary server-side, since the ID 2310 * is usually sufficient on its own. That being said, since a block's 2311 * manifest is expected to be shared between the server and the client, 2312 * it should be included to consistently fulfill the expectation. 2313 */ 2314 $context['postType'] = $post->post_type; 2315 } 2316 2317 /** 2318 * Filters the default context provided to a rendered block. 2319 * 2320 * @since 5.5.0 2321 * @since 5.9.0 The `$parent_block` parameter was added. 2322 * 2323 * @param array $context Default context. 2324 * @param array $parsed_block { 2325 * An associative array of the block being rendered. See WP_Block_Parser_Block. 2326 * 2327 * @type string $blockName Name of block. 2328 * @type array $attrs Attributes from block comment delimiters. 2329 * @type array[] $innerBlocks List of inner blocks. An array of arrays that 2330 * have the same structure as this one. 2331 * @type string $innerHTML HTML from inside block comment delimiters. 2332 * @type array $innerContent List of string fragments and null markers where 2333 * inner blocks were found. 2334 * } 2335 * @param WP_Block|null $parent_block If this is a nested block, a reference to the parent block. 2336 */ 2337 $context = apply_filters( 'render_block_context', $context, $parsed_block, $parent_block ); 2338 2339 $block = new WP_Block( $parsed_block, $context ); 2340 2341 return $block->render(); 2342 } 2343 2344 /** 2345 * Parses blocks out of a content string. 2346 * 2347 * @since 5.0.0 2348 * 2349 * @param string $content Post content. 2350 * @return array[] { 2351 * Array of block structures. 2352 * 2353 * @type array ...$0 { 2354 * An associative array of a single parsed block object. See WP_Block_Parser_Block. 2355 * 2356 * @type string $blockName Name of block. 2357 * @type array $attrs Attributes from block comment delimiters. 2358 * @type array[] $innerBlocks List of inner blocks. An array of arrays that 2359 * have the same structure as this one. 2360 * @type string $innerHTML HTML from inside block comment delimiters. 2361 * @type array $innerContent List of string fragments and null markers where 2362 * inner blocks were found. 2363 * } 2364 * } 2365 */ 2366 function parse_blocks( $content ) { 2367 /** 2368 * Filter to allow plugins to replace the server-side block parser. 2369 * 2370 * @since 5.0.0 2371 * 2372 * @param string $parser_class Name of block parser class. 2373 */ 2374 $parser_class = apply_filters( 'block_parser_class', 'WP_Block_Parser' ); 2375 2376 $parser = new $parser_class(); 2377 return $parser->parse( $content ); 2378 } 2379 2380 /** 2381 * Parses dynamic blocks out of `post_content` and re-renders them. 2382 * 2383 * @since 5.0.0 2384 * 2385 * @param string $content Post content. 2386 * @return string Updated post content. 2387 */ 2388 function do_blocks( $content ) { 2389 $blocks = parse_blocks( $content ); 2390 $output = ''; 2391 2392 foreach ( $blocks as $block ) { 2393 $output .= render_block( $block ); 2394 } 2395 2396 // If there are blocks in this content, we shouldn't run wpautop() on it later. 2397 $priority = has_filter( 'the_content', 'wpautop' ); 2398 if ( false !== $priority && doing_filter( 'the_content' ) && has_blocks( $content ) ) { 2399 remove_filter( 'the_content', 'wpautop', $priority ); 2400 add_filter( 'the_content', '_restore_wpautop_hook', $priority + 1 ); 2401 } 2402 2403 return $output; 2404 } 2405 2406 /** 2407 * If do_blocks() needs to remove wpautop() from the `the_content` filter, this re-adds it afterwards, 2408 * for subsequent `the_content` usage. 2409 * 2410 * @since 5.0.0 2411 * @access private 2412 * 2413 * @param string $content The post content running through this filter. 2414 * @return string The unmodified content. 2415 */ 2416 function _restore_wpautop_hook( $content ) { 2417 $current_priority = has_filter( 'the_content', '_restore_wpautop_hook' ); 2418 2419 add_filter( 'the_content', 'wpautop', $current_priority - 1 ); 2420 remove_filter( 'the_content', '_restore_wpautop_hook', $current_priority ); 2421 2422 return $content; 2423 } 2424 2425 /** 2426 * Returns the current version of the block format that the content string is using. 2427 * 2428 * If the string doesn't contain blocks, it returns 0. 2429 * 2430 * @since 5.0.0 2431 * 2432 * @param string $content Content to test. 2433 * @return int The block format version is 1 if the content contains one or more blocks, 0 otherwise. 2434 */ 2435 function block_version( $content ) { 2436 return has_blocks( $content ) ? 1 : 0; 2437 } 2438 2439 /** 2440 * Registers a new block style. 2441 * 2442 * @since 5.3.0 2443 * @since 6.6.0 Added support for registering styles for multiple block types. 2444 * 2445 * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/ 2446 * 2447 * @param string|string[] $block_name Block type name including namespace or array of namespaced block type names. 2448 * @param array $style_properties Array containing the properties of the style name, label, 2449 * style_handle (name of the stylesheet to be enqueued), 2450 * inline_style (string containing the CSS to be added), 2451 * style_data (theme.json-like array to generate CSS from). 2452 * See WP_Block_Styles_Registry::register(). 2453 * @return bool True if the block style was registered with success and false otherwise. 2454 */ 2455 function register_block_style( $block_name, $style_properties ) { 2456 return WP_Block_Styles_Registry::get_instance()->register( $block_name, $style_properties ); 2457 } 2458 2459 /** 2460 * Unregisters a block style. 2461 * 2462 * @since 5.3.0 2463 * 2464 * @param string $block_name Block type name including namespace. 2465 * @param string $block_style_name Block style name. 2466 * @return bool True if the block style was unregistered with success and false otherwise. 2467 */ 2468 function unregister_block_style( $block_name, $block_style_name ) { 2469 return WP_Block_Styles_Registry::get_instance()->unregister( $block_name, $block_style_name ); 2470 } 2471 2472 /** 2473 * Checks whether the current block type supports the feature requested. 2474 * 2475 * @since 5.8.0 2476 * @since 6.4.0 The `$feature` parameter now supports a string. 2477 * 2478 * @param WP_Block_Type $block_type Block type to check for support. 2479 * @param string|array $feature Feature slug, or path to a specific feature to check support for. 2480 * @param mixed $default_value Optional. Fallback value for feature support. Default false. 2481 * @return bool Whether the feature is supported. 2482 */ 2483 function block_has_support( $block_type, $feature, $default_value = false ) { 2484 $block_support = $default_value; 2485 if ( $block_type instanceof WP_Block_Type ) { 2486 if ( is_array( $feature ) && count( $feature ) === 1 ) { 2487 $feature = $feature[0]; 2488 } 2489 2490 if ( is_array( $feature ) ) { 2491 $block_support = _wp_array_get( $block_type->supports, $feature, $default_value ); 2492 } elseif ( isset( $block_type->supports[ $feature ] ) ) { 2493 $block_support = $block_type->supports[ $feature ]; 2494 } 2495 } 2496 2497 return true === $block_support || is_array( $block_support ); 2498 } 2499 2500 /** 2501 * Converts typography keys declared under `supports.*` to `supports.typography.*`. 2502 * 2503 * Displays a `_doing_it_wrong()` notice when a block using the older format is detected. 2504 * 2505 * @since 5.8.0 2506 * 2507 * @param array $metadata Metadata for registering a block type. 2508 * @return array Filtered metadata for registering a block type. 2509 */ 2510 function wp_migrate_old_typography_shape( $metadata ) { 2511 if ( ! isset( $metadata['supports'] ) ) { 2512 return $metadata; 2513 } 2514 2515 $typography_keys = array( 2516 '__experimentalFontFamily', 2517 '__experimentalFontStyle', 2518 '__experimentalFontWeight', 2519 '__experimentalLetterSpacing', 2520 '__experimentalTextDecoration', 2521 '__experimentalTextTransform', 2522 'fontSize', 2523 'lineHeight', 2524 ); 2525 2526 foreach ( $typography_keys as $typography_key ) { 2527 $support_for_key = isset( $metadata['supports'][ $typography_key ] ) ? $metadata['supports'][ $typography_key ] : null; 2528 2529 if ( null !== $support_for_key ) { 2530 _doing_it_wrong( 2531 'register_block_type_from_metadata()', 2532 sprintf( 2533 /* translators: 1: Block type, 2: Typography supports key, e.g: fontSize, lineHeight, etc. 3: block.json, 4: Old metadata key, 5: New metadata key. */ 2534 __( 'Block "%1$s" is declaring %2$s support in %3$s file under %4$s. %2$s support is now declared under %5$s.' ), 2535 $metadata['name'], 2536 "<code>$typography_key</code>", 2537 '<code>block.json</code>', 2538 "<code>supports.$typography_key</code>", 2539 "<code>supports.typography.$typography_key</code>" 2540 ), 2541 '5.8.0' 2542 ); 2543 2544 _wp_array_set( $metadata['supports'], array( 'typography', $typography_key ), $support_for_key ); 2545 unset( $metadata['supports'][ $typography_key ] ); 2546 } 2547 } 2548 2549 return $metadata; 2550 } 2551 2552 /** 2553 * Helper function that constructs a WP_Query args array from 2554 * a `Query` block properties. 2555 * 2556 * It's used in Query Loop, Query Pagination Numbers and Query Pagination Next blocks. 2557 * 2558 * @since 5.8.0 2559 * @since 6.1.0 Added `query_loop_block_query_vars` filter and `parents` support in query. 2560 * @since 6.7.0 Added support for the `format` property in query. 2561 * 2562 * @param WP_Block $block Block instance. 2563 * @param int $page Current query's page. 2564 * 2565 * @return array Returns the constructed WP_Query arguments. 2566 */ 2567 function build_query_vars_from_query_block( $block, $page ) { 2568 $query = array( 2569 'post_type' => 'post', 2570 'order' => 'DESC', 2571 'orderby' => 'date', 2572 'post__not_in' => array(), 2573 'tax_query' => array(), 2574 ); 2575 2576 if ( isset( $block->context['query'] ) ) { 2577 if ( ! empty( $block->context['query']['postType'] ) ) { 2578 $post_type_param = $block->context['query']['postType']; 2579 if ( is_post_type_viewable( $post_type_param ) ) { 2580 $query['post_type'] = $post_type_param; 2581 } 2582 } 2583 if ( isset( $block->context['query']['sticky'] ) && ! empty( $block->context['query']['sticky'] ) ) { 2584 $sticky = get_option( 'sticky_posts' ); 2585 if ( 'only' === $block->context['query']['sticky'] ) { 2586 /* 2587 * Passing an empty array to post__in will return have_posts() as true (and all posts will be returned). 2588 * Logic should be used before hand to determine if WP_Query should be used in the event that the array 2589 * being passed to post__in is empty. 2590 * 2591 * @see https://core.trac.wordpress.org/ticket/28099 2592 */ 2593 $query['post__in'] = ! empty( $sticky ) ? $sticky : array( 0 ); 2594 $query['ignore_sticky_posts'] = 1; 2595 } elseif ( 'exclude' === $block->context['query']['sticky'] ) { 2596 $query['post__not_in'] = array_merge( $query['post__not_in'], $sticky ); 2597 } elseif ( 'ignore' === $block->context['query']['sticky'] ) { 2598 $query['ignore_sticky_posts'] = 1; 2599 } 2600 } 2601 if ( ! empty( $block->context['query']['exclude'] ) ) { 2602 $excluded_post_ids = array_map( 'intval', $block->context['query']['exclude'] ); 2603 $excluded_post_ids = array_filter( $excluded_post_ids ); 2604 $query['post__not_in'] = array_merge( $query['post__not_in'], $excluded_post_ids ); 2605 } 2606 if ( 2607 isset( $block->context['query']['perPage'] ) && 2608 is_numeric( $block->context['query']['perPage'] ) 2609 ) { 2610 $per_page = absint( $block->context['query']['perPage'] ); 2611 $offset = 0; 2612 2613 if ( 2614 isset( $block->context['query']['offset'] ) && 2615 is_numeric( $block->context['query']['offset'] ) 2616 ) { 2617 $offset = absint( $block->context['query']['offset'] ); 2618 } 2619 2620 $query['offset'] = ( $per_page * ( $page - 1 ) ) + $offset; 2621 $query['posts_per_page'] = $per_page; 2622 } 2623 // Migrate `categoryIds` and `tagIds` to `tax_query` for backwards compatibility. 2624 if ( ! empty( $block->context['query']['categoryIds'] ) || ! empty( $block->context['query']['tagIds'] ) ) { 2625 $tax_query_back_compat = array(); 2626 if ( ! empty( $block->context['query']['categoryIds'] ) ) { 2627 $tax_query_back_compat[] = array( 2628 'taxonomy' => 'category', 2629 'terms' => array_filter( array_map( 'intval', $block->context['query']['categoryIds'] ) ), 2630 'include_children' => false, 2631 ); 2632 } 2633 if ( ! empty( $block->context['query']['tagIds'] ) ) { 2634 $tax_query_back_compat[] = array( 2635 'taxonomy' => 'post_tag', 2636 'terms' => array_filter( array_map( 'intval', $block->context['query']['tagIds'] ) ), 2637 'include_children' => false, 2638 ); 2639 } 2640 $query['tax_query'] = array_merge( $query['tax_query'], $tax_query_back_compat ); 2641 } 2642 if ( ! empty( $block->context['query']['taxQuery'] ) ) { 2643 $tax_query = array(); 2644 foreach ( $block->context['query']['taxQuery'] as $taxonomy => $terms ) { 2645 if ( is_taxonomy_viewable( $taxonomy ) && ! empty( $terms ) ) { 2646 $tax_query[] = array( 2647 'taxonomy' => $taxonomy, 2648 'terms' => array_filter( array_map( 'intval', $terms ) ), 2649 'include_children' => false, 2650 ); 2651 } 2652 } 2653 $query['tax_query'] = array_merge( $query['tax_query'], $tax_query ); 2654 } 2655 if ( ! empty( $block->context['query']['format'] ) && is_array( $block->context['query']['format'] ) ) { 2656 $formats = $block->context['query']['format']; 2657 /* 2658 * Validate that the format is either `standard` or a supported post format. 2659 * - First, add `standard` to the array of valid formats. 2660 * - Then, remove any invalid formats. 2661 */ 2662 $valid_formats = array_merge( array( 'standard' ), get_post_format_slugs() ); 2663 $formats = array_intersect( $formats, $valid_formats ); 2664 2665 /* 2666 * The relation needs to be set to `OR` since the request can contain 2667 * two separate conditions. The user may be querying for items that have 2668 * either the `standard` format or a specific format. 2669 */ 2670 $formats_query = array( 'relation' => 'OR' ); 2671 2672 /* 2673 * The default post format, `standard`, is not stored in the database. 2674 * If `standard` is part of the request, the query needs to exclude all post items that 2675 * have a format assigned. 2676 */ 2677 if ( in_array( 'standard', $formats, true ) ) { 2678 $formats_query[] = array( 2679 'taxonomy' => 'post_format', 2680 'field' => 'slug', 2681 'operator' => 'NOT EXISTS', 2682 ); 2683 // Remove the `standard` format, since it cannot be queried. 2684 unset( $formats[ array_search( 'standard', $formats, true ) ] ); 2685 } 2686 // Add any remaining formats to the formats query. 2687 if ( ! empty( $formats ) ) { 2688 // Add the `post-format-` prefix. 2689 $terms = array_map( 2690 static function ( $format ) { 2691 return "post-format-$format"; 2692 }, 2693 $formats 2694 ); 2695 $formats_query[] = array( 2696 'taxonomy' => 'post_format', 2697 'field' => 'slug', 2698 'terms' => $terms, 2699 'operator' => 'IN', 2700 ); 2701 } 2702 2703 /* 2704 * Add `$formats_query` to `$query`, as long as it contains more than one key: 2705 * If `$formats_query` only contains the initial `relation` key, there are no valid formats to query, 2706 * and the query should not be modified. 2707 */ 2708 if ( count( $formats_query ) > 1 ) { 2709 // Enable filtering by both post formats and other taxonomies by combining them with `AND`. 2710 if ( empty( $query['tax_query'] ) ) { 2711 $query['tax_query'] = $formats_query; 2712 } else { 2713 $query['tax_query'] = array( 2714 'relation' => 'AND', 2715 $query['tax_query'], 2716 $formats_query, 2717 ); 2718 } 2719 } 2720 } 2721 2722 if ( 2723 isset( $block->context['query']['order'] ) && 2724 in_array( strtoupper( $block->context['query']['order'] ), array( 'ASC', 'DESC' ), true ) 2725 ) { 2726 $query['order'] = strtoupper( $block->context['query']['order'] ); 2727 } 2728 if ( isset( $block->context['query']['orderBy'] ) ) { 2729 $query['orderby'] = $block->context['query']['orderBy']; 2730 } 2731 if ( 2732 isset( $block->context['query']['author'] ) 2733 ) { 2734 if ( is_array( $block->context['query']['author'] ) ) { 2735 $query['author__in'] = array_filter( array_map( 'intval', $block->context['query']['author'] ) ); 2736 } elseif ( is_string( $block->context['query']['author'] ) ) { 2737 $query['author__in'] = array_filter( array_map( 'intval', explode( ',', $block->context['query']['author'] ) ) ); 2738 } elseif ( is_int( $block->context['query']['author'] ) && $block->context['query']['author'] > 0 ) { 2739 $query['author'] = $block->context['query']['author']; 2740 } 2741 } 2742 if ( ! empty( $block->context['query']['search'] ) ) { 2743 $query['s'] = $block->context['query']['search']; 2744 } 2745 if ( ! empty( $block->context['query']['parents'] ) && is_post_type_hierarchical( $query['post_type'] ) ) { 2746 $query['post_parent__in'] = array_unique( array_map( 'intval', $block->context['query']['parents'] ) ); 2747 } 2748 } 2749 2750 /** 2751 * Filters the arguments which will be passed to `WP_Query` for the Query Loop Block. 2752 * 2753 * Anything to this filter should be compatible with the `WP_Query` API to form 2754 * the query context which will be passed down to the Query Loop Block's children. 2755 * This can help, for example, to include additional settings or meta queries not 2756 * directly supported by the core Query Loop Block, and extend its capabilities. 2757 * 2758 * Please note that this will only influence the query that will be rendered on the 2759 * front-end. The editor preview is not affected by this filter. Also, worth noting 2760 * that the editor preview uses the REST API, so, ideally, one should aim to provide 2761 * attributes which are also compatible with the REST API, in order to be able to 2762 * implement identical queries on both sides. 2763 * 2764 * @since 6.1.0 2765 * 2766 * @param array $query Array containing parameters for `WP_Query` as parsed by the block context. 2767 * @param WP_Block $block Block instance. 2768 * @param int $page Current query's page. 2769 */ 2770 return apply_filters( 'query_loop_block_query_vars', $query, $block, $page ); 2771 } 2772 2773 /** 2774 * Helper function that returns the proper pagination arrow HTML for 2775 * `QueryPaginationNext` and `QueryPaginationPrevious` blocks based 2776 * on the provided `paginationArrow` from `QueryPagination` context. 2777 * 2778 * It's used in QueryPaginationNext and QueryPaginationPrevious blocks. 2779 * 2780 * @since 5.9.0 2781 * 2782 * @param WP_Block $block Block instance. 2783 * @param bool $is_next Flag for handling `next/previous` blocks. 2784 * @return string|null The pagination arrow HTML or null if there is none. 2785 */ 2786 function get_query_pagination_arrow( $block, $is_next ) { 2787 $arrow_map = array( 2788 'none' => '', 2789 'arrow' => array( 2790 'next' => '→', 2791 'previous' => '←', 2792 ), 2793 'chevron' => array( 2794 'next' => '»', 2795 'previous' => '«', 2796 ), 2797 ); 2798 if ( ! empty( $block->context['paginationArrow'] ) && array_key_exists( $block->context['paginationArrow'], $arrow_map ) && ! empty( $arrow_map[ $block->context['paginationArrow'] ] ) ) { 2799 $pagination_type = $is_next ? 'next' : 'previous'; 2800 $arrow_attribute = $block->context['paginationArrow']; 2801 $arrow = $arrow_map[ $block->context['paginationArrow'] ][ $pagination_type ]; 2802 $arrow_classes = "wp-block-query-pagination-$pagination_type-arrow is-arrow-$arrow_attribute"; 2803 return "<span class='$arrow_classes' aria-hidden='true'>$arrow</span>"; 2804 } 2805 return null; 2806 } 2807 2808 /** 2809 * Helper function that constructs a comment query vars array from the passed 2810 * block properties. 2811 * 2812 * It's used with the Comment Query Loop inner blocks. 2813 * 2814 * @since 6.0.0 2815 * 2816 * @param WP_Block $block Block instance. 2817 * @return array Returns the comment query parameters to use with the 2818 * WP_Comment_Query constructor. 2819 */ 2820 function build_comment_query_vars_from_block( $block ) { 2821 2822 $comment_args = array( 2823 'orderby' => 'comment_date_gmt', 2824 'order' => 'ASC', 2825 'status' => 'approve', 2826 'no_found_rows' => false, 2827 ); 2828 2829 if ( is_user_logged_in() ) { 2830 $comment_args['include_unapproved'] = array( get_current_user_id() ); 2831 } else { 2832 $unapproved_email = wp_get_unapproved_comment_author_email(); 2833 2834 if ( $unapproved_email ) { 2835 $comment_args['include_unapproved'] = array( $unapproved_email ); 2836 } 2837 } 2838 2839 if ( ! empty( $block->context['postId'] ) ) { 2840 $comment_args['post_id'] = (int) $block->context['postId']; 2841 } 2842 2843 if ( get_option( 'thread_comments' ) ) { 2844 $comment_args['hierarchical'] = 'threaded'; 2845 } else { 2846 $comment_args['hierarchical'] = false; 2847 } 2848 2849 if ( get_option( 'page_comments' ) === '1' || get_option( 'page_comments' ) === true ) { 2850 $per_page = get_option( 'comments_per_page' ); 2851 $default_page = get_option( 'default_comments_page' ); 2852 if ( $per_page > 0 ) { 2853 $comment_args['number'] = $per_page; 2854 2855 $page = (int) get_query_var( 'cpage' ); 2856 if ( $page ) { 2857 $comment_args['paged'] = $page; 2858 } elseif ( 'oldest' === $default_page ) { 2859 $comment_args['paged'] = 1; 2860 } elseif ( 'newest' === $default_page ) { 2861 $max_num_pages = (int) ( new WP_Comment_Query( $comment_args ) )->max_num_pages; 2862 if ( 0 !== $max_num_pages ) { 2863 $comment_args['paged'] = $max_num_pages; 2864 } 2865 } 2866 } 2867 } 2868 2869 return $comment_args; 2870 } 2871 2872 /** 2873 * Helper function that returns the proper pagination arrow HTML for 2874 * `CommentsPaginationNext` and `CommentsPaginationPrevious` blocks based on the 2875 * provided `paginationArrow` from `CommentsPagination` context. 2876 * 2877 * It's used in CommentsPaginationNext and CommentsPaginationPrevious blocks. 2878 * 2879 * @since 6.0.0 2880 * 2881 * @param WP_Block $block Block instance. 2882 * @param string $pagination_type Optional. Type of the arrow we will be rendering. 2883 * Accepts 'next' or 'previous'. Default 'next'. 2884 * @return string|null The pagination arrow HTML or null if there is none. 2885 */ 2886 function get_comments_pagination_arrow( $block, $pagination_type = 'next' ) { 2887 $arrow_map = array( 2888 'none' => '', 2889 'arrow' => array( 2890 'next' => '→', 2891 'previous' => '←', 2892 ), 2893 'chevron' => array( 2894 'next' => '»', 2895 'previous' => '«', 2896 ), 2897 ); 2898 if ( ! empty( $block->context['comments/paginationArrow'] ) && ! empty( $arrow_map[ $block->context['comments/paginationArrow'] ][ $pagination_type ] ) ) { 2899 $arrow_attribute = $block->context['comments/paginationArrow']; 2900 $arrow = $arrow_map[ $block->context['comments/paginationArrow'] ][ $pagination_type ]; 2901 $arrow_classes = "wp-block-comments-pagination-$pagination_type-arrow is-arrow-$arrow_attribute"; 2902 return "<span class='$arrow_classes' aria-hidden='true'>$arrow</span>"; 2903 } 2904 return null; 2905 } 2906 2907 /** 2908 * Strips all HTML from the content of footnotes, and sanitizes the ID. 2909 * 2910 * This function expects slashed data on the footnotes content. 2911 * 2912 * @access private 2913 * @since 6.3.2 2914 * 2915 * @param string $footnotes JSON-encoded string of an array containing the content and ID of each footnote. 2916 * @return string Filtered content without any HTML on the footnote content and with the sanitized ID. 2917 */ 2918 function _wp_filter_post_meta_footnotes( $footnotes ) { 2919 $footnotes_decoded = json_decode( $footnotes, true ); 2920 if ( ! is_array( $footnotes_decoded ) ) { 2921 return ''; 2922 } 2923 $footnotes_sanitized = array(); 2924 foreach ( $footnotes_decoded as $footnote ) { 2925 if ( ! empty( $footnote['content'] ) && ! empty( $footnote['id'] ) ) { 2926 $footnotes_sanitized[] = array( 2927 'id' => sanitize_key( $footnote['id'] ), 2928 'content' => wp_unslash( wp_filter_post_kses( wp_slash( $footnote['content'] ) ) ), 2929 ); 2930 } 2931 } 2932 return wp_json_encode( $footnotes_sanitized ); 2933 } 2934 2935 /** 2936 * Adds the filters for footnotes meta field. 2937 * 2938 * @access private 2939 * @since 6.3.2 2940 */ 2941 function _wp_footnotes_kses_init_filters() { 2942 add_filter( 'sanitize_post_meta_footnotes', '_wp_filter_post_meta_footnotes' ); 2943 } 2944 2945 /** 2946 * Removes the filters for footnotes meta field. 2947 * 2948 * @access private 2949 * @since 6.3.2 2950 */ 2951 function _wp_footnotes_remove_filters() { 2952 remove_filter( 'sanitize_post_meta_footnotes', '_wp_filter_post_meta_footnotes' ); 2953 } 2954 2955 /** 2956 * Registers the filter of footnotes meta field if the user does not have `unfiltered_html` capability. 2957 * 2958 * @access private 2959 * @since 6.3.2 2960 */ 2961 function _wp_footnotes_kses_init() { 2962 _wp_footnotes_remove_filters(); 2963 if ( ! current_user_can( 'unfiltered_html' ) ) { 2964 _wp_footnotes_kses_init_filters(); 2965 } 2966 } 2967 2968 /** 2969 * Initializes the filters for footnotes meta field when imported data should be filtered. 2970 * 2971 * This filter is the last one being executed on {@see 'force_filtered_html_on_import'}. 2972 * If the input of the filter is true, it means we are in an import situation and should 2973 * enable kses, independently of the user capabilities. So in that case we call 2974 * _wp_footnotes_kses_init_filters(). 2975 * 2976 * @access private 2977 * @since 6.3.2 2978 * 2979 * @param string $arg Input argument of the filter. 2980 * @return string Input argument of the filter. 2981 */ 2982 function _wp_footnotes_force_filtered_html_on_import_filter( $arg ) { 2983 // If `force_filtered_html_on_import` is true, we need to init the global styles kses filters. 2984 if ( $arg ) { 2985 _wp_footnotes_kses_init_filters(); 2986 } 2987 return $arg; 2988 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu Apr 3 08:20:01 2025 | Cross-referenced by PHPXref |