wp_font_dir( bool $create_dir = true ): array

Compatibility

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

Parameters

$create_dirbooloptional

Whether to check and create the font uploads directory. Default true.Default: true

Return value

array

Array of information about the font upload directory.

• $pathstring

  Base directory and subdirectory or full path to the fonts upload directory.

• $urlstring

  Base URL and subdirectory or absolute URL to the fonts upload directory.

• $subdirstring

  Subdirectory @type string $basedir Path without subdir.

• $baseurlstring

  URL path without subdir.

• $errorstring|false

  False or error message.

Performance profile

How much work a call to wp_font_dir() 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

16

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

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 it touches

• hookthird-party callbacksapply_filters()one call below wp_font_dir()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

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_font_dir() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• add_filter()Adds a callback function to a filter hook.
• wp_upload_dir()Returns an array containing the current upload directory's path and URL.
• remove_filter()Removes a callback function from a filter hook.

Used by · 1

• wp_get_font_dir()Retrieves font uploads directory information.

Source code

View on Trac ↗View on GitHub ↗

146function wp_font_dir( $create_dir = true ) {147	/*148	 * Allow extenders to manipulate the font directory consistently.149	 *150	 * Ensures the upload_dir filter is fired both when calling this function151	 * directly and when the upload directory is filtered in the Font Face152	 * REST API endpoint.153	 */154	add_filter( 'upload_dir', '_wp_filter_font_directory' );155	$font_dir = wp_upload_dir( null, $create_dir, false );156	remove_filter( 'upload_dir', '_wp_filter_font_directory' );157	return $font_dir;158}

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.