PHPXRef 0.7.1 : WordPress : Detail view of class-wp-block-pattern-categories-registry.php

Blocks API: WP_Block_Pattern_Categories_Registry class

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

Defines 8 functions

  register()
  unregister()
  get_registered()
  get_all_registered()
  is_registered()
  get_instance()
  register_block_pattern_category()
  unregister_block_pattern_category()

Functions

Functions that are not part of a class:

Registers a pattern category.

param: string $category_name Pattern category name including namespace.
param: array $category_properties {
since: 5.5.0
return: bool True if the pattern was registered with success and false otherwise.

unregister( $category_name ) X-Ref

Unregisters a pattern category.

param: string $category_name Pattern category name including namespace.
since: 5.5.0
return: bool True if the pattern was unregistered with success and false otherwise.

get_registered( $category_name ) X-Ref

Retrieves an array containing the properties of a registered pattern category.

param: string $category_name Pattern category name including namespace.
since: 5.5.0
return: array Registered pattern properties.

get_all_registered() X-Ref

Retrieves all registered pattern categories.

since: 5.5.0
return: array[] Array of arrays containing the registered pattern categories properties.

is_registered( $category_name ) X-Ref

Checks if a pattern category is registered.

param: string $category_name Pattern category name including namespace.
since: 5.5.0
return: bool True if the pattern category is registered, false otherwise.

get_instance() X-Ref

Utility method to retrieve the main instance of the class.

The instance will be created if it does not exist yet.

since: 5.5.0
return: WP_Block_Pattern_Categories_Registry The main instance.

register_block_pattern_category( $category_name, $category_properties ) X-Ref

Registers a new pattern category.

param: string $category_name Pattern category name including namespace.
param: array $category_properties List of properties for the block pattern.
since: 5.5.0
return: bool True if the pattern category was registered with success and false otherwise.

unregister_block_pattern_category( $category_name ) X-Ref

Unregisters a pattern category.

param: string $category_name Pattern category name including namespace.
since: 5.5.0
return: bool True if the pattern category was unregistered with success and false otherwise.

PHP Cross Reference of WordPress

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

Defines 8 functions