tion that might fail for sites using symlinked plugins.
*
* If the registration fails due to path validation, blocks will fall back to regular
* registration without affecting functionality.
*/
public function register_block_metadata() {
$meta_file_path = WC_ABSPATH . 'assets/client/blocks/blocks-json.php';
if ( function_exists( 'wp_register_block_metadata_collection' ) && file_exists( $meta_file_path ) ) {
add_filter( 'doing_it_wrong_trigger_error', array( __CLASS__, 'bypass_block_metadata_doing_it_wrong' ), 10, 4 );
wp_register_block_metadata_collection(
WC_ABSPATH . 'assets/client/blocks/',
$meta_file_path
);
remove_filter( 'doing_it_wrong_trigger_error', array( __CLASS__, 'bypass_block_metadata_doing_it_wrong' ), 10 );
}
}
/**
* Temporarily bypasses _doing_it_wrong() notices for block metadata collection registration.
*
* WordPress 6.7 introduced block metadata collections (with strict path validation).
* Any sites using symlinks for plugins will fail the validation which causes the metadata
* collection to not be registered. However, the blocks will still fall back to the regular
* registration and no functionality is affected.
* While this validation is being discussed in WordPress Core (#62140),
* this method allows registration to proceed by temporarily disabling
* the relevant notice.
*
* @param bool $trigger Whether to trigger the error.
* @param string $function The function that was called.
* @param string $message A message explaining what was done incorrectly.
* @param string $version The version of WordPress where the message was added.
* @return bool Whether to trigger the error.
*/
public static function bypass_block_metadata_doing_it_wrong( $trigger, $function, $message, $version ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable,Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed,Universal.NamingConventions.NoReservedKeywordParameterNames.functionFound
if ( 'WP_Block_Metadata_Registry::register_collection' === $function ) {
return false;
}
return $trigger;
}
/**
* Register block patterns
*/
public function register_block_patterns() {
register_block_pattern(
'woocommerce/order-confirmation-totals-heading',
array(
'title' => '',
'inserter' => false,
'content' => '' . esc_html__( 'Order details', 'woocommerce' ) . ' ',
)
);
register_block_pattern(
'woocommerce/order-confirmation-downloads-heading',
array(
'title' => '',
'inserter' => false,
'content' => '' . esc_html__( 'Downloads', 'woocommerce' ) . ' ',
)
);
register_block_pattern(
'woocommerce/order-confirmation-shipping-heading',
array(
'title' => '',
'inserter' => false,
'content' => '' . esc_html__( 'Shipping address', 'woocommerce' ) . ' ',
)
);
register_block_pattern(
'woocommerce/order-confirmation-billing-heading',
array(
'title' => '',
'inserter' => false,
'content' => '' . esc_html__( 'Billing address', 'woocommerce' ) . ' ',
)
);
register_block_pattern(
'woocommerce/order-confirmation-additional-fields-heading',
array(
'title' => '',
'inserter' => false,
'content' => '' . esc_html__( 'Additional information', 'woocommerce' ) . ' ',
)
);
}
/**
* Register block categories
*
* Used in combination with the `block_categories_all` filter, to append
* WooCommerce Blocks related categories to the Gutenberg editor.
*
* @param array $categories The array of already registered categories.
*/
public function register_block_categories( $categories ) {
$woocommerce_block_categories = array(
array(
'slug' => 'woocommerce',
'title' => __( 'WooCommerce', 'woocommerce' ),
),
array(
'slug' => 'woocommerce-product-elements',
'title' => __( 'WooCommerce Product Elements', 'woocommerce' ),
),
);
return array_merge( $categories, $woocommerce_block_categories );
}
/**
* Check if a block should have data attributes appended on render. If it's in an allowed namespace, or the block
* has explicitly been added to the allowed block list, or if one of the block's parents is in the WooCommerce
* namespace it can have data attributes.
*
* @param string $block_name Name of the block to check.
*
* @return boolean
*/
public function block_should_have_data_attributes( $block_name ) {
$block_namespace = strtok( $block_name ?? '', '/' );
/**
* Filters the list of allowed block namespaces.
*
* This hook defines which block namespaces should have block name and attribute `data-` attributes appended on render.
*
* @since 5.9.0
*
* @param array $allowed_namespaces List of namespaces.
*/
$allowed_namespaces = array_merge( array( 'woocommerce', 'woocommerce-checkout' ), (array) apply_filters( '__experimental_woocommerce_blocks_add_data_attributes_to_namespace', array() ) );
/**
* Filters the list of allowed Block Names
*
* This hook defines which block names should have block name and attribute data- attributes appended on render.
*
* @since 5.9.0
*
* @param array $allowed_namespaces List of namespaces.
*/
$allowed_blocks = (array) apply_filters( '__experimental_woocommerce_blocks_add_data_attributes_to_block', array() );
$blocks_with_woo_parents = $this->get_registered_blocks_with_woocommerce_parent();
$block_has_woo_parent = in_array( $block_name, array_keys( $blocks_with_woo_parents ), true );
$in_allowed_namespace_list = in_array( $block_namespace, $allowed_namespaces, true );
$in_allowed_block_list = in_array( $block_name, $allowed_blocks, true );
return $block_has_woo_parent || $in_allowed_block_list || $in_allowed_namespace_list;
}
/**
* Add data- attributes to blocks when rendered if the block is under the woocommerce/ namespace.
*
* @param string $content Block content.
* @param array $block Parsed block data.
* @return string
*/
public function add_data_attributes( $content, $block ) {
$content = trim( $content );
if ( ! $this->block_should_have_data_attributes( $block['blockName'] ) ) {
return $content;
}
$attributes = (array) $block['attrs'];
$exclude_attributes = array( 'className', 'align' );
$processor = new \WP_HTML_Tag_Processor( $content );
if (
false === $processor->next_token() ||
'DIV' !== $processor->get_token_name() ||
$processor->is_tag_closer()
) {
return $content;
}
foreach ( $attributes as $key => $value ) {
if ( ! is_string( $key ) || in_array( $key, $exclude_attributes, true ) ) {
continue;
}
if ( is_bool( $value ) ) {
$value = $value ? 'true' : 'false';
}
if ( ! is_scalar( $value ) ) {
$value = wp_json_encode( $value );
}
// For output consistency, we convert camelCase to kebab-case and output in lowercase.
$key = strtolower( preg_replace( '/(?set_attribute( "data-{$key}", $value );
}
// Set this last to prevent user-input from overriding it.
$processor->set_attribute( 'data-block-name', $block['blockName'] );
return $processor->get_updated_html();
}
/**
* Adds a redirect field to the login form so blocks can redirect users after login.
*/
public function redirect_to_field() {
// phpcs:ignore WordPress.Security.NonceVerification
if ( empty( $_GET['redirect_to'] ) ) {
return;
}
echo '