Font Library: add global configuration variables for font directory

[madhusudhand]

What?

It adds following configuration variables for the font path.

• WP_FONT_DIR: absolute path where fonts are uploaded to and loaded from. When not set, plugin will fall back to WP_CONTENT_DIR/fonts as default value.
• WP_FONT_URL: full url to the font directory. It should be set when a custom path is set for WP_FONT_DIR. When not set, it defaults to content_url( 'fonts' )

Why?

It enables to set a custom directory as font directory.

Testing Instructions

Case 1:

1. Upload / install a font from the font library modal in global styles.
2. It should by default upload the fonts to /wp-content/fonts and the font url should be set to site_url/wp-content/fonts/your-font.ttf

Case 2:

1. Define the following variables in wp-config.php
2. define( 'WP_FONT_DIR', '/var/www/html/wp-content/new-font-dir');
3. define( 'WP_FONT_URL', '//your.site/wp-content/new-font-dir');
4. Now repeat the above steps to install a font.
5. Fonts must be installed in the new path.

Also, validate the following use cases.

1. with and without a trailing slash
2. with and without protocol defined in the URL

Screenshots or screencast

NA

Related

Related discussion is here

fixes #55063

[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-library.php
❔ phpunit/tests/fonts/font-library/wpFontLibrary/setUploadDir.php

[github-actions]

Flaky tests detected in 8bfa658.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7206100374
📝 Reported issues:

• [Flaky Test] it should lock the root Navigation block in the editor #57017 in /test/e2e/specs/site-editor/navigation-editor.spec.js
• [Flaky Test] should display the "Manage Fonts" icon #56776 in /test/e2e/specs/site-editor/font-library.spec.js

[jffng]

Nice one @madhusudhand!

This worked as expected under all the test conditions provided. We should be sure to document this one when the time comes.

[creativecoder]

I don't have the full history of feedback here, but my first instinct is to treat the fonts directory more like the uploads folder, rather than the theme or plugin folders.

That is, add a filter for it (like upload_dir) rather than add a constant for it.

Also, is there a need to define WP_FONT_DIR and WP_FONT_URL separately? Wouldn't the url need to be based on the dir path?

[jffng]

add a filter for it (like upload_dir) rather than add a constant for it.

I believe we are already filtering it:

gutenberg/lib/experimental/fonts/font-library/class-wp-font-family.php

Line 613 in ea2ee60

add_filter( 'upload_dir', array( 'WP_Font_Library', 'set_upload_dir' ) );

Also, is there a need to define WP_FONT_DIR and WP_FONT_URL separately? Wouldn't the url need to be based on the dir path?

Could there be cases where the URL may differ from where it is stored in the filesystem?

If we do move forward with separate constants, it's worth noting that it's necessary to define both. Or a compromise could be to base the URL on the WP_FONT_DIR constant if it's defined but the WP_FONT_URL is not.

[creativecoder]

I believe we are already filtering it:

I mean adding an apply_filters( 'fonts_dir', ... call directly within WP_Font_Library::get_fonts_dir, and probably creating a global function wp_fonts_dir that wraps that.

[creativecoder]

Is anything lost by not setting basedir, baseurl, and subdir here? It seems like unexpected things could happen if some of the properties for upload_dir are changed and some are not, but I haven't used this filter before.

[madhusudhand]

Based on the definition of wp_upload_dir, when path is not set, basedir + subdir are used, and when url is not set, baseurl + subdir are used. I think we are not loosing anything here.

[madhusudhand]

Alternatively, we could switch to basedir + subdir where basedir becomes the path set by the variable WP_FONT_DIR and subdir will be the site_id (in case of multi site) and empty for simple sites.
Please refer this

[creativecoder]

Also, is there a need to define WP_FONT_DIR and WP_FONT_URL separately?

Looking more closely, I see that this is what we do for WP_CONTENT_DIR, WP_PLUGIN_DIR, and WPMU_PLUGIN_DIR, so it makes sense to match that convention.

---

Thinking about this a little more, a filter seems quite useful here, for its flexibility.

As an example I could imagine wanting to sort your font files into subdirectories by font family or by file type (similar to how media uploads can be sorted into subfolders). A filter would support adding logic to do this.

---

Looking at how uploads works brings multisite to mind. Have we thought about this at all? Should each site have its own font folder, or should there be one shared folder? If the fonts are shared, how do we make sure one site doesn't delete another site's fonts?

Multisite seems like a piece of the puzzle for how we add font directory configuration. 🤔

[madhusudhand]

@creativecoder

Also, is there a need to define WP_FONT_DIR and WP_FONT_URL separately? Wouldn't the url need to be based on the dir path?

Since the path for WP_FONT_DIR can be outside WordPress installation, a composed URL for directory outside wouldn't be available via http. In this case a separate http server may serve those assets via URLs and that needs to be configured via this variable.
This is the same case for WP_UPLOAD_DIR as well.

Multisite seems like a piece of the puzzle for how we add font directory configuration. 🤔

Similar to how uploads work, a sub directory /sites/site_id is created for the sub-site fonts in case of a multi site. Font files of the root site are still kept under the main font directory.

[creativecoder]

I'll go ahead and close this one, since it's been incorporated into and replaced by #57697