-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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.
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
[Fonts API] Automatically enqueue user-selected fonts #50297
Merged
hellofromtonya
merged 3 commits into
trunk
from
try/automatic-enqueue-user-selected-fonts
May 9, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
<?php | ||
/** | ||
* WP_Fonts_Resolver class. | ||
* | ||
* @package WordPress | ||
* @subpackage Fonts API | ||
* @since X.X.X | ||
*/ | ||
|
||
if ( class_exists( 'WP_Fonts_Resolver' ) ) { | ||
return; | ||
} | ||
|
||
/** | ||
* The Fonts API Resolver abstracts the processing of different data sources | ||
* (such as theme.json and global styles) for font interactions with the API. | ||
* | ||
* This class is for internal core usage and is not supposed to be used by | ||
* extenders (plugins and/or themes). | ||
* | ||
* @access private | ||
*/ | ||
class WP_Fonts_Resolver { | ||
/** | ||
* Defines the key structure in global styles to the fontFamily | ||
* user-selected font. | ||
* | ||
* @since X.X.X | ||
* | ||
* @var string[][] | ||
*/ | ||
protected static $global_styles_font_family_structure = array( | ||
array( 'elements', 'link', 'typography', 'fontFamily' ), | ||
array( 'elements', 'heading', 'typography', 'fontFamily' ), | ||
array( 'elements', 'caption', 'typography', 'fontFamily' ), | ||
array( 'elements', 'button', 'typography', 'fontFamily' ), | ||
array( 'typography', 'fontFamily' ), | ||
); | ||
|
||
/** | ||
* Enqueues user-selected fonts via global styles. | ||
* | ||
* @since X.X.X | ||
* | ||
* @return array User selected font-families when exists, else empty array. | ||
*/ | ||
public static function enqueue_user_selected_fonts() { | ||
$global_styles = wp_get_global_styles(); | ||
$user_selected_fonts = static::get_user_selected_fonts( $global_styles ); | ||
if ( empty( $user_selected_fonts ) ) { | ||
return array(); | ||
} | ||
|
||
wp_enqueue_fonts( $user_selected_fonts ); | ||
return $user_selected_fonts; | ||
} | ||
|
||
/** | ||
* Gets the user-selected font-family handles. | ||
* | ||
* @since X.X.X | ||
* | ||
* @param array $global_styles Global styles potentially containing user-selected fonts. | ||
* @return array User-selected font-families. | ||
*/ | ||
private static function get_user_selected_fonts( array $global_styles ) { | ||
$font_families = array(); | ||
|
||
foreach ( static::$global_styles_font_family_structure as $path ) { | ||
$style_value = _wp_array_get( $global_styles, $path, '' ); | ||
|
||
$font_family = static::get_value_from_style( $style_value ); | ||
if ( '' !== $font_family ) { | ||
$font_families[] = $font_family; | ||
} | ||
} | ||
|
||
return array_unique( $font_families ); | ||
} | ||
|
||
/** | ||
* Get the value (i.e. preset slug) from the given style value. | ||
* | ||
* @since X.X.X | ||
* | ||
* @param string $style The style to parse. | ||
* @param string $preset_type Optional. The type to parse. Default 'font-family'. | ||
* @return string Preset slug. | ||
*/ | ||
private static function get_value_from_style( $style, $preset_type = 'font-family' ) { | ||
if ( '' === $style ) { | ||
return ''; | ||
} | ||
|
||
$starting_pattern = "var:preset|{$preset_type}|"; | ||
if ( ! str_starts_with( $style, $starting_pattern ) ) { | ||
return ''; | ||
} | ||
|
||
return substr( $style, strlen( $starting_pattern ) ); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👋 What's the intention of this code? My reading is that we are using the
var:preset|...
syntax to detect whether the font is provided by the user or anyone else (theme, default). This doesn't work, as the theme can also use thevar:...
syntax.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I created a test case for this at https://github.com/WordPress/gutenberg/compare/try/fonts-api-bug-test-case?expand=1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I ran into this while fixing this issue #50499 See also core-editor slack https://wordpress.slack.com/archives/C02QB2JS7/p1683704524419649
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The intent of this code is to get all of the user "selected" fonts, meaning the fonts a user selects when using Site Editor > Styles > Typography UI.
Theme fonts defined in its
theme.json
are already automatically enqueued after registering all of its fonts.Before this PR, plugins had to detect if a user selected any of their fonts and then the plugin had to enqueue those fonts. With this PR, the detection and enqueuing of their fonts is done within the API.