WP_Font_Collection::load_from_json( string $file_or_url ): array|WP_Error
- Since
- 6.5.0
- Source
wp-includes/fonts/class-wp-font-collection.php:116
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
$file_or_urlstring- File path or URL to a JSON file containing the font collection data.
Return value
array|WP_Error- An array containing the font collection data on success, else an instance of WP_Error on failure.
Performance profile
How much work a call to WP_Font_Collection::load_from_json() 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
- Heavy
- Scaling
- Constant
- Instructions
- 23–52
- Plugin surface
- None
- Called by
- 1
Reads or writes the filesystem via file_exists().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 72.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- filesystemfilesystem access
file_exists()called directly - optionoption read or write
get_option()one call below WP_Font_Collection::load_from_json() - hookthird-party callbacks
apply_filters()one call below WP_Font_Collection::load_from_json()
Further down the call graph this can also reach 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 · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Font_Collection::load_from_json() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!file_exists() | 23–45 | wp_http_validate_url(), file_exists(), ->load_from_url(), is_wp_error() |
!file_exists() | 24–44 | wp_http_validate_url(), file_exists(), ->load_from_file(), is_wp_error() |
!file_exists() | 27 | wp_http_validate_url(), file_exists(), __(), _doing_it_wrong() |
file_exists() | 30–52 | wp_http_validate_url(), file_exists(), realpath(), wp_normalize_path(), ->load_from_url(), is_wp_error() |
file_exists() | 31–51 | wp_http_validate_url(), file_exists(), realpath(), wp_normalize_path(), ->load_from_file(), is_wp_error() |
file_exists() | 34 | wp_http_validate_url(), file_exists(), realpath(), wp_normalize_path(), __(), _doing_it_wrong() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 69 | 22–50 | 7 | 3 fewer instructions than PHP 8.5 |
| 8.5 | 72 | 23–52 | 7 | |
| 8.4 | 72 | 23–52 | 7 | |
| 8.3 | 72 | 23–52 | 7 | |
| 8.2 | 72 | 23–52 | 7 | |
| 8.1 | 72 | 23–52 | 7 | |
| 7.4 | 72 | 23–52 | 7 |
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 · 8
- wp_http_validate_url()Validates a URL as safe for use in the HTTP API.
- wp_normalize_path()Normalizes a filesystem path.
- __()Retrieves the translation of $text.
- _doing_it_wrong()Marks something as being incorrectly called.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- WP_Error::__construct()Initializes the error.
- WP_Font_Collection::load_from_url()Loads the font collection data from a JSON file URL.
- WP_Font_Collection::load_from_file()Loads the font collection data from a JSON file path.
Used by · 1
- WP_Font_Collection::get_data()Retrieves the font collection data.
Source code
private function load_from_json( $file_or_url ) { $url = wp_http_validate_url( $file_or_url ); $file = file_exists( $file_or_url ) ? wp_normalize_path( realpath( $file_or_url ) ) : false; if ( ! $url && ! $file ) { // translators: %s: File path or URL to font collection JSON file. $message = __( 'Font collection JSON file is invalid or does not exist.' ); _doing_it_wrong( __METHOD__, $message, '6.5.0' ); return new WP_Error( 'font_collection_json_missing', $message ); } $data = $url ? $this->load_from_url( $url ) : $this->load_from_file( $file ); if ( is_wp_error( $data ) ) { return $data; } $data = array( 'name' => $this->data['name'], 'font_families' => $data['font_families'], ); if ( isset( $this->data['description'] ) ) { $data['description'] = $this->data['description']; } if ( isset( $this->data['categories'] ) ) { $data['categories'] = $this->data['categories']; } return $data; }Changelog
Introduced in 6.5.0. Unchanged from 6.7.7 through 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/class-wp-font-collection.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.