Font Library: WordPress 6.5 Required Tasks

[matiasbenedetto]

What?

A list of tasks required to merge Font Library in WordPress core 6.5.

To do:

In progress:

• Font Library: Fix checkboxes labeling in the Fonts modal dialog #58299
• Font Library REST API: sanitize font family and font face settings #58590
• Font Library: Add sanitize from schema util #58571
• Font Collections: lazy load json configuration for better performance #58530

Needs decision:

• Font Library: add a 'manage font' exclusive user permission to manage the install/remove fonts. #55280

Done:

• Font Library: replace all references to 6.4.0 by 6.5.0 #55263
• Font Library: Some installed Google fonts don't display in editor or frontend #54706
• Font Library: Uploaded fonts do not always display correctly until after page refresh #55018
• Font Library: Uninstall modal text is redundant #54528
• Font Library: add progress-bar while uploading font assets #54399
• Font Library: unregister font collection #54697
• Font Library: singularize install font families endpoint #57569
• Font Library: Support alternate paths for fonts (WP_FONTS_DIR) #55063
• Font Library: A border is drawn when there are no fonts available #54527
• Font Library: Deleted fonts are displayed in the active fonts list #55019
• Font Library: add JSON schema as reference for font collection JSON data #55266
• Font Library: Add a way to disable it. #55275
• Font Library: Variant list does not update immediately following upload of new variant #54945
• Font Library: Use WOFF2 files for Google Fonts instead of TTF files #55049
• [Fonts API] Remove all files once Font Library is merged #51820
• Font Library: refactor REST API #55278
• Fonts Library: Fonts modal dialog action buttons accessibility #58083
• Font Library: Don't use header, main and footer elements within the Fonts modal dialog tab panels #58065
• Font Library doesn't support Font Faces that have multiple assets. #58173
• Font Library: Improve default fonts collection naming and description #58278

Nice to have:

• Font Library and Global Style revisions: inconsistencies around deleted font assets. #54222
• Font Library: Export fonts on theme export #54226
• Font Picker: Refine, show font preview, and load only active fonts from library #51151
• Font library: add support for detailed error messaging in API and UI #54777
• Font Library: Automatically switch to installed tab after successful upload of fonts. #54779
• Font Library: Some SVG image previews are clipped or not rendered legibly #54688
• Allow for the programatic means to activate a font. #54506
• Font Library: show the scrollbar bottom edge #54401
• Font Library: include a system fonts collection by default. #54186
• Font Library: Improve UX #56688
• Font Library: How to add lib-font package (or equivalent). #53653
• Font Library: maintain focus order within nested modal #54431
• Command Palette: add command to open fonts #54880
• Try using a full page for the font management #57904
• Font Library: add a setting to customize the conditional download of font assets from a font collection #58030
• Font Library modal: Improve clarity between active and inactive fonts #58276
• Font Library: adding docs #54477
• Font Library: settings for using local vs. remotely hosted fonts #58229

Trac ticket to merge in core:

https://core.trac.wordpress.org/ticket/59166

[alexandrebuffet]

Hello there. I opened ticket 59911 on the track concerning inconsistency brought by PR #54615 between the declaration of font family presets in theme.json and the generated @font-face. Can we continue the discussion in #57207?

[annezazu]

👋🏼 Hey hey! Are you all able to share biweekly updates on how this work is progressing? It would help me loads with sharing updates to the broader community and coordinating testing as needed.

[matiasbenedetto]

👋🏼 Hey hey! Are you all able to share biweekly updates on how this work is progressing? It would help me loads with sharing updates to the broader community and coordinating testing as needed.

Yes, here's an update from the last few weeks:

Changes merged:

#57282 to consolidate the existing endpoints the Font Library added and fix potential data sanitization problems. This change is a small step forward in implementing the API refactor.

#57364 to eliminate code no longer required.

#57368 to improve copy text.

Most relevant changes in-process:

• API refactor
• Support alternate paths for fonts

[annezazu]

@matiasbenedetto are you able to provide weekly updates at this stage? We're less than a month away from beta 1 and it's going to be critical that we're aware of how this feature is progressing 🌟

[matiasbenedetto]

@annezazu yes, this is the report about the last two weeks:

Changes discussed or merged:

We continue working heavily of the API rest refactor and the required frontend changes around that.
#57688

We discussed the requirement around a method for the extenders to turn off the library. We landed a solution consisting of adding a PHP filter: #55275.

We discussed the need for a custom permission for managing fonts, and it seems like it has been discarded at least for now:
#55280

We discussed and landed a solution around configuring the storage location for font assets:
#57697

We added the ability to unregister font collections:
#54701

We updated the Google fonts collection generation and replaced the older TTF files by the lighter WOFF2 files.
https://github.com/WordPress/google-fonts-to-wordpress-collection

Most relevant for the next days:

Work on the feature branch around the API refactor that will include the frontend changes too and try to merge it to trunk.
#57688

[mikachan]

Quick update on the Font Library: the API refactor PR has been merged, ready for release with Gutenberg 17.6. We'll start on the backports for 6.5 soon.

[colorful-tones]

Consider this as a 'Nice to Have' Font Library: Global Styles > Typography sidebar – group related font sources #58403

[getdave]

As Editor Tech Leads, @youknowriad and I have been looking at how we can best support contributors with landing this (blessed) feature for the WordPress 6.5 release.

I've spent some time looking at the code and how we could possibly seek to make the synchronisation to WP Core easier for folks to review. It's our feeling that it might be easier/more manageable to split the feature into its high level components and merge incrementally.

I've taken the liberty of pulling together the following. It is a suggestion only and we will defer to contributors on how best to proceed so feel free to pull it apart and propose alternatives.

Know that we are here to support you, so please reach out to and we're happy to jump in and assist as required.

Thanks for all the work on this feature 🙇

Proposal

The items are listed in order of proposed merge into WP Core.

Post Types registration and Low Level APIs

All Font Library post type registrations.

These are required to allow the public facing elements (REST API and Post Types) to function.

• WP_Font_Library - APIs for registering and retrieving font collections.
• WP_Font_Collection - class representing an individual Font Collection.
• WP_Font_Utils - utilities for working with fonts.

REST API endpoints

The classes relating to REST need to be available before the Post Type registration is merge otherwise the rest_controller_class config will fail (example).

• WP_REST_Font_Collections_Controller - endpoint for predefined lists (i.e. "collections") of font families.
• WP_REST_Font_Families_Controller - endpoint for parent "family" which typically (but not always) contains 1 or more font faces (i.e. the individual fonts).
• WP_REST_Font_Faces_Controller - endpoint for individual font faces within a family.

Public API methods

All remaining methods/functions from font-library.php.

[mikachan]

Another update:

• We have made further smaller changes to the Font Library (both PHP and JS) over the past week, ready to be released with Gutenberg 17.6.
• We plan to open 2 PRs for Core:
  1. General PHP: Custom post type registration, Font Library, Font Collection classes and functions
  2. REST API controllers
• The preparation for those is happening now, and we hope to have a further update by the end of this week (Feb 2).

If you'd like to follow along, all the work is labeled with [Feature] Font Library.

[getdave]

Update

In order to raise the x2 Core PRs we need the following:

• Align PHPUnit tests with Core coding standards:
  • [Font Library] Update PHPUnit tests per Core coding standards and practices #58502.
  • Fix font library unit tests nit-picks [round 2] #58612
• Move the code into the compat dir for WP 6.5
• Disable the Font Library UI in Core until the feature is fully merged and available - @creativecoder had a plan for this one.
• x2 PRs to update the actual code to align with Core standards (as per this comment:
  • Update Font Library non-REST API code to align with Core standards #58607
  • Update Font Library REST API code to align with Core standards #58619
• Ship two final pieces of functionality:
  • Font Library REST API: sanitize font family and font face settings #58590
  • Font Library: Add sanitize from schema util #58571

It would also be nice to have the following (but these are not blockers to raising the Core PRs):

• Font Collections: lazy load json configuration for better performance #58530

[creativecoder]

Two more to add to the above to prep for the Core PRs

• Font Library: sanitize font collection data #58636
• Font Collections: standardizes docblock comments #58654

[youknowriad]

Initial Font Library Core backport PR is open here WordPress/wordpress-develop#6027

[getdave]

Some additional feedback on the code is being addressed in Gutenberg and will need to be brought into the Core PR(s).

[getdave]

Core PRs for the initial merge of this feature are:

• Font Library API
• Font Library REST API code

[getdave]

The initial merge of this feature into WordPress Core for the 6.5 release is complete. Thank you to everyone who contributed.

@creativecoder @matiasbenedetto if you are able to ✅ off any PRs from the PHP Sync Issue and mark with Backported to WP Core label that would be appreciated.

[fabiankaegy]

Now that we are past the Beta 1 cut off point I'm removing this tracking issue from the 6.5 Project board. From now on the board should only contain individual bugs that we want to still fix before 6.5 gets released.

[mikachan]

I'm going to close this issue, as the tasks listed above have now all been completed and the feature is due to be released with WP 6.5. Further issues can be tracked using the [Feature] Font Library label.