wppaste
WordPress

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

Since
6.5.0
Source
wp-includes/fonts.php:96
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.

Compatibility

WordPress
since 6.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$slugstring
Font collection slug. May only contain alphanumeric characters, dashes, and underscores. See sanitize_title().
$argsarray
Font collection data.

  • $namestring

    Required. Name of the font collection shown in the Font Library.

  • $descriptionstringdefault: empty

    Optional. A short descriptive summary of the font collection.

  • $font_familiesarray|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.

  • $categoriesarraydefault: empty

    Optional. Array of categories, each with a name and slug, that are used by the fonts in the collection.

Return value

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

Performance profile

How much work a call to wp_register_font_collection() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
9

Executed per call on PHP 8.5. The body compiles to 9.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_register_font_collection() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always9::WP_Font_Library(), ->register_font_collection()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 9 instructions, 9 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 1

Source code

View on Trac View on GitHub 

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

Changelog

Introduced in 6.5.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/fonts.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.