wppaste
WordPress

WP_Block_Pattern_Categories_Registry

Source
wp-includes/class-wp-block-pattern-categories-registry.php:13
Class used for interacting with block pattern categories.

Compatibility

WordPress
core
  • 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).

Properties · 3

$registered_categoriesarray[]private
Registered block pattern categories array.
$registered_categories_outside_initarray[]private
Pattern categories registered outside the init action.
$instanceWP_Block_Pattern_Categories_Registry|nullprivate static
Container for the main instance of the class.

Methods · 6

Source code

#[AllowDynamicProperties]final class WP_Block_Pattern_Categories_Registry {	/**	 * Registered block pattern categories array.	 *	 * @since 5.5.0	 * @var array[]	 */	private $registered_categories = array(); 	/**	 * Pattern categories registered outside the `init` action.	 *	 * @since 6.0.0	 * @var array[]	 */	private $registered_categories_outside_init = array(); 	/**	 * Container for the main instance of the class.	 *	 * @since 5.5.0	 * @var WP_Block_Pattern_Categories_Registry|null	 */	private static $instance = null; 	/**	 * Registers a pattern category.	 *	 * @since 5.5.0	 *	 * @param string $category_name       Pattern category name including namespace.	 * @param array  $category_properties {	 *     List of properties for the block pattern category.	 *	 *     @type string $label Required. A human-readable label for the pattern category.	 * }	 * @return bool True if the pattern was registered with success and false otherwise.	 */	public function register( $category_name, $category_properties ) {		if ( ! isset( $category_name ) || ! is_string( $category_name ) ) {			_doing_it_wrong(				__METHOD__,				__( 'Block pattern category name must be a string.' ),				'5.5.0'			);			return false;		} 		$category = array_merge(			array( 'name' => $category_name ),			$category_properties		); 		$this->registered_categories[ $category_name ] = $category; 		// If the category is registered inside an action other than `init`, store it		// also to a dedicated array. Used to detect deprecated registrations inside		// `admin_init` or `current_screen`.		if ( current_action() && 'init' !== current_action() ) {			$this->registered_categories_outside_init[ $category_name ] = $category;		} 		return true;	} 	/**	 * Unregisters a pattern category.	 *	 * @since 5.5.0	 *	 * @param string $category_name Pattern category name including namespace.	 * @return bool True if the pattern was unregistered with success and false otherwise.	 */	public function unregister( $category_name ) {		if ( ! $this->is_registered( $category_name ) ) {			_doing_it_wrong(				__METHOD__,				/* translators: %s: Block pattern name. */				sprintf( __( 'Block pattern category "%s" not found.' ), $category_name ),

Changelog

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.0.4 tag, from src/wp-includes/class-wp-block-pattern-categories-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.