Font Library: adding docs

[matiasbenedetto]

⚠️ this is a work in progress
Some of the things documented here can change soon.

What?

Font Library: adding docs

Why?

To inform the key concepts and functionality around Font Library.

How?

By documenting the existing functionality.

Testing Instructions

• Read the docs.
• Check if they make sense.
• Propose changes and additions.

[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/compat/wordpress-6.5/fonts/README.md

[github-actions]

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

• Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
• Labels found: [Type] Enhancement, [Type] Developer Documentation, [Feature] Typography, [Feature] Font Library.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

[annezazu]

In case it helps, left some quick copy feedback :)

[vcanales]

We'll need to change this once the ability to change this directory is implemented, in order to specify that the directory might not always be /wp-content/fonts.

[vcanales]

Same as above; this might not always be the directory where fonts are served from in the future.

[mikachan]

Noting that we should find a good place in the docs to put the information from #57980.

[colorful-tones]

We'll want to add a section on how to deactivate the Font Library with filter, see #57818

Here is the code copied from merged ticket:

function disable_font_library_ui( $editor_settings ) { 
    $editor_settings['fontLibraryEnabled'] = false;
    return $editor_settings; 
}

add_filter( "block_editor_settings_all", "disable_font_library_ui" );

[github-actions]

Flaky tests detected in b3561b0.
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/7788944655
📝 Reported issues:

• [Flaky Test] aria-disabled is correctly hydrated for different values #54370 in /test/e2e/specs/interactivity/directive-bind.spec.ts

[ironprogrammer]

@matiasbenedetto I was testing custom collections today, so had a few updates to share. I hope these are helpful as the docs are coming together.

[ironprogrammer]

Suggested change

	To unregister a font collection you need to add an action calling `wp_unregister_font_collection` with the font collection slug as the only parameter. The unregistered font collections won't appear as a font library modal tab and it won't be listed on the `/font-collections/` REST API endpoint.
	To unregister a font collection, add an action calling `wp_unregister_font_collection` with the font collection slug as the only parameter. Unregistered font collections won't appear in the Font Library modal tab list, and won't be returned from the `/font-collections/` REST API endpoint.

Massaging this a little.

[ironprogrammer]

Suggested change

	Example:
	Example:

Added a line break above code block. To my eyes this is easier to scan in .md.

[ironprogrammer]

Suggested change

	add_action( 'init',
	add_action( 'init', 'register_my_collection' );

Fix.

[ironprogrammer]

Suggested change

	"$schema": "https://schemas.wp.org/trunk/font-collection.json",
	"$schema": "https://schemas.wp.org/trunk/font-collection.json",
	"slug": "my-font-foundry-collection",

Adds slug.

[ironprogrammer]

Suggested change

	{ "id": "sans-serif", "name": "Sans Serif" },
	{ "id": "serif", "name": "Serif" },
	{
	"name": "Sans Serif",
	"slug": "sans-serif",
	},
	{
	"name": "Serif",
	"slug": "serif"
	},

Reformat and switch id to slug.

[ironprogrammer]

Suggested change

	```json
	```json

Adds line break before code block.

[ironprogrammer]

Suggested change

	```
	```console

Adds line break before code block, updates formatting.

[ironprogrammer]

Suggested change

	```
	```console

Updates formatting.

[ironprogrammer]

Suggested change

	```
	```console

Updates formatting.

[ironprogrammer]

Suggested change

	```
	```console

Updates formatting.

[ironprogrammer]

Suggested change

	wp_register_font_collection ( 'my-font-foundry', path_join( __DIR__, 'my-collection.json' ) );
	wp_register_font_collection (
	'my-font-foundry',
	array(
	'name' => 'My Font Foundry',
	'font_families' => path_join( __DIR__, 'my-collection.json' )
	)
	);

This method changed in WordPress/wordpress-develop@8ced706.

[ironprogrammer]

Suggested change

	wp_register_font_collection ( 'my-font-foundry', 'https://example.com/fonts/my-collection.json' );
	wp_register_font_collection (
	'my-font-foundry',
	array(
	'name' => 'My Font Foundry',
	'font_families' => 'https://example.com/fonts/my-collection.json'
	)
	);

Same change as noted above in https://github.com/WordPress/gutenberg/pull/54477/files#r1500148930.