<!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>[57657] trunk: Editor: Format and sanitize font family names according the CSS spec.</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/57657">57657</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/57657","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>youknowriad</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-02-20 07:09:43 +0000 (Tue, 20 Feb 2024)</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'>Editor: Format and sanitize font family names according the CSS spec.
This fixes two bugs in the font library.
- Fonts using special characters were not being rendered properly in the frontend.
- Allows the ability to use generic() in font family names.
Props mmaattiiaass, nithins53, kafleg, vivekawsm, swissspidy, audrasjb.
Fixes <a href="https://core.trac.wordpress.org/ticket/60537">#60537</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfontsclasswpfontcollectionphp">trunk/src/wp-includes/fonts/class-wp-font-collection.php</a></li>
<li><a href="#trunksrcwpincludesfontsclasswpfontutilsphp">trunk/src/wp-includes/fonts/class-wp-font-utils.php</a></li>
<li><a href="#trunktestsphpunittestsfontsfontlibrarywpFontCollectiongetDataphp">trunk/tests/phpunit/tests/fonts/font-library/wpFontCollection/getData.php</a></li>
<li><a href="#trunktestsphpunittestsfontsfontlibrarywpFontUtilssanitizeFontFamilyphp">trunk/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFontFamily.php</a></li>
<li><a href="#trunktestsphpunittestsfontsfontlibrarywpRestFontFamiliesControllerphp">trunk/tests/phpunit/tests/fonts/font-library/wpRestFontFamiliesController.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfontsclasswpfontcollectionphp"></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-collection.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-collection.php 2024-02-19 15:05:46 UTC (rev 57656)
+++ trunk/src/wp-includes/fonts/class-wp-font-collection.php 2024-02-20 07:09:43 UTC (rev 57657)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -219,8 +219,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'font_family_settings' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'sanitize_text_field',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'slug' => 'sanitize_title',
- 'fontFamily' => 'sanitize_text_field',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'slug' => static function ( $value ) {
+ return _wp_to_kebab_case( sanitize_title( $value ) );
+ },
+ 'fontFamily' => 'WP_Font_Utils::sanitize_font_family',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'preview' => 'sanitize_url',
</span><span class="cx" style="display: block; padding: 0 10px"> 'fontFace' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre></div>
<a id="trunksrcwpincludesfontsclasswpfontutilsphp"></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-utils.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-utils.php 2024-02-19 15:05:46 UTC (rev 57656)
+++ trunk/src/wp-includes/fonts/class-wp-font-utils.php 2024-02-20 07:09:43 UTC (rev 57657)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,11 +19,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_Font_Utils {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds surrounding quotes to font family names that contain special characters.
+ *
+ * It follows the recommendations from the CSS Fonts Module Level 4.
+ * @link https://www.w3.org/TR/css-fonts-4/#font-family-prop
+ *
+ * @since 6.5.0
+ *
+ * @param string $item A font family name.
+ * @return string The font family name with surrounding quotes, if necessary.
+ */
+ private static function maybe_add_quotes( $item ) {
+ // Matches strings that are not exclusively alphabetic characters or hyphens, and do not exactly follow the pattern generic(alphabetic characters or hyphens).
+ $regex = '/^(?!generic\([a-zA-Z\-]+\)$)(?!^[a-zA-Z\-]+$).+/';
+ $item = trim( $item );
+ if ( preg_match( $regex, $item ) ) {
+ $item = trim( $item, "\"'" );
+ return '"' . $item . '"';
+ }
+ return $item;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Sanitizes and formats font family names.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * - Applies `sanitize_text_field`
- * - Adds surrounding quotes to names that contain spaces and are not already quoted
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - Applies `sanitize_text_field`.
+ * - Adds surrounding quotes to names containing any characters that are not alphabetic or dashes.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * It follows the recommendations from the CSS Fonts Module Level 4.
+ * @link https://www.w3.org/TR/css-fonts-4/#font-family-prop
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 6.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,26 +62,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return '';
</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 = sanitize_text_field( $font_family );
- $font_families = explode( ',', $font_family );
- $wrapped_font_families = array_map(
- function ( $family ) {
- $trimmed = trim( $family );
- if ( ! empty( $trimmed ) && str_contains( $trimmed, ' ' ) && ! str_contains( $trimmed, "'" ) && ! str_contains( $trimmed, '"' ) ) {
- return '"' . $trimmed . '"';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $output = sanitize_text_field( $font_family );
+ $formatted_items = array();
+ if ( str_contains( $output, ',' ) ) {
+ $items = explode( ',', $output );
+ foreach ( $items as $item ) {
+ $formatted_item = self::maybe_add_quotes( $item );
+ if ( ! empty( $formatted_item ) ) {
+ $formatted_items[] = $formatted_item;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $trimmed;
- },
- $font_families
- );
-
- if ( count( $wrapped_font_families ) === 1 ) {
- $font_family = $wrapped_font_families[0];
- } else {
- $font_family = implode( ', ', $wrapped_font_families );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
+ return implode( ', ', $formatted_items );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- return $font_family;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return self::maybe_add_quotes( $output );
</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></pre></div>
<a id="trunktestsphpunittestsfontsfontlibrarywpFontCollectiongetDataphp"></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-library/wpFontCollection/getData.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/fonts/font-library/wpFontCollection/getData.php 2024-02-19 15:05:46 UTC (rev 57656)
+++ trunk/tests/phpunit/tests/fonts/font-library/wpFontCollection/getData.php 2024-02-20 07:09:43 UTC (rev 57657)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,7 +159,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'font_families' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'font_family_settings' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'fontFamily' => 'Open Sans, sans-serif',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fontFamily' => '"Open Sans", sans-serif',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'slug' => 'open-sans',
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'Open Sans',
</span><span class="cx" style="display: block; padding: 0 10px"> 'fontFace' => array(
</span></span></pre></div>
<a id="trunktestsphpunittestsfontsfontlibrarywpFontUtilssanitizeFontFamilyphp"></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-library/wpFontUtils/sanitizeFontFamily.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFontFamily.php 2024-02-19 15:05:46 UTC (rev 57656)
+++ trunk/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFontFamily.php 2024-02-20 07:09:43 UTC (rev 57657)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,17 +35,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function data_should_sanitize_font_family() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'data_families_with_spaces_and_numbers' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'font_family' => 'Rock 3D , Open Sans,serif',
- 'expected' => '"Rock 3D", "Open Sans", serif',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'font_family' => 'Arial, Rock 3D , Open Sans,serif',
+ 'expected' => 'Arial, "Rock 3D", "Open Sans", serif',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'data_single_font_family' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'font_family' => 'Rock 3D',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => '"Rock 3D"',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'data_no_spaces' => array(
- 'font_family' => 'Rock3D',
- 'expected' => 'Rock3D',
- ),
</del><span class="cx" style="display: block; padding: 0 10px"> 'data_many_spaces_and_existing_quotes' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'font_family' => 'Rock 3D serif, serif,sans-serif, "Open Sans"',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => '"Rock 3D serif", serif, sans-serif, "Open Sans"',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,6 +54,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'font_family' => " Rock 3D</style><script>alert('XSS');</script>\n ",
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => '"Rock 3D"',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'data_font_family_with_generic_names' => array(
+ 'font_family' => 'generic(kai), generic(font[name]), generic(fangsong), Rock 3D',
+ 'expected' => 'generic(kai), "generic(font[name])", generic(fangsong), "Rock 3D"',
+ ),
</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></pre></div>
<a id="trunktestsphpunittestsfontsfontlibrarywpRestFontFamiliesControllerphp"></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-library/wpRestFontFamiliesController.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/fonts/font-library/wpRestFontFamiliesController.php 2024-02-19 15:05:46 UTC (rev 57656)
+++ trunk/tests/phpunit/tests/fonts/font-library/wpRestFontFamiliesController.php 2024-02-20 07:09:43 UTC (rev 57657)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -681,7 +681,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $settings = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'Open Sans',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'fontFamily' => '"Open Sans, "Noto Sans", sans-serif',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fontFamily' => 'Open Sans, "Noto Sans", sans-serif',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'preview' => 'https://s.w.org/images/fonts/16.9/previews/open-sans/open-sans-400-normal.svg',
</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">@@ -700,7 +700,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $expected_settings = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => $settings['name'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'slug' => 'open-sans-2',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'fontFamily' => $settings['fontFamily'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fontFamily' => '"Open Sans", "Noto Sans", sans-serif',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'preview' => $settings['preview'],
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected_settings, $data['font_family_settings'], 'The response font_family_settings should match expected settings.' );
</span></span></pre>
</div>
</div>
</body>
</html>