Changeset 57686 for trunk/src/wp-includes/fonts/class-wp-font-collection.php

Timestamp:

02/21/2024 07:24:14 PM (13 months ago)

Author:

swissspidy

Message:

Editor: Ensure font collection metadata can be properly localized.

Updates wp_register_font_collection() and WP_Font_Collection so that only font families can be loaded from a file or URL.
All metadata, such as name, description, and list of font categories, needs to be passed directly in PHP so that it can be properly localized.

Props swissspidy, mmaattiiaass, grantmkin, youknowriad.
Fixes #60509.

File:

• trunk/src/wp-includes/fonts/class-wp-font-collection.php (modified) (8 diffs)

trunk/src/wp-includes/fonts/class-wp-font-collection.php

@@ -47 +47 @@
      * @since 6.5.0
      *
-     * @param string       $slug         Font collection slug.
-     * @param array|string $data_or_file Font collection data array or a path/URL to a JSON file
-     *                                   containing the font collection.
-     *                                   See {@see wp_register_font_collection()} for the supported fields.
-     */
-    public function __construct( $slug, $data_or_file ) {
+     * @param string $slug Font collection slug. May only contain alphanumeric characters, dashes,
+     *                     and underscores. See sanitize_title().
+     * @param array  $args Font collection data. See wp_register_font_collection() for information on accepted arguments.
+     */
+    public function __construct( string $slug, array $args ) {
         $this->slug = sanitize_title( $slug );
         if ( $this->slug !== $slug ) {
@@ -63 +62 @@
         }
 
-        if ( is_array( $data_or_file ) ) {
-            $this->data = $this->sanitize_and_validate_data( $data_or_file );
-        } else {
+        $required_properties = array( 'name', 'font_families' );
+
+        if ( isset( $args['font_families'] ) && is_string( $args['font_families'] ) ) {
             // JSON data is lazy loaded by ::get_data().
-            $this->src = $data_or_file;
-        }
+            $this->src = $args['font_families'];
+            unset( $args['font_families'] );
+
+            $required_properties = array( 'name' );
+        }
+
+        $this->data = $this->sanitize_and_validate_data( $args, $required_properties );
     }
 
@@ -79 +83 @@
      */
     public function get_data() {
+        if ( is_wp_error( $this->data ) ) {
+            return $this->data;
+        }
+
         // If the collection uses JSON data, load it and cache the data/error.
-        if ( $this->src && empty( $this->data ) ) {
+        if ( isset( $this->src ) ) {
             $this->data = $this->load_from_json( $this->src );
         }
@@ -117 +125 @@
         }
 
-        return $url ? $this->load_from_url( $url ) : $this->load_from_file( $file );
+        $data = $url ? $this->load_from_url( $url ) : $this->load_from_file( $file );
+
+        if ( is_wp_error( $data ) ) {
+            return $data;
+        }
+
+        $data = array(
+            'name'          => $this->data['name'],
+            'font_families' => $data['font_families'],
+        );
+
+        if ( isset( $this->data['description'] ) ) {
+            $data['description'] = $this->data['description'];
+        }
+
+        if ( isset( $this->data['categories'] ) ) {
+            $data['categories'] = $this->data['categories'];
+        }
+
+        return $data;
     }
 
@@ -135 +162 @@
         }
 
-        return $this->sanitize_and_validate_data( $data );
+        return $this->sanitize_and_validate_data( $data, array( 'font_families' ) );
     }
 
@@ -155 +182 @@
             $response = wp_safe_remote_get( $url );
             if ( is_wp_error( $response ) || 200 !== wp_remote_retrieve_response_code( $response ) ) {
-                // translators: %s: Font collection URL.
-                return new WP_Error( 'font_collection_request_error', sprintf( __( 'Error fetching the font collection data from "%s".' ), $url ) );
+                return new WP_Error(
+                    'font_collection_request_error',
+                    sprintf(
+                        // translators: %s: Font collection URL.
+                        __( 'Error fetching the font collection data from "%s".' ),
+                        $url
+                    )
+                );
             }
 
@@ -165 +198 @@
 
             // Make sure the data is valid before storing it in a transient.
-            $data = $this->sanitize_and_validate_data( $data );
+            $data = $this->sanitize_and_validate_data( $data, array( 'font_families' ) );
             if ( is_wp_error( $data ) ) {
                 return $data;
@@ -181 +214 @@
      * @since 6.5.0
      *
-     * @param array $data Font collection data to sanitize and validate.
+     * @param array $data                Font collection data to sanitize and validate.
+     * @param array $required_properties Required properties that must exist in the passed data.
      * @return array|WP_Error Sanitized data if valid, otherwise a WP_Error instance.
      */
-    private function sanitize_and_validate_data( $data ) {
+    private function sanitize_and_validate_data( $data, $required_properties = array() ) {
         $schema = self::get_sanitization_schema();
         $data   = WP_Font_Utils::sanitize_from_schema( $data, $schema );
 
-        $required_properties = array( 'name', 'font_families' );
         foreach ( $required_properties as $property ) {
             if ( empty( $data[ $property ] ) ) {