<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56688] trunk: Fonts: Get font-family name from 'fontFamily' field.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56688">56688</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56688","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-25 21:27:51 +0000 (Mon, 25 Sep 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Fonts: Get font-family name from 'fontFamily' field.
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 <a href="https://core.trac.wordpress.org/changeset/53282">[53282]</a>).
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 <a href="https://core.trac.wordpress.org/changeset/56500">[56500]</a>, <a href="https://core.trac.wordpress.org/changeset/53282">[53282]</a>.
Props ironprogrammer, hellofromTonya, mmaattiiaass, pbking.
Fixes <a href="https://core.trac.wordpress.org/ticket/59165">#59165</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfontsclasswpfontfaceresolverphp">trunk/src/wp-includes/fonts/class-wp-font-face-resolver.php</a></li>
<li><a href="#trunktestsphpunittestsfontsfontfacewpFontFaceResolvergetFontsFromThemeJsonphp">trunk/tests/phpunit/tests/fonts/font-face/wpFontFaceResolver/getFontsFromThemeJson.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfontsclasswpfontfaceresolverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/fonts/class-wp-font-face-resolver.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/fonts/class-wp-font-face-resolver.php 2023-09-25 21:03:19 UTC (rev 56687)
+++ trunk/src/wp-includes/fonts/class-wp-font-face-resolver.php 2023-09-25 21:27:51 UTC (rev 56688)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,24 +50,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $settings['typography']['fontFamilies'] as $font_families ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $font_families as $definition ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Skip if font-family "name" is not defined.
- if ( empty( $definition['name'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Skip if "fontFace" is not defined, meaning there are no variations.
+ if ( empty( $definition['fontFace'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Skip if "fontFace" is not defined, meaning there are no variations.
- if ( empty( $definition['fontFace'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Skip if "fontFamily" is not defined.
+ if ( empty( $definition['fontFamily'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $font_family = $definition['name'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $font_family_name = static::maybe_parse_name_from_comma_separated_list( $definition['fontFamily'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Skip if no font family is defined.
+ if ( empty( $font_family_name ) ) {
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Prepare the fonts array structure for this font-family.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! array_key_exists( $font_family, $fonts ) ) {
- $fonts[ $font_family ] = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! array_key_exists( $font_family_name, $fonts ) ) {
+ $fonts[ $font_family_name ] = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $fonts[ $font_family ] = static::convert_font_face_properties( $definition['fontFace'], $font_family );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fonts[ $font_family_name ] = static::convert_font_face_properties( $definition['fontFace'], $font_family_name );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,6 +80,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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, "\"'" );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Converts font-face properties from theme.json format.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.4.0
</span></span></pre></div>
<a id="trunktestsphpunittestsfontsfontfacewpFontFaceResolvergetFontsFromThemeJsonphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/fonts/font-face/wpFontFaceResolver/getFontsFromThemeJson.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/fonts/font-face/wpFontFaceResolver/getFontsFromThemeJson.php 2023-09-25 21:03:19 UTC (rev 56687)
+++ trunk/tests/phpunit/tests/fonts/font-face/wpFontFaceResolver/getFontsFromThemeJson.php 2023-09-25 21:27:51 UTC (rev 56688)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,4 +96,108 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @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',
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>