Skip to content

Commit

Permalink
Fonts: Get font-family name from 'fontFamily' field.
Browse files Browse the repository at this point in the history 
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 WordPress/gutenberg#54615.

Follow-up to [56500], [53282].

Props ironprogrammer, hellofromTonya, mmaattiiaass, pbking.
Fixes #59165.

git-svn-id: https://develop.svn.wordpress.org/trunk@56688 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
@hellofromtonya
hellofromtonya authored and Anton Vlasenko committed Sep 29, 2023
1 parent bcee361 commit 3de944a
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 8 deletions.
40 changes: 32 additions & 8 deletions src/wp-includes/fonts/class-wp-font-face-resolver.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,30 +50,54 @@ private static function parse_settings( array $settings ) {
foreach ( $settings['typography']['fontFamilies'] as $font_families ) {
foreach ( $font_families as $definition ) {

// Skip if font-family "name" is not defined.
if ( empty( $definition['name'] ) ) {
// Skip if "fontFace" is not defined, meaning there are no variations.
if ( empty( $definition['fontFace'] ) ) {
continue;
}

// Skip if "fontFace" is not defined, meaning there are no variations.
if ( empty( $definition['fontFace'] ) ) {
// Skip if "fontFamily" is not defined.
if ( empty( $definition['fontFamily'] ) ) {
continue;
}

$font_family = $definition['name'];
$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, $fonts ) ) {
$fonts[ $font_family ] = array();
if ( ! array_key_exists( $font_family_name, $fonts ) ) {
$fonts[ $font_family_name ] = array();
}

$fonts[ $font_family ] = static::convert_font_face_properties( $definition['fontFace'], $font_family );
$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.
*
Expand Down
104 changes: 104 additions & 0 deletions tests/phpunit/tests/fonts/font-face/wpFontFaceResolver/getFontsFromThemeJson.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,108 @@ public function data_should_replace_src_file_placeholder() {
),
);
}

/**
* @dataProvider data_should_get_font_family_name
*
* @param array $fonts Fonts to test.
* @param string $expected_name Expected font-family name.
*/
public function test_should_get_font_family_name( $fonts, $expected_name ) {
switch_theme( static::FONTS_THEME );

$replace_fonts = static function ( $theme_json_data ) use ( $fonts ) {
$data = $theme_json_data->get_data();

// Replace typography.fontFamilies.
$data['settings']['typography']['fontFamilies']['theme'] = $fonts;

return new WP_Theme_JSON_Data( $data );
};
add_filter( 'wp_theme_json_data_theme', $replace_fonts );
$fonts = WP_Font_Face_Resolver::get_fonts_from_theme_json();
remove_filter( 'wp_theme_json_data_theme', $replace_fonts );

$this->assertArrayHasKey( $expected_name, $fonts );
}

/**
* Data provider.
*
* @return array
*/
public function data_should_get_font_family_name() {
$font_face = array(
array(
'fontFamily' => 'DM Sans',
'fontStretch' => 'normal',
'fontStyle' => 'normal',
'fontWeight' => '400',
'src' => array(
'file:./assets/fonts/dm-sans/DMSans-Regular.woff2',
),
),
array(
'fontFamily' => 'DM Sans',
'fontStretch' => 'normal',
'fontStyle' => 'italic',
'fontWeight' => '400',
'src' => array(
'file:./assets/fonts/dm-sans/DMSans-Regular-Italic.woff2',
),
),
array(
'fontFamily' => 'DM Sans',
'fontStretch' => 'normal',
'fontStyle' => 'italic',
'fontWeight' => '700',
'src' => array(
'file:./assets/fonts/dm-sans/DMSans-Bold.woff2',
),
),
array(
'fontFamily' => 'DM Sans',
'fontStretch' => 'normal',
'fontStyle' => 'italic',
'fontWeight' => '700',
'src' => array(
'file:./assets/fonts/dm-sans/DMSans-Bold-Italic.woff2',
),
),
);

return array(
'name declared' => array(
'fonts' => array(
array(
'fontFamily' => 'DM Sans',
'name' => 'DM Sans Family',
'slug' => 'dm-sans',
'fontFace' => $font_face,
),
),
'expected_name' => 'DM Sans',
),
'name not declared' => array(
'fonts' => array(
array(
'fontFamily' => 'DM Sans',
'slug' => 'dm-sans',
'fontFace' => $font_face,
),
),
'expected_name' => 'DM Sans',
),
'fontFamily comma-separated list' => array(
'fonts' => array(
array(
'fontFamily' => '"DM Sans", sans-serif',
'slug' => 'dm-sans',
'fontFace' => $font_face,
),
),
'expected_name' => 'DM Sans',
),
);
}
}

0 comments on commit 3de944a

Please sign in to comment.