From 66c782f6cd25d32cdae28acda1cbdf289b2bf709 Mon Sep 17 00:00:00 2001 From: spacedmonkey Date: Mon, 25 Sep 2023 17:49:19 +0000 Subject: [PATCH] Editor: Introduce get_block_asset_url Utility Function. This commit introduces a valuable utility function, get_block_asset_url, designed to simplify the retrieval of block asset URLs, such as those for CSS and JavaScript files. This utility eliminates redundancy in both register_block_script_handle and register_block_style_handle. Additionally, `get_block_asset_url` incorporates an early exit mechanism to optimize performance. This update includes comprehensive unit tests, covering various scenarios, including asset registration from core (wp-includes), themes, child themes, plugins, and mu-plugins. Props spacedmonkey, joemcgill, flixos90, gziolo. Fixes #58525. Built from https://develop.svn.wordpress.org/trunk@56683 git-svn-id: http://core.svn.wordpress.org/trunk@56195 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/blocks.php | 125 +++++++++++++++++----------------------- wp-includes/version.php | 2 +- 2 files changed, 55 insertions(+), 72 deletions(-) diff --git a/wp-includes/blocks.php b/wp-includes/blocks.php index be387b89a9..81c7d250fc 100644 --- a/wp-includes/blocks.php +++ b/wp-includes/blocks.php @@ -73,6 +73,54 @@ function generate_block_asset_handle( $block_name, $field_name, $index = 0 ) { return $asset_handle; } +/** + * Gets the URL to a block asset. + * + * @since 6.4.0 + * + * @param string $path A normalized path to a block asset. + * @return string|false The URL to the block asset or false on failure. + */ +function get_block_asset_url( $path ) { + if ( empty( $path ) ) { + return false; + } + + // Path needs to be normalized to work in Windows env. + static $wpinc_path_norm = ''; + if ( ! $wpinc_path_norm ) { + $wpinc_path_norm = wp_normalize_path( realpath( ABSPATH . WPINC ) ); + } + + if ( str_starts_with( $path, $wpinc_path_norm ) ) { + return includes_url( str_replace( $wpinc_path_norm, '', $path ) ); + } + + static $template_paths_norm = array(); + + $template = get_template(); + if ( ! isset( $template_paths_norm[ $template ] ) ) { + $template_paths_norm[ $template ] = wp_normalize_path( get_template_directory() ); + } + + if ( str_starts_with( $path, trailingslashit( $template_paths_norm[ $template ] ) ) ) { + return get_theme_file_uri( str_replace( $template_paths_norm[ $template ], '', $path ) ); + } + + if ( is_child_theme() ) { + $stylesheet = get_stylesheet(); + if ( ! isset( $template_paths_norm[ $stylesheet ] ) ) { + $template_paths_norm[ $stylesheet ] = wp_normalize_path( get_stylesheet_directory() ); + } + + if ( str_starts_with( $path, trailingslashit( $template_paths_norm[ $stylesheet ] ) ) ) { + return get_theme_file_uri( str_replace( $template_paths_norm[ $stylesheet ], '', $path ) ); + } + } + + return plugins_url( basename( $path ), $path ); +} + /** * Finds a script handle for the selected block metadata field. It detects * when a path to file was provided and finds a corresponding asset file @@ -107,7 +155,8 @@ function register_block_script_handle( $metadata, $field_name, $index = 0 ) { return $script_handle; } - $script_asset_raw_path = dirname( $metadata['file'] ) . '/' . substr_replace( $script_path, '.asset.php', - strlen( '.js' ) ); + $path = dirname( $metadata['file'] ); + $script_asset_raw_path = $path . '/' . substr_replace( $script_path, '.asset.php', - strlen( '.js' ) ); $script_handle = generate_block_asset_handle( $metadata['name'], $field_name, $index ); $script_asset_path = wp_normalize_path( realpath( $script_asset_raw_path ) @@ -128,44 +177,8 @@ function register_block_script_handle( $metadata, $field_name, $index = 0 ) { return false; } - // Path needs to be normalized to work in Windows env. - static $wpinc_path_norm = ''; - if ( ! $wpinc_path_norm ) { - $wpinc_path_norm = wp_normalize_path( realpath( ABSPATH . WPINC ) ); - } - - // Cache $template_path_norm and $stylesheet_path_norm to avoid unnecessary additional calls. - static $template_path_norm = ''; - static $stylesheet_path_norm = ''; - if ( ! $template_path_norm || ! $stylesheet_path_norm ) { - $template_path_norm = wp_normalize_path( get_template_directory() ); - $stylesheet_path_norm = wp_normalize_path( get_stylesheet_directory() ); - } - - $script_path_norm = wp_normalize_path( realpath( dirname( $metadata['file'] ) . '/' . $script_path ) ); - - $is_core_block = isset( $metadata['file'] ) && str_starts_with( $metadata['file'], $wpinc_path_norm ); - - /* - * Determine if the block script was registered in a theme, by checking if the script path starts with either - * the parent (template) or child (stylesheet) directory path. - */ - $is_parent_theme_block = str_starts_with( $script_path_norm, trailingslashit( $template_path_norm ) ); - $is_child_theme_block = str_starts_with( $script_path_norm, trailingslashit( $stylesheet_path_norm ) ); - $is_theme_block = ( $is_parent_theme_block || $is_child_theme_block ); - - $script_uri = ''; - if ( $is_core_block ) { - $script_uri = includes_url( str_replace( $wpinc_path_norm, '', $script_path_norm ) ); - } elseif ( $is_theme_block ) { - // Get the script path deterministically based on whether or not it was registered in a parent or child theme. - $script_uri = $is_parent_theme_block - ? get_theme_file_uri( str_replace( $template_path_norm, '', $script_path_norm ) ) - : get_theme_file_uri( str_replace( $stylesheet_path_norm, '', $script_path_norm ) ); - } else { - // Fallback to plugins_url(). - $script_uri = plugins_url( $script_path, $metadata['file'] ); - } + $script_path_norm = wp_normalize_path( realpath( $path . '/' . $script_path ) ); + $script_uri = get_block_asset_url( $script_path_norm ); $script_args = array(); if ( 'viewScript' === $field_name ) { @@ -255,37 +268,7 @@ function register_block_style_handle( $metadata, $field_name, $index = 0 ) { } $style_path_norm = wp_normalize_path( realpath( dirname( $metadata['file'] ) . '/' . $style_path ) ); - $has_style_file = '' !== $style_path_norm; - - if ( $has_style_file ) { - $style_uri = plugins_url( $style_path, $metadata['file'] ); - - // Cache $template_path_norm and $stylesheet_path_norm to avoid unnecessary additional calls. - static $template_path_norm = ''; - static $stylesheet_path_norm = ''; - if ( ! $template_path_norm || ! $stylesheet_path_norm ) { - $template_path_norm = wp_normalize_path( get_template_directory() ); - $stylesheet_path_norm = wp_normalize_path( get_stylesheet_directory() ); - } - - // Determine if the block style was registered in a theme, by checking if the script path starts with either - // the parent (template) or child (stylesheet) directory path. - $is_parent_theme_block = str_starts_with( $style_path_norm, trailingslashit( $template_path_norm ) ); - $is_child_theme_block = str_starts_with( $style_path_norm, trailingslashit( $stylesheet_path_norm ) ); - $is_theme_block = ( $is_parent_theme_block || $is_child_theme_block ); - - if ( $is_core_block ) { - // All possible $style_path variants for core blocks are hard-coded above. - $style_uri = includes_url( 'blocks/' . str_replace( 'core/', '', $metadata['name'] ) . '/' . $style_path ); - } elseif ( $is_theme_block ) { - // Get the script path deterministically based on whether or not it was registered in a parent or child theme. - $style_uri = $is_parent_theme_block - ? get_theme_file_uri( str_replace( $template_path_norm, '', $style_path_norm ) ) - : get_theme_file_uri( str_replace( $stylesheet_path_norm, '', $style_path_norm ) ); - } - } else { - $style_uri = false; - } + $style_uri = get_block_asset_url( $style_path_norm ); $version = ! $is_core_block && isset( $metadata['version'] ) ? $metadata['version'] : false; $result = wp_register_style( @@ -298,7 +281,7 @@ function register_block_style_handle( $metadata, $field_name, $index = 0 ) { return false; } - if ( $has_style_file ) { + if ( $style_uri ) { wp_style_add_data( $style_handle_name, 'path', $style_path_norm ); if ( $is_core_block ) { diff --git a/wp-includes/version.php b/wp-includes/version.php index 1ff45b2f46..3cc874bb1e 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.4-alpha-56682'; +$wp_version = '6.4-alpha-56683'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.