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.

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 global fonts #50529

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
109 changes: 109 additions & 0 deletions lib/experimental/fonts-api/class-wp-fonts-resolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<?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() {
$user_selected_fonts = array();
$user_global_styles = WP_Theme_JSON_Resolver_Gutenberg::get_user_data()->get_raw_data();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've learned a bit more how the fonts API works. This is my suggestion for the way forward: #40363 (comment) The first step we should address is #50576 and we can revisit what this PR is trying to achieve after.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are too many threads! For clarity and transparency, #50576 shouldn't block this work.

I'd also like to bring attention to this thread #40363 (comment) (perhaps better comment there):

When a plugin registers more fonts, these are available in any typography panel control: both in the "global styles sidebar" AND in the block inspector of any block that supports font family. If core wants to help plugins, it's not enough to enqueue the fonts picked by the user in the "global styles sidebar", core also needs to enqueue the fonts picked by the user for a given block via its block inspector. It sounds like (this PR) addresses the former, but not the latter.

if ( isset( $user_global_styles['styles'] ) ) {
$user_selected_fonts = static::get_user_selected_fonts( $user_global_styles['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(--wp--preset--{$preset_type}--";
$ending_pattern = ')';
if ( ! str_starts_with( $style, $starting_pattern ) ) {
return '';
}

$offset = strlen( $starting_pattern );
$length = strpos( $style, $ending_pattern ) - $offset;
return substr( $style, $offset, $length );
}
}
24 changes: 11 additions & 13 deletions lib/experimental/fonts-api/fonts-api.php
Original file line number Diff line number Diff line change
Expand Up @@ -198,19 +198,17 @@ function wp_print_fonts( $handles = false ) {
return array();
}

// Skip this reassignment decision-making when using the default of `false`.
if ( false !== $handles ) {
// When `true`, print all registered fonts for the iframed editor.
if ( $in_iframed_editor ) {
$queue = $wp_fonts->queue;
$done = $wp_fonts->done;
$wp_fonts->done = array();
$wp_fonts->queue = $registered;
$handles = false;
} elseif ( empty( $handles ) ) {
// When falsey, assign `false` to print enqueued fonts.
$handles = false;
}
if ( empty( $handles ) ) {
// Automatically enqueue all user-selected fonts.
WP_Fonts_Resolver::enqueue_user_selected_fonts();
$handles = false;
} elseif ( $in_iframed_editor ) {
// Print all registered fonts for the iframed editor.
$queue = $wp_fonts->queue;
$done = $wp_fonts->done;
$wp_fonts->done = array();
$wp_fonts->queue = $registered;
$handles = false;
}

_wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
Expand Down
2 changes: 2 additions & 0 deletions lib/load.php
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@ function gutenberg_is_experiment_enabled( $name ) {
require __DIR__ . '/experimental/fonts-api/register-fonts-from-theme-json.php';
require __DIR__ . '/experimental/fonts-api/class-wp-fonts.php';
require __DIR__ . '/experimental/fonts-api/class-wp-fonts-provider-local.php';
require __DIR__ . '/experimental/fonts-api/class-wp-fonts-resolver.php';
require __DIR__ . '/experimental/fonts-api/fonts-api.php';

// BC Layer files, which will not be backported to WP Core.
require __DIR__ . '/experimental/fonts-api/bc-layer/class-gutenberg-fonts-api-bc-layer.php';
require __DIR__ . '/experimental/fonts-api/bc-layer/webfonts-deprecations.php';
Expand Down
42 changes: 42 additions & 0 deletions phpunit/fonts-api/wp-fonts-testcase.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ abstract class WP_Fonts_TestCase extends WP_UnitTestCase {
*/
protected $orig_theme_dir;

/**
* Administrator ID.
*
* @var int
*/
protected static $administrator_id = 0;

public static function set_up_before_class() {
parent::set_up_before_class();

Expand Down Expand Up @@ -346,4 +353,39 @@ protected function get_handles_for_provider( array $fonts, $provider_id ) {

return $handles;
}

protected static function set_up_admin_user() {
self::$administrator_id = self::factory()->user->create(
array(
'role' => 'administrator',
'user_email' => 'administrator@example.com',
)
);
}

/**
* Sets up the global styles.
*
* @param array $styles User-selected styles structure.
* @param array $theme Optional. Theme to switch to for the test. Default 'fonts-block-theme'.
*/
protected function set_up_global_styles( array $styles, $theme = 'fonts-block-theme' ) {
switch_theme( $theme );

if ( empty( $styles ) ) {
return;
}

// Make sure there is data from the user origin.
wp_set_current_user( self::$administrator_id );
$user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme(), true );
$config = json_decode( $user_cpt['post_content'], true );

// Add the test styles.
$config['styles'] = $styles;

// Update the global styles and settings post.
$user_cpt['post_content'] = wp_json_encode( $config );
wp_update_post( $user_cpt, true, false );
}
}
Loading