Font Library: add wp_get_font_dir() function.

[matiasbenedetto]

What?

Adds wp_get_font_dir() function.

Why?

Emulates wp_get_upload_dir() but for the fonts directory.

How?

Implementing wp_get_font_dir() function.

Testing Instructions

Ways to test:

1. Use the font library to install fonts.

2. Run PHP unit tests.

3. Use the function in extension code (theme/plugin) as here:

$fonts = wp_get_font_dir();
echo ( print_r($fonts) );

should print:

Array
(
    [path] => /var/www/html/wp1/wp-content/fonts
    [url] => http://localhost/wp1/wp-content/fonts
    [subdir] => 
    [basedir] => /var/www/html/wp1/wp-content/fonts
    [baseurl] => http://localhost/wp1/wp-content/fonts
    [error] => 
)

4. Modify the value using the filter:

function custom_font_dir( $defaults ) {
		$defaults['path']    = '/custom/path/';
		$defaults['url']     = 'https://example.com/custom/url';
		$defaults['basedir'] = '/custom/path/';
		$defaults['baseurl'] = 'https://example.com/custom/url';
	return $defaults;
}

add_filter( 'font_dir', 'custom_font_dir' );

$fonts = wp_get_font_dir();
echo ( print_r($fonts) );

should print:

Array
(
    [path] => /custom/path/
    [url] => https://example.com/custom/url
    [subdir] => 
    [basedir] => /custom/path/
    [baseurl] => https://example.com/custom/url
    [error] => 
)

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/experimental/fonts/font-library/class-wp-font-family.php
❔ lib/experimental/fonts/font-library/class-wp-font-library.php
❔ lib/experimental/fonts/font-library/class-wp-rest-font-families-controller.php
❔ lib/experimental/fonts/font-library/font-library.php
❔ phpunit/tests/fonts/font-library/wpFontFamily/base.php
❔ phpunit/tests/fonts/font-library/wpRestFontFamiliesController/base.php
❔ phpunit/tests/fonts/font-library/fontsDir.php

[jffng]

Still works as expected and tests pass, I left a couple minor comments.

[jffng]

Sorry I should have asked in the previous PR, but are we including $subdir just to match the wp_upload_dir function? What is the use for it?

[matiasbenedetto]

Yes, I think we should include the subdir property to match wp_get_upload_dir() because we are using the output of this function to update upload_dir filter before uploading fonts. Currently, we are not using it in the font library related code. It is used just in core's _wp_upload_dir to set the /year/month sub directory:

https://github.com/WordPress/wordpress-develop/blob/ddb67a0099c9912c46a22374bcf90e5aac2f25e3/src/wp-includes/functions.php#L2503-L2524

[jffng]

The function and filter are named singularly (font_dir), but the default path is plural (fonts). Does it make sense that these are different?

[matiasbenedetto]

I think so because we are following the pattern from core, the filter name is upload_dir and the folder is uploads.