wppaste
WordPress

WP_Block_Metadata_Registry::find_collection_path( string $file_or_folder ): string|null

Since
6.7.0
Source
wp-includes/class-wp-block-metadata-registry.php:234
Finds the collection path for a given file or folder.

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 normalized path to the file or folder.

Return value

string|null
The normalized collection path if found, or null if not found.

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
4–26

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

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 one call costs · 3 distinct outcomes

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

WhenInstructionsCalls it makes
empty($file_or_folder)4none
!empty($file_or_folder) && $path15rtrim()
!empty($file_or_folder)18–26rtrim(), array_keys()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev314–266
8.5314–266
8.4314–2666 fewer instructions than PHP 8.3
8.3374–326
8.2374–326
8.1374–3261 fewer instruction than PHP 7.4
7.4384–336

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 · 1

Used by · 1

Source code

	private static function find_collection_path( $file_or_folder ) {		if ( empty( $file_or_folder ) ) {			return null;		} 		// Check the last matched collection first, since block registration usually happens in batches per plugin or theme.		$path = rtrim( $file_or_folder, '/' );		if ( self::$last_matched_collection && str_starts_with( $path, self::$last_matched_collection ) ) {			return self::$last_matched_collection;		} 		$collection_paths = array_keys( self::$collections );		foreach ( $collection_paths as $collection_path ) {			if ( str_starts_with( $path, $collection_path ) ) {				self::$last_matched_collection = $collection_path;				return $collection_path;			}		}		return null;	}

Changelog

Introduced in 6.7.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/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.