Changeset 58262 for trunk/src/wp-includes/class-wp-theme-json-resolver.php

Timestamp:

05/31/2024 01:17:50 AM (12 months ago)

Author:

noisysocks

Message:

Block Themes: Add support for relative URLs in top-level theme.json styles

Allow using relative file: URLs in top-level theme.json properties such as
styles.background, and modify the REST API to provide clients with the
absolute URLs via a '​https://api.w.org/theme-file' attribute in the _links
array.

Props ramonopoly.
Fixes #61273.

File:

• trunk/src/wp-includes/class-wp-theme-json-resolver.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-theme-json-resolver.php

@@ -745 +745 @@
         return $variations;
     }
+
+    /**
+     * Resolves relative paths in theme.json styles to theme absolute paths
+     * and returns them in an array that can be embedded
+     * as the value of `_link` object in REST API responses.
+     *
+     * @since 6.6.0
+     *
+     * @param WP_Theme_JSON  $theme_json A theme json instance.
+     * @return array An array of resolved paths.
+     */
+    public static function get_resolved_theme_uris( $theme_json ) {
+        $resolved_theme_uris = array();
+
+        if ( ! $theme_json instanceof WP_Theme_JSON ) {
+            return $resolved_theme_uris;
+        }
+
+        $theme_json_data = $theme_json->get_raw_data();
+
+        // Top level styles.
+        $background_image_url = isset( $theme_json_data['styles']['background']['backgroundImage']['url'] ) ? $theme_json_data['styles']['background']['backgroundImage']['url'] : null;
+
+        /*
+         * The same file convention when registering web fonts.
+         * See: WP_Font_Face_Resolver:: to_theme_file_uri.
+         */
+        $placeholder = 'file:./';
+        if (
+            isset( $background_image_url ) &&
+            is_string( $background_image_url ) &&
+            // Skip if the src doesn't start with the placeholder, as there's nothing to replace.
+            str_starts_with( $background_image_url, $placeholder )
+        ) {
+            $file_type          = wp_check_filetype( $background_image_url );
+            $src_url            = str_replace( $placeholder, '', $background_image_url );
+            $resolved_theme_uri = array(
+                'name'   => $background_image_url,
+                'href'   => sanitize_url( get_theme_file_uri( $src_url ) ),
+                'target' => 'styles.background.backgroundImage.url',
+            );
+            if ( isset( $file_type['type'] ) ) {
+                $resolved_theme_uri['type'] = $file_type['type'];
+            }
+            $resolved_theme_uris[] = $resolved_theme_uri;
+        }
+
+        return $resolved_theme_uris;
+    }
+
+    /**
+     * Resolves relative paths in theme.json styles to theme absolute paths
+     * and merges them with incoming theme JSON.
+     *
+     * @since 6.6.0
+     *
+     * @param WP_Theme_JSON  $theme_json A theme json instance.
+     * @return WP_Theme_JSON Theme merged with resolved paths, if any found.
+     */
+    public static function resolve_theme_file_uris( $theme_json ) {
+        $resolved_urls = static::get_resolved_theme_uris( $theme_json );
+        if ( empty( $resolved_urls ) ) {
+            return $theme_json;
+        }
+
+        $resolved_theme_json_data = array(
+            'version' => WP_Theme_JSON::LATEST_SCHEMA,
+        );
+
+        foreach ( $resolved_urls as $resolved_url ) {
+            $path = explode( '.', $resolved_url['target'] );
+            _wp_array_set( $resolved_theme_json_data, $path, $resolved_url['href'] );
+        }
+
+        $theme_json->merge( new WP_Theme_JSON( $resolved_theme_json_data ) );
+
+        return $theme_json;
+    }
 }