From a415c29efee45520ae252d2aa28f1083a521cd7b Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 17 Apr 2024 09:56:49 +0200 Subject: Adding upstream version 6.4.3+dfsg1. Signed-off-by: Daniel Baumann --- wp-includes/class-wp-block-patterns-registry.php | 290 +++++++++++++++++++++++ 1 file changed, 290 insertions(+) create mode 100644 wp-includes/class-wp-block-patterns-registry.php (limited to 'wp-includes/class-wp-block-patterns-registry.php') diff --git a/wp-includes/class-wp-block-patterns-registry.php b/wp-includes/class-wp-block-patterns-registry.php new file mode 100644 index 0000000..a11bac0 --- /dev/null +++ b/wp-includes/class-wp-block-patterns-registry.php @@ -0,0 +1,290 @@ + $pattern_name ) + ); + + $this->registered_patterns[ $pattern_name ] = $pattern; + + // If the pattern 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_patterns_outside_init[ $pattern_name ] = $pattern; + } + + return true; + } + + /** + * Unregisters a block pattern. + * + * @since 5.5.0 + * + * @param string $pattern_name Block pattern name including namespace. + * @return bool True if the pattern was unregistered with success and false otherwise. + */ + public function unregister( $pattern_name ) { + if ( ! $this->is_registered( $pattern_name ) ) { + _doing_it_wrong( + __METHOD__, + /* translators: %s: Pattern name. */ + sprintf( __( 'Pattern "%s" not found.' ), $pattern_name ), + '5.5.0' + ); + return false; + } + + unset( $this->registered_patterns[ $pattern_name ] ); + unset( $this->registered_patterns_outside_init[ $pattern_name ] ); + + return true; + } + + /** + * Prepares the content of a block pattern. If hooked blocks are registered, they get injected into the pattern, + * when they met the defined criteria. + * + * @since 6.4.0 + * + * @param array $pattern Registered pattern properties. + * @param array $hooked_blocks The list of hooked blocks. + * @return string The content of the block pattern. + */ + private function prepare_content( $pattern, $hooked_blocks ) { + $content = $pattern['content']; + + $before_block_visitor = '_inject_theme_attribute_in_template_part_block'; + $after_block_visitor = null; + if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) { + $before_block_visitor = make_before_block_visitor( $hooked_blocks, $pattern ); + $after_block_visitor = make_after_block_visitor( $hooked_blocks, $pattern ); + } + $blocks = parse_blocks( $content ); + $content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor ); + + return $content; + } + + /** + * Retrieves an array containing the properties of a registered block pattern. + * + * @since 5.5.0 + * + * @param string $pattern_name Block pattern name including namespace. + * @return array Registered pattern properties. + */ + public function get_registered( $pattern_name ) { + if ( ! $this->is_registered( $pattern_name ) ) { + return null; + } + + $pattern = $this->registered_patterns[ $pattern_name ]; + $pattern['content'] = $this->prepare_content( $pattern, get_hooked_blocks() ); + + return $pattern; + } + + /** + * Retrieves all registered block patterns. + * + * @since 5.5.0 + * + * @param bool $outside_init_only Return only patterns registered outside the `init` action. + * @return array[] Array of arrays containing the registered block patterns properties, + * and per style. + */ + public function get_all_registered( $outside_init_only = false ) { + $patterns = array_values( + $outside_init_only + ? $this->registered_patterns_outside_init + : $this->registered_patterns + ); + $hooked_blocks = get_hooked_blocks(); + foreach ( $patterns as $index => $pattern ) { + $patterns[ $index ]['content'] = $this->prepare_content( $pattern, $hooked_blocks ); + } + return $patterns; + } + + /** + * Checks if a block pattern is registered. + * + * @since 5.5.0 + * + * @param string $pattern_name Block pattern name including namespace. + * @return bool True if the pattern is registered, false otherwise. + */ + public function is_registered( $pattern_name ) { + return isset( $this->registered_patterns[ $pattern_name ] ); + } + + public function __wakeup() { + if ( ! $this->registered_patterns ) { + return; + } + if ( ! is_array( $this->registered_patterns ) ) { + throw new UnexpectedValueException(); + } + foreach ( $this->registered_patterns as $value ) { + if ( ! is_array( $value ) ) { + throw new UnexpectedValueException(); + } + } + $this->registered_patterns_outside_init = array(); + } + + /** + * 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_Patterns_Registry The main instance. + */ + public static function get_instance() { + if ( null === self::$instance ) { + self::$instance = new self(); + } + + return self::$instance; + } +} + +/** + * Registers a new block pattern. + * + * @since 5.5.0 + * + * @param string $pattern_name Block pattern name including namespace. + * @param array $pattern_properties List of properties for the block pattern. + * See WP_Block_Patterns_Registry::register() for accepted arguments. + * @return bool True if the pattern was registered with success and false otherwise. + */ +function register_block_pattern( $pattern_name, $pattern_properties ) { + return WP_Block_Patterns_Registry::get_instance()->register( $pattern_name, $pattern_properties ); +} + +/** + * Unregisters a block pattern. + * + * @since 5.5.0 + * + * @param string $pattern_name Block pattern name including namespace. + * @return bool True if the pattern was unregistered with success and false otherwise. + */ +function unregister_block_pattern( $pattern_name ) { + return WP_Block_Patterns_Registry::get_instance()->unregister( $pattern_name ); +} -- cgit v1.2.3