WP_Block_Metadata_Registry

20class WP_Block_Metadata_Registry {21 22	/**23	 * Container for storing block metadata collections.24	 *25	 * Each entry maps a base path to its corresponding metadata and callback.26	 *27	 * @since 6.7.028	 * @var array<string, array<string, mixed>>29	 */30	private static $collections = array();31 32	/**33	 * Caches the last matched collection path for performance optimization.34	 *35	 * @since 6.7.036	 * @var string|null37	 */38	private static $last_matched_collection = null;39 40	/**41	 * Stores the default allowed collection root paths.42	 *43	 * @since 6.7.244	 * @var string[]|null45	 */46	private static $default_collection_roots = null;47 48	/**49	 * Registers a block metadata collection.50	 *51	 * This method allows registering a collection of block metadata from a single52	 * manifest file, improving performance for large sets of blocks.53	 *54	 * The manifest file should be a PHP file that returns an associative array, where55	 * the keys are the block identifiers (without their namespace) and the values are56	 * the corresponding block metadata arrays. The block identifiers must match the57	 * parent directory name for the respective `block.json` file.58	 *59	 * Example manifest file structure:60	 * ```61	 * return array(62	 *     'example-block' => array(63	 *         'title' => 'Example Block',64	 *         'category' => 'widgets',65	 *         'icon' => 'smiley',66	 *         // ... other block metadata67	 *     ),68	 *     'another-block' => array(69	 *         'title' => 'Another Block',70	 *         'category' => 'formatting',71	 *         'icon' => 'star-filled',72	 *         // ... other block metadata73	 *     ),74	 *     // ... more block metadata entries75	 * );76	 * ```77	 *78	 * @since 6.7.079	 *80	 * @param string $path     The absolute base path for the collection ( e.g., WP_PLUGIN_DIR . '/my-plugin/blocks/' ).81	 * @param string $manifest The absolute path to the manifest file containing the metadata collection.82	 * @return bool True if the collection was registered successfully, false otherwise.83	 */84	public static function register_collection( $path, $manifest ) {85		$path = wp_normalize_path( rtrim( $path, '/' ) );86 87		$collection_roots = self::get_default_collection_roots();88 89		/**90		 * Filters the root directory paths for block metadata collections.91		 *92		 * Any block metadata collection that is registered must not use any of these paths, or any parent directory93		 * path of them. Most commonly, block metadata collections should reside within one of these paths, though in94		 * some scenarios they may also reside in entirely different directories (e.g. in case of symlinked plugins).95		 *96		 * Example:97		 * * It is allowed to register a collection with path `WP_PLUGIN_DIR . '/my-plugin'`.98		 * * It is not allowed to register a collection with path `WP_PLUGIN_DIR`.99		 * * It is not allowed to register a collection with path `dirname( WP_PLUGIN_DIR )`.