class-jetpack-google-font-face.php
250 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Jetpack_Google_Font_Face class |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | /** |
| 9 | * Jetpack Google Font Face disables Font Face hooks in Core that prints **ALL** font faces. |
| 10 | * Instead, it collects fonts that are used in global styles or block-level settings and |
| 11 | * print those fonts in use. |
| 12 | */ |
| 13 | class Jetpack_Google_Font_Face { |
| 14 | /** |
| 15 | * The fonts that are used in global styles or block-level settings. |
| 16 | * |
| 17 | * @var array |
| 18 | */ |
| 19 | private $fonts_in_use = array(); |
| 20 | |
| 21 | /** |
| 22 | * The constructor. |
| 23 | */ |
| 24 | public function __construct() { |
| 25 | // Turns off hooks to print fonts |
| 26 | add_action( 'wp_loaded', array( $this, 'wp_loaded' ) ); |
| 27 | add_action( 'current_screen', array( $this, 'current_screen' ), 10 ); |
| 28 | |
| 29 | // Collect and print fonts in use |
| 30 | add_action( 'wp_head', array( $this, 'print_font_faces' ), 50 ); |
| 31 | add_filter( 'pre_render_block', array( $this, 'collect_block_fonts' ), 10, 2 ); |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Turn off hooks to print fonts on frontend |
| 36 | */ |
| 37 | public function wp_loaded() { |
| 38 | remove_action( 'wp_head', 'wp_print_fonts', 50 ); |
| 39 | remove_action( 'wp_head', 'wp_print_font_faces', 50 ); |
| 40 | } |
| 41 | |
| 42 | /** |
| 43 | * Turn off hooks to print fonts on wp-admin, except for GB editor pages. |
| 44 | */ |
| 45 | public function current_screen() { |
| 46 | remove_action( 'admin_print_styles', 'wp_print_fonts', 50 ); |
| 47 | |
| 48 | if ( ! $this->is_block_editor() ) { |
| 49 | remove_action( 'admin_print_styles', 'wp_print_font_faces', 50 ); |
| 50 | } |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Print fonts that are used in global styles or block-level settings. |
| 55 | */ |
| 56 | public function print_font_faces() { |
| 57 | // @todo Remove suppression when we drop support for core versions without the Font library. |
| 58 | // @phan-suppress-next-line PhanUndeclaredClassMethod -- This file is only loaded (via modules/google-fonts/load.php) when core's new Font library exists. @phan-suppress-current-line UnusedPluginSuppression |
| 59 | $fonts = WP_Font_Face_Resolver::get_fonts_from_theme_json(); |
| 60 | $font_slug_aliases = $this->get_font_slug_aliases(); |
| 61 | $fonts_to_print = array(); |
| 62 | |
| 63 | $this->collect_global_styles_fonts(); |
| 64 | $fonts_in_use = array_values( array_unique( $this->fonts_in_use, SORT_STRING ) ); |
| 65 | $fonts_in_use = array_map( |
| 66 | function ( $font_slug ) use ( $font_slug_aliases ) { |
| 67 | return $font_slug_aliases[ $font_slug ] ?? $font_slug; |
| 68 | }, |
| 69 | $this->fonts_in_use |
| 70 | ); |
| 71 | |
| 72 | foreach ( $fonts as $font_faces ) { |
| 73 | $font_family = $font_faces[0]['font-family'] ?? ''; |
| 74 | if ( in_array( $this->format_font( $font_family ), $fonts_in_use, true ) ) { |
| 75 | $fonts_to_print[ $font_family ] = $font_faces; |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | if ( ! empty( $fonts_to_print ) ) { |
| 80 | // @todo Remove suppression when we drop support for core versions without the Font library. |
| 81 | // @phan-suppress-next-line PhanUndeclaredFunction -- This file is only loaded (via modules/google-fonts/load.php) when core's new Font library exists. @phan-suppress-current-line UnusedPluginSuppression |
| 82 | wp_print_font_faces( $fonts_to_print ); |
| 83 | } |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Collect fonts used for global styles settings. |
| 88 | */ |
| 89 | public function collect_global_styles_fonts() { |
| 90 | $global_styles = wp_get_global_styles(); |
| 91 | |
| 92 | $global_styles_font_slug = $this->get_font_slug_from_setting( $global_styles ); |
| 93 | if ( $global_styles_font_slug ) { |
| 94 | $this->add_font( $global_styles_font_slug ); |
| 95 | } |
| 96 | |
| 97 | if ( isset( $global_styles['blocks'] ) ) { |
| 98 | foreach ( $global_styles['blocks'] as $setting ) { |
| 99 | $font_slug = $this->get_font_slug_from_setting( $setting ); |
| 100 | |
| 101 | if ( $font_slug ) { |
| 102 | $this->add_font( $font_slug ); |
| 103 | } |
| 104 | } |
| 105 | } |
| 106 | |
| 107 | if ( isset( $global_styles['elements'] ) ) { |
| 108 | foreach ( $global_styles['elements'] as $setting ) { |
| 109 | $font_slug = $this->get_font_slug_from_setting( $setting ); |
| 110 | |
| 111 | if ( $font_slug ) { |
| 112 | $this->add_font( $font_slug ); |
| 113 | } |
| 114 | } |
| 115 | } |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Collect fonts used for block-level settings. |
| 120 | * |
| 121 | * @filter pre_render_block |
| 122 | * |
| 123 | * @param string|null $content The pre-rendered content. Default null. |
| 124 | * @param array $parsed_block The block being rendered. |
| 125 | */ |
| 126 | public function collect_block_fonts( $content, $parsed_block ) { |
| 127 | if ( ! is_admin() && isset( $parsed_block['attrs']['fontFamily'] ) ) { |
| 128 | $block_font_family = $parsed_block['attrs']['fontFamily']; |
| 129 | $this->add_font( $block_font_family ); |
| 130 | } |
| 131 | |
| 132 | return $content; |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Add the specify font to the fonts_in_use list. |
| 137 | * |
| 138 | * @param string $font_slug The font slug. |
| 139 | */ |
| 140 | public function add_font( $font_slug ) { |
| 141 | $this->fonts_in_use[] = $this->format_font( $font_slug ); |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Format the given font slug. |
| 146 | * |
| 147 | * @example "ABeeZee" formats to "abeezee" |
| 148 | * @example "ADLaM Display" formats to "adlam-display" |
| 149 | * @param string $font_slug The font slug. |
| 150 | * @return string The formatted font slug. |
| 151 | */ |
| 152 | public function format_font( $font_slug ) { |
| 153 | return _wp_to_kebab_case( strtolower( $font_slug ) ); |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Get the font slug aliases that maps the font slug to the font family if they are different. |
| 158 | * |
| 159 | * The font definition may define an alias slug name, so we have to add the map from the slug name to the font family. |
| 160 | * See https://github.com/WordPress/twentytwentyfour/blob/df92472089ede6fae5924c124a93c843b84e8cbd/theme.json#L215. |
| 161 | */ |
| 162 | public function get_font_slug_aliases() { |
| 163 | $font_slug_aliases = array(); |
| 164 | |
| 165 | $theme_json = WP_Theme_JSON_Resolver::get_theme_data(); |
| 166 | $raw_data = $theme_json->get_data(); |
| 167 | if ( ! empty( $raw_data['settings']['typography']['fontFamilies'] ) ) { |
| 168 | foreach ( $raw_data['settings']['typography']['fontFamilies'] as $font ) { |
| 169 | $font_family_name = $this->format_font( $this->get_font_family_name( $font ) ); |
| 170 | $font_slug = $font['slug'] ?? ''; |
| 171 | if ( $font_slug && $font_slug !== $font_family_name && ! array_key_exists( $font_slug, $font_slug_aliases ) ) { |
| 172 | $font_slug_aliases[ $font_slug ] = $font_family_name; |
| 173 | } |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | return $font_slug_aliases; |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * Get the font family name from a font. |
| 182 | * |
| 183 | * @param array $font The font definition object. |
| 184 | */ |
| 185 | public static function get_font_family_name( $font ) { |
| 186 | $font_family = $font['fontFamily']; |
| 187 | if ( str_contains( $font_family, ',' ) ) { |
| 188 | $font_family = explode( ',', $font_family )[0]; |
| 189 | } |
| 190 | |
| 191 | return trim( $font_family, "\"'" ); |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Get the font family slug from a settings array. |
| 196 | * |
| 197 | * @param array $setting The settings object. |
| 198 | * |
| 199 | * @return string|null |
| 200 | */ |
| 201 | public function get_font_slug_from_setting( $setting ) { |
| 202 | if ( ! isset( $setting['typography']['fontFamily'] ) ) { |
| 203 | return null; |
| 204 | } |
| 205 | |
| 206 | $font_family = $setting['typography']['fontFamily']; |
| 207 | |
| 208 | // The font family may be a reference to a path to the value stored at that location, |
| 209 | // e.g.: { "ref": "styles.elements.heading.typography.fontFamily" }. |
| 210 | // Ignore it as we also get the value stored at that location from the setting. |
| 211 | if ( ! is_string( $font_family ) ) { |
| 212 | return null; |
| 213 | } |
| 214 | |
| 215 | // Full string: var(--wp--preset--font-family--slug). |
| 216 | // We do not care about the origin of the font, only its slug. |
| 217 | preg_match( '/font-family--(?P<slug>.+)\)$/', $font_family, $matches ); |
| 218 | |
| 219 | if ( isset( $matches['slug'] ) ) { |
| 220 | return $matches['slug']; |
| 221 | } |
| 222 | |
| 223 | // Full string: var:preset|font-family|slug |
| 224 | // We do not care about the origin of the font, only its slug. |
| 225 | preg_match( '/font-family\|(?P<slug>.+)$/', $font_family, $matches ); |
| 226 | |
| 227 | if ( isset( $matches['slug'] ) ) { |
| 228 | return $matches['slug']; |
| 229 | } |
| 230 | |
| 231 | return $font_family; |
| 232 | } |
| 233 | |
| 234 | /** |
| 235 | * Check if the current screen is the block editor. |
| 236 | * |
| 237 | * @return bool |
| 238 | */ |
| 239 | public function is_block_editor() { |
| 240 | if ( function_exists( 'get_current_screen' ) ) { |
| 241 | $current_screen = get_current_screen(); |
| 242 | if ( ! empty( $current_screen ) && method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) { |
| 243 | return true; |
| 244 | } |
| 245 | } |
| 246 | |
| 247 | return false; |
| 248 | } |
| 249 | } |
| 250 |