mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-25 23:33:22 +02:00
Instead of getting the name from the optional `'name'` field, the font-family name now comes from the required `'fontFamily'` field. This change fixes a back-compat (BC) break in how the font-family name is pulled from the incoming font data in the `WP_Font_Face_Resolver`. Why? WP Core does not require the `'name'` field in theme.json. For themes that do not declare it, that set of font variations is ignored, thus causing a BC break from how the stopgap code worked (see [53282]). However, `WP_Theme_JSON` schema does require the `fontFamily` field in each of the `typography.fontFamilies`. == Other details: Includes a parser to extract the first entry when a `fontFamily` field has a comma-separated list of font-families, e.g. `Inter, sans-serif`. References: * Merge from Gutenberg's PR https://github.com/WordPress/gutenberg/pull/54615. Follow-up to [56500], [53282]. Props ironprogrammer, hellofromTonya, mmaattiiaass, pbking. Fixes #59165. Built from https://develop.svn.wordpress.org/trunk@56688 git-svn-id: http://core.svn.wordpress.org/trunk@56200 1a063a9b-81f0-0310-95a4-ce76da25c4cd
179 lines
5.0 KiB
PHP
179 lines
5.0 KiB
PHP
<?php
|
|
/**
|
|
* WP_Font_Face_Resolver class.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Fonts
|
|
* @since 6.4.0
|
|
*/
|
|
|
|
/**
|
|
* The Font Face Resolver abstracts the processing of different data sources
|
|
* (such as theme.json) for processing within the Font Face.
|
|
*
|
|
* This class is for internal core usage and is not supposed to be used by
|
|
* extenders (plugins and/or themes).
|
|
*
|
|
* @access private
|
|
*/
|
|
class WP_Font_Face_Resolver {
|
|
|
|
/**
|
|
* Gets fonts defined in theme.json.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @return array Returns the font-families, each with their font-face variations.
|
|
*/
|
|
public static function get_fonts_from_theme_json() {
|
|
$settings = wp_get_global_settings();
|
|
|
|
// Bail out early if there are no font settings.
|
|
if ( empty( $settings['typography']['fontFamilies'] ) ) {
|
|
return array();
|
|
}
|
|
|
|
return static::parse_settings( $settings );
|
|
}
|
|
|
|
/**
|
|
* Parse theme.json settings to extract font definitions with variations grouped by font-family.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @param array $settings Font settings to parse.
|
|
* @return array Returns an array of fonts, grouped by font-family.
|
|
*/
|
|
private static function parse_settings( array $settings ) {
|
|
$fonts = array();
|
|
|
|
foreach ( $settings['typography']['fontFamilies'] as $font_families ) {
|
|
foreach ( $font_families as $definition ) {
|
|
|
|
// Skip if "fontFace" is not defined, meaning there are no variations.
|
|
if ( empty( $definition['fontFace'] ) ) {
|
|
continue;
|
|
}
|
|
|
|
// Skip if "fontFamily" is not defined.
|
|
if ( empty( $definition['fontFamily'] ) ) {
|
|
continue;
|
|
}
|
|
|
|
$font_family_name = static::maybe_parse_name_from_comma_separated_list( $definition['fontFamily'] );
|
|
|
|
// Skip if no font family is defined.
|
|
if ( empty( $font_family_name ) ) {
|
|
continue;
|
|
}
|
|
|
|
// Prepare the fonts array structure for this font-family.
|
|
if ( ! array_key_exists( $font_family_name, $fonts ) ) {
|
|
$fonts[ $font_family_name ] = array();
|
|
}
|
|
|
|
$fonts[ $font_family_name ] = static::convert_font_face_properties( $definition['fontFace'], $font_family_name );
|
|
}
|
|
}
|
|
|
|
return $fonts;
|
|
}
|
|
|
|
/**
|
|
* Parse font-family name from comma-separated lists.
|
|
*
|
|
* If the given `fontFamily` is a comma-separated lists (example: "Inter, sans-serif" ),
|
|
* parse and return the fist font from the list.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @param string $font_family Font family `fontFamily' to parse.
|
|
* @return string Font-family name.
|
|
*/
|
|
private static function maybe_parse_name_from_comma_separated_list( $font_family ) {
|
|
if ( str_contains( $font_family, ',' ) ) {
|
|
$font_family = explode( ',', $font_family )[0];
|
|
}
|
|
|
|
return trim( $font_family, "\"'" );
|
|
}
|
|
|
|
/**
|
|
* Converts font-face properties from theme.json format.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @param array $font_face_definition The font-face definitions to convert.
|
|
* @param string $font_family_property The value to store in the font-face font-family property.
|
|
* @return array Converted font-face properties.
|
|
*/
|
|
private static function convert_font_face_properties( array $font_face_definition, $font_family_property ) {
|
|
$converted_font_faces = array();
|
|
|
|
foreach ( $font_face_definition as $font_face ) {
|
|
// Add the font-family property to the font-face.
|
|
$font_face['font-family'] = $font_family_property;
|
|
|
|
// Converts the "file:./" src placeholder into a theme font file URI.
|
|
if ( ! empty( $font_face['src'] ) ) {
|
|
$font_face['src'] = static::to_theme_file_uri( (array) $font_face['src'] );
|
|
}
|
|
|
|
// Convert camelCase properties into kebab-case.
|
|
$font_face = static::to_kebab_case( $font_face );
|
|
|
|
$converted_font_faces[] = $font_face;
|
|
}
|
|
|
|
return $converted_font_faces;
|
|
}
|
|
|
|
/**
|
|
* Converts each 'file:./' placeholder into a URI to the font file in the theme.
|
|
*
|
|
* The 'file:./' is specified in the theme's `theme.json` as a placeholder to be
|
|
* replaced with the URI to the font file's location in the theme. When a "src"
|
|
* beings with this placeholder, it is replaced, converting the src into a URI.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @param array $src An array of font file sources to process.
|
|
* @return array An array of font file src URI(s).
|
|
*/
|
|
private static function to_theme_file_uri( array $src ) {
|
|
$placeholder = 'file:./';
|
|
|
|
foreach ( $src as $src_key => $src_url ) {
|
|
// Skip if the src doesn't start with the placeholder, as there's nothing to replace.
|
|
if ( ! str_starts_with( $src_url, $placeholder ) ) {
|
|
continue;
|
|
}
|
|
|
|
$src_file = str_replace( $placeholder, '', $src_url );
|
|
$src[ $src_key ] = get_theme_file_uri( $src_file );
|
|
}
|
|
|
|
return $src;
|
|
}
|
|
|
|
/**
|
|
* Converts all first dimension keys into kebab-case.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @param array $data The array to process.
|
|
* @return array Data with first dimension keys converted into kebab-case.
|
|
*/
|
|
private static function to_kebab_case( array $data ) {
|
|
foreach ( $data as $key => $value ) {
|
|
$kebab_case = _wp_to_kebab_case( $key );
|
|
$data[ $kebab_case ] = $value;
|
|
if ( $kebab_case !== $key ) {
|
|
unset( $data[ $key ] );
|
|
}
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
}
|