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

Timestamp:

02/21/2024 07:24:14 PM (15 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.php (modified) (3 diffs)

trunk/src/wp-includes/fonts.php

@@ -54 +54 @@
 
 /**
- * Registers a new Font Collection in the Font Library.
- *
- * @since 6.5.0
- *
- * @param string       $slug Font collection slug. May only contain alphanumeric characters, dashes,
+ * Registers a new font collection in the font library.
+ *
+ * See {@link https://schemas.wp.org/trunk/font-collection.json} for the schema
+ * the font collection data must adhere to.
+ *
+ * @since 6.5.0
+ *
+ * @param string $slug Font collection slug. May only contain alphanumeric characters, dashes,
  *                     and underscores. See sanitize_title().
- * @param array|string $data_or_file {
- *     Font collection data array or a path/URL to a JSON file containing the font collection.
- *
- *     @link https://schemas.wp.org/trunk/font-collection.json
- *
- *     @type string $name           Required. Name of the font collection shown in the Font Library.
- *     @type string $description    Optional. A short descriptive summary of the font collection. Default empty.
- *     @type array  $font_families  Required. Array of font family definitions that are in the collection.
- *     @type array  $categories     Optional. Array of categories, each with a name and slug, that are used by the
- *                                  fonts in the collection. Default empty.
+ * @param array  $args {
+ *     Font collection data.
+ *
+ *     @type string       $name          Required. Name of the font collection shown in the Font Library.
+ *     @type string       $description   Optional. A short descriptive summary of the font collection. Default empty.
+ *     @type array|string $font_families Required. Array of font family definitions that are in the collection,
+ *                                       or a string containing the path or URL to a JSON file containing the font collection.
+ *     @type array        $categories    Optional. Array of categories, each with a name and slug, that are used by the
+ *                                       fonts in the collection. Default empty.
  * }
  * @return WP_Font_Collection|WP_Error A font collection if it was registered
  *                                     successfully, or WP_Error object on failure.
  */
-function wp_register_font_collection( $slug, $data_or_file ) {
-    return WP_Font_Library::get_instance()->register_font_collection( $slug, $data_or_file );
+function wp_register_font_collection( string $slug, array $args ) {
+    return WP_Font_Library::get_instance()->register_font_collection( $slug, $args );
 }
 
@@ -86 +88 @@
  * @return bool True if the font collection was unregistered successfully, else false.
  */
-function wp_unregister_font_collection( $slug ) {
+function wp_unregister_font_collection( string $slug ) {
     return WP_Font_Library::get_instance()->unregister_font_collection( $slug );
 }
@@ -197 +199 @@
  */
 function _wp_register_default_font_collections() {
-    wp_register_font_collection( 'google-fonts', 'https://s.w.org/images/fonts/17.7/collections/google-fonts-with-preview.json' );
-}
+    wp_register_font_collection(
+        'google-fonts',
+        array(
+            'name'          => _x( 'Google Fonts', 'font collection name' ),
+            'description'   => __( 'Install from Google Fonts. Fonts are copied to and served from your site.' ),
+            'font_families' => 'https://s.w.org/images/fonts/17.7/collections/google-fonts-with-preview.json',
+            'categories'    => array(
+                array(
+                    'name' => _x( 'Sans Serif', 'font category' ),
+                    'slug' => 'sans-serif',
+                ),
+                array(
+                    'name' => _x( 'Display', 'font category' ),
+                    'slug' => 'display',
+                ),
+                array(
+                    'name' => _x( 'Serif', 'font category' ),
+                    'slug' => 'serif',
+                ),
+                array(
+                    'name' => _x( 'Handwriting', 'font category' ),
+                    'slug' => 'handwriting',
+                ),
+                array(
+                    'name' => _x( 'Monospace', 'font category' ),
+                    'slug' => 'monospace',
+                ),
+            ),
+        )
+    );
+}