WP_Block_Metadata_Registry::get_metadata( string $file_or_folder ): array|null
- Since
- 6.7.0
- Source
wp-includes/class-wp-block-metadata-registry.php:163
Description
This method uses the registered collections to efficiently lookup block metadata without reading individual block.json files.
Compatibility
- WordPress
- since 6.7.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_folderstring- The path to the file or folder containing the block.
Return value
array|null- The block metadata for the block, or null if not found.
Performance profile
How much work a call to WP_Block_Metadata_Registry::get_metadata() 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
- Scaling
- Constant
- Instructions
- 11–29
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
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 30.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
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_Block_Metadata_Registry::get_metadata() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11 | wp_normalize_path(), ::find_collection_path() |
| always | 24–29 | wp_normalize_path(), ::find_collection_path(), ::default_identifier_callback() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 30 instructions, 11–29 executed per call, 3 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 · 3
- wp_normalize_path()Normalizes a filesystem path.
- WP_Block_Metadata_Registry::find_collection_path()Finds the collection path for a given file or folder.
- WP_Block_Metadata_Registry::default_identifier_callback()Default identifier function to determine the block identifier from a given path.
Used by · 2
- WP_Block_Metadata_Registry::has_metadata()Checks if metadata exists for a given block name in a specific collection.
- register_block_type_from_metadata()Registers a block type from the metadata stored in the `block.json` file.
Source code
public static function get_metadata( $file_or_folder ) { $file_or_folder = wp_normalize_path( $file_or_folder ); $path = self::find_collection_path( $file_or_folder ); if ( ! $path ) { return null; } $collection = &self::$collections[ $path ]; if ( null === $collection['metadata'] ) { // Load the manifest file if not already loaded $collection['metadata'] = require $collection['manifest']; } // Get the block name from the path. $block_name = self::default_identifier_callback( $file_or_folder ); return $collection['metadata'][ $block_name ] ?? null; }Changelog
Introduced in 6.7.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/class-wp-block-metadata-registry.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.