Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Font Face: Fix getting the font-family name #5298

Closed
wants to merge 2 commits into from
Closed

Font Face: Fix getting the font-family name #5298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f1de28
Merge PR 54615 Resolver changes
hellofromtonya Sep 25, 2023
4b6a8a6
Add tests
hellofromtonya Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 32 additions & 8 deletions src/wp-includes/fonts/class-wp-font-face-resolver.php
View file
Open in desktop
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
Open in desktop
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',
),
);
}
}
Loading