Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Block support to enable per-section styling of block types via

[2] Fix | Delete

* block style variations.

[3] Fix | Delete

[4] Fix | Delete

* @package WordPress

[5] Fix | Delete

* @since 6.6.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Generate block style variation instance name.

[10] Fix | Delete

[11] Fix | Delete

* @since 6.6.0

[12] Fix | Delete

* @access private

[13] Fix | Delete

[14] Fix | Delete

* @param array $block Block object.

[15] Fix | Delete

* @param string $variation Slug for the block style variation.

[16] Fix | Delete

[17] Fix | Delete

* @return string The unique variation name.

[18] Fix | Delete

[19] Fix | Delete

function wp_create_block_style_variation_instance_name( $block, $variation ) {

[20] Fix | Delete

return $variation . '--' . md5( serialize( $block ) );

[21] Fix | Delete

}

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Determines the block style variation names within a CSS class string.

[25] Fix | Delete

[26] Fix | Delete

* @since 6.6.0

[27] Fix | Delete

[28] Fix | Delete

* @param string $class_string CSS class string to look for a variation in.

[29] Fix | Delete

[30] Fix | Delete

* @return array|null The block style variation name if found.

[31] Fix | Delete

[32] Fix | Delete

function wp_get_block_style_variation_name_from_class( $class_string ) {

[33] Fix | Delete

if ( ! is_string( $class_string ) ) {

[34] Fix | Delete

return null;

[35] Fix | Delete

}

[36] Fix | Delete

[37] Fix | Delete

preg_match_all( '/\bis-style-(?!default)(\S+)\b/', $class_string, $matches );

[38] Fix | Delete

return $matches[1] ?? null;

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Recursively resolves any `ref` values within a block style variation's data.

[43] Fix | Delete

[44] Fix | Delete

* @since 6.6.0

[45] Fix | Delete

* @access private

[46] Fix | Delete

[47] Fix | Delete

* @param array $variation_data Reference to the variation data being processed.

[48] Fix | Delete

* @param array $theme_json Theme.json data to retrieve referenced values from.

[49] Fix | Delete

[50] Fix | Delete

function wp_resolve_block_style_variation_ref_values( &$variation_data, $theme_json ) {

[51] Fix | Delete

foreach ( $variation_data as $key => &$value ) {

[52] Fix | Delete

// Only need to potentially process arrays.

[53] Fix | Delete

if ( is_array( $value ) ) {

[54] Fix | Delete

// If ref value is set, attempt to find its matching value and update it.

[55] Fix | Delete

if ( array_key_exists( 'ref', $value ) ) {

[56] Fix | Delete

// Clean up any invalid ref value.

[57] Fix | Delete

if ( empty( $value['ref'] ) || ! is_string( $value['ref'] ) ) {

[58] Fix | Delete

unset( $variation_data[ $key ] );

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

$value_path = explode( '.', $value['ref'] ?? '' );

[62] Fix | Delete

$ref_value = _wp_array_get( $theme_json, $value_path );

[63] Fix | Delete

[64] Fix | Delete

// Only update the current value if the referenced path matched a value.

[65] Fix | Delete

if ( null === $ref_value ) {

[66] Fix | Delete

unset( $variation_data[ $key ] );

[67] Fix | Delete

} else {

[68] Fix | Delete

$value = $ref_value;

[69] Fix | Delete

}

[70] Fix | Delete

} else {

[71] Fix | Delete

// Recursively look for ref instances.

[72] Fix | Delete

wp_resolve_block_style_variation_ref_values( $value, $theme_json );

[73] Fix | Delete

}

[74] Fix | Delete

}

[75] Fix | Delete

}

[76] Fix | Delete

}

[77] Fix | Delete

/**

[78] Fix | Delete

* Render the block style variation's styles.

[79] Fix | Delete

[80] Fix | Delete

* In the case of nested blocks with variations applied, we want the parent

[81] Fix | Delete

* variation's styles to be rendered before their descendants. This solves the

[82] Fix | Delete

* issue of a block type being styled in both the parent and descendant: we want

[83] Fix | Delete

* the descendant style to take priority, and this is done by loading it after,

[84] Fix | Delete

* in the DOM order. This is why the variation stylesheet generation is in a

[85] Fix | Delete

* different filter.

[86] Fix | Delete

[87] Fix | Delete

* @since 6.6.0

[88] Fix | Delete

* @access private

[89] Fix | Delete

[90] Fix | Delete

* @param array $parsed_block The parsed block.

[91] Fix | Delete

[92] Fix | Delete

* @return array The parsed block with block style variation classname added.

[93] Fix | Delete

[94] Fix | Delete

function wp_render_block_style_variation_support_styles( $parsed_block ) {

[95] Fix | Delete

$classes = $parsed_block['attrs']['className'] ?? null;

[96] Fix | Delete

$variations = wp_get_block_style_variation_name_from_class( $classes );

[97] Fix | Delete

[98] Fix | Delete

if ( ! $variations ) {

[99] Fix | Delete

return $parsed_block;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

$tree = WP_Theme_JSON_Resolver::get_merged_data();

[103] Fix | Delete

$theme_json = $tree->get_raw_data();

[104] Fix | Delete

[105] Fix | Delete

// Only the first block style variation with data is supported.

[106] Fix | Delete

$variation_data = array();

[107] Fix | Delete

foreach ( $variations as $variation ) {

[108] Fix | Delete

$variation_data = $theme_json['styles']['blocks'][ $parsed_block['blockName'] ]['variations'][ $variation ] ?? array();

[109] Fix | Delete

[110] Fix | Delete

if ( ! empty( $variation_data ) ) {

[111] Fix | Delete

break;

[112] Fix | Delete

}

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

if ( empty( $variation_data ) ) {

[116] Fix | Delete

return $parsed_block;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

[120] Fix | Delete

* Recursively resolve any ref values with the appropriate value within the

[121] Fix | Delete

* theme_json data.

[122] Fix | Delete

[123] Fix | Delete

wp_resolve_block_style_variation_ref_values( $variation_data, $theme_json );

[124] Fix | Delete

[125] Fix | Delete

$variation_instance = wp_create_block_style_variation_instance_name( $parsed_block, $variation );

[126] Fix | Delete

$class_name = "is-style-$variation_instance";

[127] Fix | Delete

$updated_class_name = $parsed_block['attrs']['className'] . " $class_name";

[128] Fix | Delete

[129] Fix | Delete

[130] Fix | Delete

* Even though block style variations are effectively theme.json partials,

[131] Fix | Delete

* they can't be processed completely as though they are.

[132] Fix | Delete

[133] Fix | Delete

* Block styles support custom selectors to direct specific types of styles

[134] Fix | Delete

* to inner elements. For example, borders on Image block's get applied to

[135] Fix | Delete

* the inner `img` element rather than the wrapping `figure`.

[136] Fix | Delete

[137] Fix | Delete

* The following relocates the "root" block style variation styles to

[138] Fix | Delete

* under an appropriate blocks property to leverage the preexisting style

[139] Fix | Delete

* generation for simple block style variations. This way they get the

[140] Fix | Delete

* custom selectors they need.

[141] Fix | Delete

[142] Fix | Delete

* The inner elements and block styles for the variation itself are

[143] Fix | Delete

* still included at the top level but scoped by the variation's selector

[144] Fix | Delete

* when the stylesheet is generated.

[145] Fix | Delete

[146] Fix | Delete

$elements_data = $variation_data['elements'] ?? array();

[147] Fix | Delete

$blocks_data = $variation_data['blocks'] ?? array();

[148] Fix | Delete

unset( $variation_data['elements'] );

[149] Fix | Delete

unset( $variation_data['blocks'] );

[150] Fix | Delete

[151] Fix | Delete

_wp_array_set(

[152] Fix | Delete

$blocks_data,

[153] Fix | Delete

array( $parsed_block['blockName'], 'variations', $variation_instance ),

[154] Fix | Delete

$variation_data

[155] Fix | Delete

);

[156] Fix | Delete

[157] Fix | Delete

$config = array(

[158] Fix | Delete

'version' => WP_Theme_JSON::LATEST_SCHEMA,

[159] Fix | Delete

'styles' => array(

[160] Fix | Delete

'elements' => $elements_data,

[161] Fix | Delete

'blocks' => $blocks_data,

[162] Fix | Delete

[163] Fix | Delete

);

[164] Fix | Delete

[165] Fix | Delete

// Turn off filter that excludes block nodes. They are needed here for the variation's inner block types.

[166] Fix | Delete

if ( ! is_admin() ) {

[167] Fix | Delete

remove_filter( 'wp_theme_json_get_style_nodes', 'wp_filter_out_block_nodes' );

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

// Temporarily prevent variation instance from being sanitized while processing theme.json.

[171] Fix | Delete

$styles_registry = WP_Block_Styles_Registry::get_instance();

[172] Fix | Delete

$styles_registry->register( $parsed_block['blockName'], array( 'name' => $variation_instance ) );

[173] Fix | Delete

[174] Fix | Delete

$variation_theme_json = new WP_Theme_JSON( $config, 'blocks' );

[175] Fix | Delete

$variation_styles = $variation_theme_json->get_stylesheet(

[176] Fix | Delete

array( 'styles' ),

[177] Fix | Delete

array( 'custom' ),

[178] Fix | Delete

array(

[179] Fix | Delete

'include_block_style_variations' => true,

[180] Fix | Delete

'skip_root_layout_styles' => true,

[181] Fix | Delete

'scope' => ".$class_name",

[182] Fix | Delete

)

[183] Fix | Delete

);

[184] Fix | Delete

[185] Fix | Delete

// Clean up temporary block style now instance styles have been processed.

[186] Fix | Delete

$styles_registry->unregister( $parsed_block['blockName'], $variation_instance );

[187] Fix | Delete

[188] Fix | Delete

// Restore filter that excludes block nodes.

[189] Fix | Delete

if ( ! is_admin() ) {

[190] Fix | Delete

add_filter( 'wp_theme_json_get_style_nodes', 'wp_filter_out_block_nodes' );

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

if ( empty( $variation_styles ) ) {

[194] Fix | Delete

return $parsed_block;

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

wp_register_style( 'block-style-variation-styles', false, array( 'wp-block-library', 'global-styles' ) );

[198] Fix | Delete

wp_add_inline_style( 'block-style-variation-styles', $variation_styles );

[199] Fix | Delete

[200] Fix | Delete

[201] Fix | Delete

* Add variation instance class name to block's className string so it can

[202] Fix | Delete

* be enforced in the block markup via render_block filter.

[203] Fix | Delete

[204] Fix | Delete

_wp_array_set( $parsed_block, array( 'attrs', 'className' ), $updated_class_name );

[205] Fix | Delete

[206] Fix | Delete

return $parsed_block;

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

/**

[210] Fix | Delete

* Ensure the variation block support class name generated and added to

[211] Fix | Delete

* block attributes in the `render_block_data` filter gets applied to the

[212] Fix | Delete

* block's markup.

[213] Fix | Delete

[214] Fix | Delete

* @see wp_render_block_style_variation_support_styles

[215] Fix | Delete

[216] Fix | Delete

* @since 6.6.0

[217] Fix | Delete

* @access private

[218] Fix | Delete

[219] Fix | Delete

* @param string $block_content Rendered block content.

[220] Fix | Delete

* @param array $block Block object.

[221] Fix | Delete

[222] Fix | Delete

* @return string Filtered block content.

[223] Fix | Delete

[224] Fix | Delete

function wp_render_block_style_variation_class_name( $block_content, $block ) {

[225] Fix | Delete

if ( ! $block_content || empty( $block['attrs']['className'] ) ) {

[226] Fix | Delete

return $block_content;

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

[230] Fix | Delete

* Matches a class prefixed by `is-style`, followed by the

[231] Fix | Delete

* variation slug, then `--`, and finally a hash.

[232] Fix | Delete

[233] Fix | Delete

* See `wp_create_block_style_variation_instance_name` for class generation.

[234] Fix | Delete

[235] Fix | Delete

preg_match( '/\bis-style-(\S+?--\w+)\b/', $block['attrs']['className'], $matches );

[236] Fix | Delete

[237] Fix | Delete

if ( empty( $matches ) ) {

[238] Fix | Delete

return $block_content;

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

$tags = new WP_HTML_Tag_Processor( $block_content );

[242] Fix | Delete

[243] Fix | Delete

if ( $tags->next_tag() ) {

[244] Fix | Delete

[245] Fix | Delete

* Ensure the variation instance class name set in the

[246] Fix | Delete

* `render_block_data` filter is applied in markup.

[247] Fix | Delete

* See `wp_render_block_style_variation_support_styles`.

[248] Fix | Delete

[249] Fix | Delete

$tags->add_class( $matches[0] );

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

return $tags->get_updated_html();

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Enqueues styles for block style variations.

[257] Fix | Delete

[258] Fix | Delete

* @since 6.6.0

[259] Fix | Delete

* @access private

[260] Fix | Delete

[261] Fix | Delete

function wp_enqueue_block_style_variation_styles() {

[262] Fix | Delete

wp_enqueue_style( 'block-style-variation-styles' );

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

// Register the block support.

[266] Fix | Delete

WP_Block_Supports::get_instance()->register( 'block-style-variation', array() );

[267] Fix | Delete

[268] Fix | Delete

add_filter( 'render_block_data', 'wp_render_block_style_variation_support_styles', 10, 2 );

[269] Fix | Delete

add_filter( 'render_block', 'wp_render_block_style_variation_class_name', 10, 2 );

[270] Fix | Delete

add_action( 'wp_enqueue_scripts', 'wp_enqueue_block_style_variation_styles', 1 );

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Registers block style variations read in from theme.json partials.

[274] Fix | Delete

[275] Fix | Delete

* @since 6.6.0

[276] Fix | Delete

* @access private

[277] Fix | Delete

[278] Fix | Delete

* @param array $variations Shared block style variations.

[279] Fix | Delete

[280] Fix | Delete

function wp_register_block_style_variations_from_theme_json_partials( $variations ) {

[281] Fix | Delete

if ( empty( $variations ) ) {

[282] Fix | Delete

return;

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

$registry = WP_Block_Styles_Registry::get_instance();

[286] Fix | Delete

[287] Fix | Delete

foreach ( $variations as $variation ) {

[288] Fix | Delete

if ( empty( $variation['blockTypes'] ) || empty( $variation['styles'] ) ) {

[289] Fix | Delete

continue;

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

$variation_name = $variation['slug'] ?? _wp_to_kebab_case( $variation['title'] );

[293] Fix | Delete

$variation_label = $variation['title'] ?? $variation_name;

[294] Fix | Delete

[295] Fix | Delete

foreach ( $variation['blockTypes'] as $block_type ) {

[296] Fix | Delete

$registered_styles = $registry->get_registered_styles_for_block( $block_type );

[297] Fix | Delete

[298] Fix | Delete

// Register block style variation if it hasn't already been registered.

[299] Fix | Delete

if ( ! array_key_exists( $variation_name, $registered_styles ) ) {

[300] Fix | Delete

register_block_style(

[301] Fix | Delete

$block_type,

[302] Fix | Delete

array(

[303] Fix | Delete

'name' => $variation_name,

[304] Fix | Delete

'label' => $variation_label,

[305] Fix | Delete

)

[306] Fix | Delete

);

[307] Fix | Delete

}

[308] Fix | Delete

}

[309] Fix | Delete

}

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete