<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Block support flags.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

*

[5] Fix | Delete

* @since 5.6.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Class encapsulating and implementing Block Supports.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 5.6.0

[12] Fix | Delete

*

[13] Fix | Delete

* @access private

[14] Fix | Delete

*/

[15] Fix | Delete

#[AllowDynamicProperties]

[16] Fix | Delete

class WP_Block_Supports {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Config.

[20] Fix | Delete

*

[21] Fix | Delete

* @since 5.6.0

[22] Fix | Delete

* @var array

[23] Fix | Delete

*/

[24] Fix | Delete

private $block_supports = array();

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Tracks the current block to be rendered.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 5.6.0

[30] Fix | Delete

* @var array

[31] Fix | Delete

*/

[32] Fix | Delete

public static $block_to_render = null;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Container for the main instance of the class.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 5.6.0

[38] Fix | Delete

* @var WP_Block_Supports|null

[39] Fix | Delete

*/

[40] Fix | Delete

private static $instance = null;

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Utility method to retrieve the main instance of the class.

[44] Fix | Delete

*

[45] Fix | Delete

* The instance will be created if it does not exist yet.

[46] Fix | Delete

*

[47] Fix | Delete

* @since 5.6.0

[48] Fix | Delete

*

[49] Fix | Delete

* @return WP_Block_Supports The main instance.

[50] Fix | Delete

*/

[51] Fix | Delete

public static function get_instance() {

[52] Fix | Delete

if ( null === self::$instance ) {

[53] Fix | Delete

self::$instance = new self();

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

return self::$instance;

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Initializes the block supports. It registers the block supports block attributes.

[61] Fix | Delete

*

[62] Fix | Delete

* @since 5.6.0

[63] Fix | Delete

*/

[64] Fix | Delete

public static function init() {

[65] Fix | Delete

$instance = self::get_instance();

[66] Fix | Delete

$instance->register_attributes();

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Registers a block support.

[71] Fix | Delete

*

[72] Fix | Delete

* @since 5.6.0

[73] Fix | Delete

*

[74] Fix | Delete

* @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/

[75] Fix | Delete

*

[76] Fix | Delete

* @param string $block_support_name Block support name.

[77] Fix | Delete

* @param array $block_support_config Array containing the properties of the block support.

[78] Fix | Delete

*/

[79] Fix | Delete

public function register( $block_support_name, $block_support_config ) {

[80] Fix | Delete

$this->block_supports[ $block_support_name ] = array_merge(

[81] Fix | Delete

$block_support_config,

[82] Fix | Delete

array( 'name' => $block_support_name )

[83] Fix | Delete

);

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Generates an array of HTML attributes, such as classes, by applying to

[88] Fix | Delete

* the given block all of the features that the block supports.

[89] Fix | Delete

*

[90] Fix | Delete

* @since 5.6.0

[91] Fix | Delete

*

[92] Fix | Delete

* @return string[] Array of HTML attribute values keyed by their name.

[93] Fix | Delete

*/

[94] Fix | Delete

public function apply_block_supports() {

[95] Fix | Delete

$block_type = WP_Block_Type_Registry::get_instance()->get_registered(

[96] Fix | Delete

self::$block_to_render['blockName']

[97] Fix | Delete

);

[98] Fix | Delete

[99] Fix | Delete

// If no render_callback, assume styles have been previously handled.

[100] Fix | Delete

if ( ! $block_type || empty( $block_type ) ) {

[101] Fix | Delete

return array();

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

$block_attributes = array_key_exists( 'attrs', self::$block_to_render ) && is_array( self::$block_to_render['attrs'] )

[105] Fix | Delete

? $block_type->prepare_attributes_for_render( self::$block_to_render['attrs'] )

[106] Fix | Delete

: array();

[107] Fix | Delete

[108] Fix | Delete

$output = array();

[109] Fix | Delete

foreach ( $this->block_supports as $block_support_config ) {

[110] Fix | Delete

if ( ! isset( $block_support_config['apply'] ) ) {

[111] Fix | Delete

continue;

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

$new_attributes = call_user_func(

[115] Fix | Delete

$block_support_config['apply'],

[116] Fix | Delete

$block_type,

[117] Fix | Delete

$block_attributes

[118] Fix | Delete

);

[119] Fix | Delete

[120] Fix | Delete

if ( ! empty( $new_attributes ) ) {

[121] Fix | Delete

foreach ( $new_attributes as $attribute_name => $attribute_value ) {

[122] Fix | Delete

if ( empty( $output[ $attribute_name ] ) ) {

[123] Fix | Delete

$output[ $attribute_name ] = $attribute_value;

[124] Fix | Delete

} else {

[125] Fix | Delete

$output[ $attribute_name ] .= " $attribute_value";

[126] Fix | Delete

}

[127] Fix | Delete

}

[128] Fix | Delete

}

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

return $output;

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Registers the block attributes required by the different block supports.

[136] Fix | Delete

*

[137] Fix | Delete

* @since 5.6.0

[138] Fix | Delete

*/

[139] Fix | Delete

private function register_attributes() {

[140] Fix | Delete

$block_registry = WP_Block_Type_Registry::get_instance();

[141] Fix | Delete

$registered_block_types = $block_registry->get_all_registered();

[142] Fix | Delete

foreach ( $registered_block_types as $block_type ) {

[143] Fix | Delete

if ( ! ( $block_type instanceof WP_Block_Type ) ) {

[144] Fix | Delete

continue;

[145] Fix | Delete

}

[146] Fix | Delete

if ( ! $block_type->attributes ) {

[147] Fix | Delete

$block_type->attributes = array();

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

foreach ( $this->block_supports as $block_support_config ) {

[151] Fix | Delete

if ( ! isset( $block_support_config['register_attribute'] ) ) {

[152] Fix | Delete

continue;

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

call_user_func(

[156] Fix | Delete

$block_support_config['register_attribute'],

[157] Fix | Delete

$block_type

[158] Fix | Delete

);

[159] Fix | Delete

}

[160] Fix | Delete

}

[161] Fix | Delete

}

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Generates a string of attributes by applying to the current block being

[166] Fix | Delete

* rendered all of the features that the block supports.

[167] Fix | Delete

*

[168] Fix | Delete

* @since 5.6.0

[169] Fix | Delete

*

[170] Fix | Delete

* @param string[] $extra_attributes Optional. Array of extra attributes to render on the block wrapper.

[171] Fix | Delete

* @return string String of HTML attributes.

[172] Fix | Delete

*/

[173] Fix | Delete

function get_block_wrapper_attributes( $extra_attributes = array() ) {

[174] Fix | Delete

$new_attributes = WP_Block_Supports::get_instance()->apply_block_supports();

[175] Fix | Delete

[176] Fix | Delete

if ( empty( $new_attributes ) && empty( $extra_attributes ) ) {

[177] Fix | Delete

return '';

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

// This is hardcoded on purpose.

[181] Fix | Delete

// We only support a fixed list of attributes.

[182] Fix | Delete

$attributes_to_merge = array( 'style', 'class', 'id', 'aria-label' );

[183] Fix | Delete

$attributes = array();

[184] Fix | Delete

foreach ( $attributes_to_merge as $attribute_name ) {

[185] Fix | Delete

if ( empty( $new_attributes[ $attribute_name ] ) && empty( $extra_attributes[ $attribute_name ] ) ) {

[186] Fix | Delete

continue;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

if ( empty( $new_attributes[ $attribute_name ] ) ) {

[190] Fix | Delete

$attributes[ $attribute_name ] = $extra_attributes[ $attribute_name ];

[191] Fix | Delete

continue;

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

if ( empty( $extra_attributes[ $attribute_name ] ) ) {

[195] Fix | Delete

$attributes[ $attribute_name ] = $new_attributes[ $attribute_name ];

[196] Fix | Delete

continue;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

$attributes[ $attribute_name ] = $extra_attributes[ $attribute_name ] . ' ' . $new_attributes[ $attribute_name ];

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

foreach ( $extra_attributes as $attribute_name => $value ) {

[203] Fix | Delete

if ( ! in_array( $attribute_name, $attributes_to_merge, true ) ) {

[204] Fix | Delete

$attributes[ $attribute_name ] = $value;

[205] Fix | Delete

}

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

if ( empty( $attributes ) ) {

[209] Fix | Delete

return '';

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

$normalized_attributes = array();

[213] Fix | Delete

foreach ( $attributes as $key => $value ) {

[214] Fix | Delete

$normalized_attributes[] = $key . '="' . esc_attr( $value ) . '"';

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

return implode( ' ', $normalized_attributes );

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete