Get WordPress

WordPress Developer Resources

wp_register_font_collection()

wp_register_font_collection( string $slug, array $args ): WP_Font_Collection|WP_Error

In this article

Back to top

Registers a new font collection in the font library.

Description

See https://schemas.wp.org/trunk/font-collection.json for the schema the font collection data must adhere to.

Parameters

$slugstringrequired
Font collection slug. May only contain alphanumeric characters, dashes, and underscores. See sanitize_title() .
$argsarrayrequired
Font collection data.
  • name string
    Required. Name of the font collection shown in the Font Library.
  • description string
    Optional. A short descriptive summary of the font collection. Default empty.
  • font_families array|string
    Required. Array of font family definitions that are in the collection, or a string containing the path or URL to a JSON file containing the font collection.
  • categories array
    Optional. Array of categories, each with a name and slug, that are used by the fonts in the collection. Default empty.

Return

WP_Font_Collection|WP_Error A font collection if it was registered successfully, or WP_Error object on failure.

Source

function wp_register_font_collection( string $slug, array $args ) {
	return WP_Font_Library::get_instance()->register_font_collection( $slug, $args );
}

View all references View on Trac View on GitHub

UsesDescription
WP_Font_Library::get_instance()wp-includes/fonts/class-wp-font-library.php

Utility method to retrieve the main instance of the class.

Used byDescription
_wp_register_default_font_collections()wp-includes/fonts.php

Register the default font collections.

Changelog

VersionDescription
6.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.