WP_Block_Metadata_Registry::get_collection_block_metadata_files( string $path ): string[]

Description

Compatibility

Present in 4 of the 5 tracked releases, added in 6.8.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$pathstring

The absolute base path for a previously registered collection.

Return value

string[]

List of block metadata file paths, or an empty array if the given $path is invalid.

Performance profile

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

7

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

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 callbacksdo_action()one call below WP_Block_Metadata_Registry::get_collection_block_metadata_files()

Further down the call graph this can also reach query, option, cache, serialize 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_Block_Metadata_Registry::get_collection_block_metadata_files() can have, taken from its control-flow graph on PHP 8.5.

Uses · 3

• wp_normalize_path()Normalizes a filesystem path.
• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.

Used by · 1

• wp_register_block_types_from_metadata_collection()Registers all block types from a block metadata collection.

Source code

View on Trac ↗View on GitHub ↗

198	public static function get_collection_block_metadata_files( $path ) {199		$path = rtrim( wp_normalize_path( $path ), '/' );200 201		if ( ! isset( self::$collections[ $path ] ) ) {202			_doing_it_wrong(203				__METHOD__,204				__( 'No registered block metadata collection was found for the provided path.' ),205				'6.8.0'206			);207			return array();208		}209 210		$collection = &self::$collections[ $path ];211 212		if ( null === $collection['metadata'] ) {213			// Load the manifest file if not already loaded.214			$collection['metadata'] = require $collection['manifest'];215		}216 217		return array_map(218			// No normalization necessary since `$path` is already normalized and `$block_name` is just a folder name.219			static function ( $block_name ) use ( $path ) {220				return "{$path}/{$block_name}/block.json";221			},222			array_keys( $collection['metadata'] )223		);224	}

Changelog

Introduced in 6.8.0. Unchanged from 6.8.8 through 7.1.0.

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

Signature, return type and hooks compared across 4 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.