Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WP_Font_Face class.

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Fonts

[5] Fix | Delete

* @since 6.4.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Font Face generates and prints `@font-face` styles for given fonts.

[10] Fix | Delete

[11] Fix | Delete

* @since 6.4.0

[12] Fix | Delete

[13] Fix | Delete

class WP_Font_Face {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* The font-face property defaults.

[17] Fix | Delete

[18] Fix | Delete

* @since 6.4.0

[19] Fix | Delete

[20] Fix | Delete

* @var string[]

[21] Fix | Delete

[22] Fix | Delete

private $font_face_property_defaults = array(

[23] Fix | Delete

'font-family' => '',

[24] Fix | Delete

'font-style' => 'normal',

[25] Fix | Delete

'font-weight' => '400',

[26] Fix | Delete

'font-display' => 'fallback',

[27] Fix | Delete

);

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Valid font-face property names.

[31] Fix | Delete

[32] Fix | Delete

* @since 6.4.0

[33] Fix | Delete

[34] Fix | Delete

* @var string[]

[35] Fix | Delete

[36] Fix | Delete

private $valid_font_face_properties = array(

[37] Fix | Delete

'ascent-override',

[38] Fix | Delete

'descent-override',

[39] Fix | Delete

'font-display',

[40] Fix | Delete

'font-family',

[41] Fix | Delete

'font-stretch',

[42] Fix | Delete

'font-style',

[43] Fix | Delete

'font-weight',

[44] Fix | Delete

'font-variant',

[45] Fix | Delete

'font-feature-settings',

[46] Fix | Delete

'font-variation-settings',

[47] Fix | Delete

'line-gap-override',

[48] Fix | Delete

'size-adjust',

[49] Fix | Delete

'src',

[50] Fix | Delete

'unicode-range',

[51] Fix | Delete

);

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Valid font-display values.

[55] Fix | Delete

[56] Fix | Delete

* @since 6.4.0

[57] Fix | Delete

[58] Fix | Delete

* @var string[]

[59] Fix | Delete

[60] Fix | Delete

private $valid_font_display = array( 'auto', 'block', 'fallback', 'swap', 'optional' );

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Array of font-face style tag's attribute(s)

[64] Fix | Delete

* where the key is the attribute name and the

[65] Fix | Delete

* value is its value.

[66] Fix | Delete

[67] Fix | Delete

* @since 6.4.0

[68] Fix | Delete

[69] Fix | Delete

* @var string[]

[70] Fix | Delete

[71] Fix | Delete

private $style_tag_attrs = array();

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Creates and initializes an instance of WP_Font_Face.

[75] Fix | Delete

[76] Fix | Delete

* @since 6.4.0

[77] Fix | Delete

[78] Fix | Delete

public function __construct() {

[79] Fix | Delete

if (

[80] Fix | Delete

function_exists( 'is_admin' ) && ! is_admin()

[81] Fix | Delete

[82] Fix | Delete

function_exists( 'current_theme_supports' ) && ! current_theme_supports( 'html5', 'style' )

[83] Fix | Delete

) {

[84] Fix | Delete

$this->style_tag_attrs = array( 'type' => 'text/css' );

[85] Fix | Delete

}

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Generates and prints the `@font-face` styles for the given fonts.

[90] Fix | Delete

[91] Fix | Delete

* @since 6.4.0

[92] Fix | Delete

[93] Fix | Delete

* @param array[][] $fonts Optional. The font-families and their font variations.

[94] Fix | Delete

* See {@see wp_print_font_faces()} for the supported fields.

[95] Fix | Delete

* Default empty array.

[96] Fix | Delete

[97] Fix | Delete

public function generate_and_print( array $fonts ) {

[98] Fix | Delete

$fonts = $this->validate_fonts( $fonts );

[99] Fix | Delete

[100] Fix | Delete

// Bail out if there are no fonts are given to process.

[101] Fix | Delete

if ( empty( $fonts ) ) {

[102] Fix | Delete

return;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

$css = $this->get_css( $fonts );

[106] Fix | Delete

[107] Fix | Delete

[108] Fix | Delete

* The font-face CSS is contained within <style> tags and can only be interpreted

[109] Fix | Delete

* as CSS in the browser. Using wp_strip_all_tags() is sufficient escaping

[110] Fix | Delete

* to avoid malicious attempts to close </style> and open a <script>.

[111] Fix | Delete

[112] Fix | Delete

$css = wp_strip_all_tags( $css );

[113] Fix | Delete

[114] Fix | Delete

// Bail out if there is no CSS to print.

[115] Fix | Delete

if ( empty( $css ) ) {

[116] Fix | Delete

return;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

printf( $this->get_style_element(), $css );

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

/**

[123] Fix | Delete

* Validates each of the font-face properties.

[124] Fix | Delete

[125] Fix | Delete

* @since 6.4.0

[126] Fix | Delete

[127] Fix | Delete

* @param array $fonts The fonts to valid.

[128] Fix | Delete

* @return array Prepared font-faces organized by provider and font-family.

[129] Fix | Delete

[130] Fix | Delete

private function validate_fonts( array $fonts ) {

[131] Fix | Delete

$validated_fonts = array();

[132] Fix | Delete

[133] Fix | Delete

foreach ( $fonts as $font_faces ) {

[134] Fix | Delete

foreach ( $font_faces as $font_face ) {

[135] Fix | Delete

$font_face = $this->validate_font_face_declarations( $font_face );

[136] Fix | Delete

// Skip if failed validation.

[137] Fix | Delete

if ( false === $font_face ) {

[138] Fix | Delete

continue;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

$validated_fonts[] = $font_face;

[142] Fix | Delete

}

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

return $validated_fonts;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Validates each font-face declaration (property and value pairing).

[150] Fix | Delete

[151] Fix | Delete

* @since 6.4.0

[152] Fix | Delete

[153] Fix | Delete

* @param array $font_face Font face property and value pairings to validate.

[154] Fix | Delete

* @return array|false Validated font-face on success, or false on failure.

[155] Fix | Delete

[156] Fix | Delete

private function validate_font_face_declarations( array $font_face ) {

[157] Fix | Delete

$font_face = wp_parse_args( $font_face, $this->font_face_property_defaults );

[158] Fix | Delete

[159] Fix | Delete

// Check the font-family.

[160] Fix | Delete

if ( empty( $font_face['font-family'] ) || ! is_string( $font_face['font-family'] ) ) {

[161] Fix | Delete

// @todo replace with `wp_trigger_error()`.

[162] Fix | Delete

_doing_it_wrong(

[163] Fix | Delete

__METHOD__,

[164] Fix | Delete

__( 'Font font-family must be a non-empty string.' ),

[165] Fix | Delete

'6.4.0'

[166] Fix | Delete

);

[167] Fix | Delete

return false;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

// Make sure that local fonts have 'src' defined.

[171] Fix | Delete

if ( empty( $font_face['src'] ) || ( ! is_string( $font_face['src'] ) && ! is_array( $font_face['src'] ) ) ) {

[172] Fix | Delete

// @todo replace with `wp_trigger_error()`.

[173] Fix | Delete

_doing_it_wrong(

[174] Fix | Delete

__METHOD__,

[175] Fix | Delete

__( 'Font src must be a non-empty string or an array of strings.' ),

[176] Fix | Delete

'6.4.0'

[177] Fix | Delete

);

[178] Fix | Delete

return false;

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

// Validate the 'src' property.

[182] Fix | Delete

foreach ( (array) $font_face['src'] as $src ) {

[183] Fix | Delete

if ( empty( $src ) || ! is_string( $src ) ) {

[184] Fix | Delete

// @todo replace with `wp_trigger_error()`.

[185] Fix | Delete

_doing_it_wrong(

[186] Fix | Delete

__METHOD__,

[187] Fix | Delete

__( 'Each font src must be a non-empty string.' ),

[188] Fix | Delete

'6.4.0'

[189] Fix | Delete

);

[190] Fix | Delete

return false;

[191] Fix | Delete

}

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

// Check the font-weight.

[195] Fix | Delete

if ( ! is_string( $font_face['font-weight'] ) && ! is_int( $font_face['font-weight'] ) ) {

[196] Fix | Delete

// @todo replace with `wp_trigger_error()`.

[197] Fix | Delete

_doing_it_wrong(

[198] Fix | Delete

__METHOD__,

[199] Fix | Delete

__( 'Font font-weight must be a properly formatted string or integer.' ),

[200] Fix | Delete

'6.4.0'

[201] Fix | Delete

);

[202] Fix | Delete

return false;

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

// Check the font-display.

[206] Fix | Delete

if ( ! in_array( $font_face['font-display'], $this->valid_font_display, true ) ) {

[207] Fix | Delete

$font_face['font-display'] = $this->font_face_property_defaults['font-display'];

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

// Remove invalid properties.

[211] Fix | Delete

foreach ( $font_face as $property => $value ) {

[212] Fix | Delete

if ( ! in_array( $property, $this->valid_font_face_properties, true ) ) {

[213] Fix | Delete

unset( $font_face[ $property ] );

[214] Fix | Delete

}

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

return $font_face;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Gets the style element for wrapping the `@font-face` CSS.

[222] Fix | Delete

[223] Fix | Delete

* @since 6.4.0

[224] Fix | Delete

[225] Fix | Delete

* @return string The style element.

[226] Fix | Delete

[227] Fix | Delete

private function get_style_element() {

[228] Fix | Delete

$attributes = $this->generate_style_element_attributes();

[229] Fix | Delete

[230] Fix | Delete

return "<style id='wp-fonts-local'{$attributes}>\n%s\n</style>\n";

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Gets the defined <style> element's attributes.

[235] Fix | Delete

[236] Fix | Delete

* @since 6.4.0

[237] Fix | Delete

[238] Fix | Delete

* @return string A string of attribute=value when defined, else, empty string.

[239] Fix | Delete

[240] Fix | Delete

private function generate_style_element_attributes() {

[241] Fix | Delete

$attributes = '';

[242] Fix | Delete

foreach ( $this->style_tag_attrs as $name => $value ) {

[243] Fix | Delete

$attributes .= " {$name}='{$value}'";

[244] Fix | Delete

}

[245] Fix | Delete

return $attributes;

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

/**

[249] Fix | Delete

* Gets the `@font-face` CSS styles for locally-hosted font files.

[250] Fix | Delete

[251] Fix | Delete

* This method does the following processing tasks:

[252] Fix | Delete

* 1. Orchestrates an optimized `src` (with format) for browser support.

[253] Fix | Delete

* 2. Generates the `@font-face` for all its fonts.

[254] Fix | Delete

[255] Fix | Delete

* @since 6.4.0

[256] Fix | Delete

[257] Fix | Delete

* @param array[] $font_faces The font-faces to generate @font-face CSS styles.

[258] Fix | Delete

* @return string The `@font-face` CSS styles.

[259] Fix | Delete

[260] Fix | Delete

private function get_css( $font_faces ) {

[261] Fix | Delete

$css = '';

[262] Fix | Delete

[263] Fix | Delete

foreach ( $font_faces as $font_face ) {

[264] Fix | Delete

// Order the font's `src` items to optimize for browser support.

[265] Fix | Delete

$font_face = $this->order_src( $font_face );

[266] Fix | Delete

[267] Fix | Delete

// Build the @font-face CSS for this font.

[268] Fix | Delete

$css .= '@font-face{' . $this->build_font_face_css( $font_face ) . '}' . "\n";

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

// Don't print the last newline character.

[272] Fix | Delete

return rtrim( $css, "\n" );

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

/**

[276] Fix | Delete

* Orders `src` items to optimize for browser support.

[277] Fix | Delete

[278] Fix | Delete

* @since 6.4.0

[279] Fix | Delete

[280] Fix | Delete

* @param array $font_face Font face to process.

[281] Fix | Delete

* @return array Font-face with ordered src items.

[282] Fix | Delete

[283] Fix | Delete

private function order_src( array $font_face ) {

[284] Fix | Delete

if ( ! is_array( $font_face['src'] ) ) {

[285] Fix | Delete

$font_face['src'] = (array) $font_face['src'];

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

$src = array();

[289] Fix | Delete

$src_ordered = array();

[290] Fix | Delete

[291] Fix | Delete

foreach ( $font_face['src'] as $url ) {

[292] Fix | Delete

// Add data URIs first.

[293] Fix | Delete

if ( str_starts_with( trim( $url ), 'data:' ) ) {

[294] Fix | Delete

$src_ordered[] = array(

[295] Fix | Delete

'url' => $url,

[296] Fix | Delete

'format' => 'data',

[297] Fix | Delete

);

[298] Fix | Delete

continue;

[299] Fix | Delete

}

[300] Fix | Delete

$format = pathinfo( $url, PATHINFO_EXTENSION );

[301] Fix | Delete

$src[ $format ] = $url;

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

// Add woff2.

[305] Fix | Delete

if ( ! empty( $src['woff2'] ) ) {

[306] Fix | Delete

$src_ordered[] = array(

[307] Fix | Delete

'url' => $src['woff2'],

[308] Fix | Delete

'format' => 'woff2',

[309] Fix | Delete

);

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

// Add woff.

[313] Fix | Delete

if ( ! empty( $src['woff'] ) ) {

[314] Fix | Delete

$src_ordered[] = array(

[315] Fix | Delete

'url' => $src['woff'],

[316] Fix | Delete

'format' => 'woff',

[317] Fix | Delete

);

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

// Add ttf.

[321] Fix | Delete

if ( ! empty( $src['ttf'] ) ) {

[322] Fix | Delete

$src_ordered[] = array(

[323] Fix | Delete

'url' => $src['ttf'],

[324] Fix | Delete

'format' => 'truetype',

[325] Fix | Delete

);

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

// Add eot.

[329] Fix | Delete

if ( ! empty( $src['eot'] ) ) {

[330] Fix | Delete

$src_ordered[] = array(

[331] Fix | Delete

'url' => $src['eot'],

[332] Fix | Delete

'format' => 'embedded-opentype',

[333] Fix | Delete

);

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

// Add otf.

[337] Fix | Delete

if ( ! empty( $src['otf'] ) ) {

[338] Fix | Delete

$src_ordered[] = array(

[339] Fix | Delete

'url' => $src['otf'],

[340] Fix | Delete

'format' => 'opentype',

[341] Fix | Delete

);

[342] Fix | Delete

}

[343] Fix | Delete

$font_face['src'] = $src_ordered;

[344] Fix | Delete

[345] Fix | Delete

return $font_face;

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

/**

[349] Fix | Delete

* Builds the font-family's CSS.

[350] Fix | Delete

[351] Fix | Delete

* @since 6.4.0

[352] Fix | Delete

[353] Fix | Delete

* @param array $font_face Font face to process.

[354] Fix | Delete

* @return string This font-family's CSS.

[355] Fix | Delete

[356] Fix | Delete

private function build_font_face_css( array $font_face ) {

[357] Fix | Delete

$css = '';

[358] Fix | Delete

[359] Fix | Delete

[360] Fix | Delete

* Wrap font-family in quotes if it contains spaces

[361] Fix | Delete

* and is not already wrapped in quotes.

[362] Fix | Delete

[363] Fix | Delete

if (

[364] Fix | Delete

str_contains( $font_face['font-family'], ' ' ) &&

[365] Fix | Delete

! str_contains( $font_face['font-family'], '"' ) &&

[366] Fix | Delete

! str_contains( $font_face['font-family'], "'" )

[367] Fix | Delete

) {

[368] Fix | Delete

$font_face['font-family'] = '"' . $font_face['font-family'] . '"';

[369] Fix | Delete

}

[370] Fix | Delete

[371] Fix | Delete

foreach ( $font_face as $key => $value ) {

[372] Fix | Delete

// Compile the "src" parameter.

[373] Fix | Delete

if ( 'src' === $key ) {

[374] Fix | Delete

$value = $this->compile_src( $value );

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

// If font-variation-settings is an array, convert it to a string.

[378] Fix | Delete

if ( 'font-variation-settings' === $key && is_array( $value ) ) {

[379] Fix | Delete

$value = $this->compile_variations( $value );

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

if ( ! empty( $value ) ) {

[383] Fix | Delete

$css .= "$key:$value;";

[384] Fix | Delete

}

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

return $css;

[388] Fix | Delete

}

[389] Fix | Delete

[390] Fix | Delete

/**

[391] Fix | Delete

* Compiles the `src` into valid CSS.

[392] Fix | Delete

[393] Fix | Delete

* @since 6.4.0

[394] Fix | Delete

[395] Fix | Delete

* @param array $value Value to process.

[396] Fix | Delete

* @return string The CSS.

[397] Fix | Delete

[398] Fix | Delete

private function compile_src( array $value ) {

[399] Fix | Delete

$src = '';

[400] Fix | Delete

[401] Fix | Delete

foreach ( $value as $item ) {

[402] Fix | Delete

$src .= ( 'data' === $item['format'] )

[403] Fix | Delete

? ", url({$item['url']})"

[404] Fix | Delete

: ", url('{$item['url']}') format('{$item['format']}')";

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete

$src = ltrim( $src, ', ' );

[408] Fix | Delete

return $src;

[409] Fix | Delete

}

[410] Fix | Delete

[411] Fix | Delete

/**

[412] Fix | Delete

* Compiles the font variation settings.

[413] Fix | Delete

[414] Fix | Delete

* @since 6.4.0

[415] Fix | Delete

[416] Fix | Delete

* @param array $font_variation_settings Array of font variation settings.

[417] Fix | Delete

* @return string The CSS.

[418] Fix | Delete

[419] Fix | Delete

private function compile_variations( array $font_variation_settings ) {

[420] Fix | Delete

$variations = '';

[421] Fix | Delete

[422] Fix | Delete

foreach ( $font_variation_settings as $key => $value ) {

[423] Fix | Delete

$variations .= "$key $value";

[424] Fix | Delete

}

[425] Fix | Delete

[426] Fix | Delete

return $variations;

[427] Fix | Delete

}

[428] Fix | Delete

}

[429] Fix | Delete

[430] Fix | Delete