WP_Block_Patterns_Registry::register()publicWP 5.5.0

Registers a block pattern.

{} Это метод класса: WP_Block_Patterns_Registry{}

Хуков нет.

Возвращает

true|false. True if the pattern was registered with success and false otherwise.

Использование

$WP_Block_Patterns_Registry = new WP_Block_Patterns_Registry();
$WP_Block_Patterns_Registry->register( $pattern_name, $pattern_properties );
$pattern_name(строка) (обязательный)
Block pattern name including namespace.
$pattern_properties(массив) (обязательный)

List of properties for the block pattern.

  • title(строка)
    Required. A human-readable title for the pattern.

  • content(строка)
    Required. Block HTML markup for the pattern.

  • description(строка)
    Optional. Visually hidden text used to describe the pattern in the inserter. A description is optional, but is strongly encouraged when the title does not fully describe what the pattern does. The description will help users discover the pattern while searching.

  • viewportWidth(int)
    Optional. The intended width of the pattern to allow for a scaled preview within the pattern inserter.

  • categories(массив)
    Optional. A list of registered pattern categories used to group block patterns. Block patterns can be shown on multiple categories. A category must be registered separately in order to be used here.

  • keywords(массив)
    Optional. A list of aliases or keywords that help users discover the pattern while searching.

Список изменений

С версии 5.5.0 Введена.

Код WP_Block_Patterns_Registry::register() WP 5.9.3

public function register( $pattern_name, $pattern_properties ) {
	if ( ! isset( $pattern_name ) || ! is_string( $pattern_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Pattern name must be a string.' ),
			'5.5.0'
		);
		return false;
	}

	if ( ! isset( $pattern_properties['title'] ) || ! is_string( $pattern_properties['title'] ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Pattern title must be a string.' ),
			'5.5.0'
		);
		return false;
	}

	if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Pattern content must be a string.' ),
			'5.5.0'
		);
		return false;
	}

	$this->registered_patterns[ $pattern_name ] = array_merge(
		$pattern_properties,
		array( 'name' => $pattern_name )
	);

	return true;
}