wppaste
WordPress

_wp_filter_font_directory( string $font_dir ): string

Since
6.5.0
Source
wp-includes/fonts.php:172
A callback function for use in the 'upload_dir' filter.

Description

This function is intended for internal use only and should not be used by plugins and themes.
Use wp_get_font_dir() instead.

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

$font_dirstring
The font directory.

Return value

string
The modified font directory.

Performance profile

How much work a call to _wp_filter_font_directory() 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
6–41

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 42.

Plugin surface
1 hook

Third-party callbacks on 'font_dir' run inside this call, and their cost is not bounded by anything here.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_filters()called directly

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
doing_filter()6doing_filter()
!doing_filter()41doing_filter(), untrailingslashit(), untrailingslashit(), untrailingslashit(), untrailingslashit(), apply_filters()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 42 instructions, 6–41 executed per call, 1 branch. 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.

Hooks and filters fired · 1

One hook fires while _wp_filter_font_directory() runs, in this order:

  1. apply_filters( font_dir )filterline 205 (+33 into the body)

    Filters the fonts directory data.

Uses · 3

  • doing_filter()Returns whether or not a filter hook is currently being processed.
  • untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
  • apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

View on Trac View on GitHub 

function _wp_filter_font_directory( $font_dir ) {	if ( doing_filter( 'font_dir' ) ) {		// Avoid an infinite loop.		return $font_dir;	} 	$font_dir = array(		'path'    => untrailingslashit( $font_dir['basedir'] ) . '/fonts',		'url'     => untrailingslashit( $font_dir['baseurl'] ) . '/fonts',		'subdir'  => '',		'basedir' => untrailingslashit( $font_dir['basedir'] ) . '/fonts',		'baseurl' => untrailingslashit( $font_dir['baseurl'] ) . '/fonts',		'error'   => false,	); 	/**	 * Filters the fonts directory data.	 *	 * This filter allows developers to modify the fonts directory data.	 *	 * @since 6.5.0	 *	 * @param array $font_dir {	 *     Array of information about the font upload directory.	 *	 *     @type string       $path    Base directory and subdirectory or full path to the fonts upload directory.	 *     @type string       $url     Base URL and subdirectory or absolute URL to the fonts upload directory.	 *     @type string       $subdir  Subdirectory	 *     @type string       $basedir Path without subdir.	 *     @type string       $baseurl URL path without subdir.	 *     @type string|false $error   False or error message.	 * }	 */	return apply_filters( 'font_dir', $font_dir );}

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.