PHPXRef 0.7.1 : WordPress Trunk (Updated Daily) : Detail view of class-wp-block-metadata-registry.php

Class: WP_Block_Metadata_Registry - X-Ref

Class used for managing block metadata collections.

The WP_Block_Metadata_Registry allows plugins to register metadata for large
collections of blocks (e.g., 50-100+) using a single PHP file. This approach
reduces the need to read and decode multiple `block.json` files, enhancing
performance through opcode caching.

register_collection( $path, $manifest ) X-Ref

Registers a block metadata collection.

This method allows registering a collection of block metadata from a single
manifest file, improving performance for large sets of blocks.

The manifest file should be a PHP file that returns an associative array, where
the keys are the block identifiers (without their namespace) and the values are
the corresponding block metadata arrays. The block identifiers must match the
parent directory name for the respective `block.json` file.

Example manifest file structure:
```
return array(
'example-block' => array(
'title' => 'Example Block',
'category' => 'widgets',
'icon' => 'smiley',
// ... other block metadata
),
'another-block' => array(
'title' => 'Another Block',
'category' => 'formatting',
'icon' => 'star-filled',
// ... other block metadata
),
// ... more block metadata entries
);
```

param: string $path The absolute base path for the collection ( e.g., WP_PLUGIN_DIR . '/my-plugin/blocks/' ).
param: string $manifest The absolute path to the manifest file containing the metadata collection.
return: bool True if the collection was registered successfully, false otherwise.

get_metadata( $file_or_folder ) X-Ref

No description

get_collection_block_metadata_files( $path ) X-Ref

Gets the list of absolute paths to all block metadata files that are part of the given collection.

For instance, if a block metadata collection is registered with path `WP_PLUGIN_DIR . '/my-plugin/blocks/'`,
and the manifest file includes metadata for two blocks `'block-a'` and `'block-b'`, the result of this method
will be an array containing:
* `WP_PLUGIN_DIR . '/my-plugin/blocks/block-a/block.json'`
* `WP_PLUGIN_DIR . '/my-plugin/blocks/block-b/block.json'`

param: string $path The absolute base path for a previously registered collection.
return: string[] List of block metadata file paths, or an empty array if the given `$path` is invalid.

find_collection_path( $file_or_folder ) X-Ref

No description

has_metadata( $file_or_folder ) X-Ref

Checks if metadata exists for a given block name in a specific collection.

param: string $file_or_folder The path to the file or folder containing the block metadata.
return: bool True if metadata exists for the block, false otherwise.

default_identifier_callback( $path ) X-Ref

Default identifier function to determine the block identifier from a given path.

This function extracts the block identifier from the path:
- For 'block.json' files, it uses the parent directory name.
- For directories, it uses the directory name itself.
- For empty paths, it returns an empty string.

For example:
- Path: '/wp-content/plugins/my-plugin/blocks/example/block.json'
Identifier: 'example'
- Path: '/wp-content/plugins/my-plugin/blocks/another-block'
Identifier: 'another-block'

This default behavior matches the standard WordPress block structure.

param: string $path The normalized file or folder path to determine the block identifier from.
return: string The block identifier, or an empty string if the path is empty.

is_valid_collection_path( $path, $collection_roots ) X-Ref

Checks whether the given block metadata collection path is valid against the list of collection roots.

param: string $path Normalized block metadata collection path, without trailing slash.
param: string[] $collection_roots List of normalized collection root paths, without trailing slashes.
return: bool True if the path is allowed, false otherwise.

get_default_collection_roots() X-Ref

Gets the default collection root directory paths.

return: string[] List of directory paths within which metadata collections are allowed.

File Size:	358 lines (12 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of WordPress Trunk (Updated Daily)

/wp-includes/ -> class-wp-block-metadata-registry.php (summary)

Defines 1 class