WP_Block_Bindings_Registry::register( string $source_name, array $source_properties ): WP_Block_Bindings_Source|false

Source

public function register( string $source_name, array $source_properties ) {
	if ( ! is_string( $source_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Block bindings source name must be a string.' ),
			'6.5.0'
		);
		return false;
	}

	if ( preg_match( '/[A-Z]+/', $source_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Block bindings source names must not contain uppercase characters.' ),
			'6.5.0'
		);
		return false;
	}

	$name_matcher = '/^[a-z0-9-]+\/[a-z0-9-]+$/';
	if ( ! preg_match( $name_matcher, $source_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Block bindings source names must contain a namespace prefix. Example: my-plugin/my-custom-source' ),
			'6.5.0'
		);
		return false;
	}

	if ( $this->is_registered( $source_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			/* translators: %s: Block bindings source name. */
			sprintf( __( 'Block bindings source "%s" already registered.' ), $source_name ),
			'6.5.0'
		);
		return false;
	}

	// Validates that the source properties contain the label.
	if ( ! isset( $source_properties['label'] ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'The $source_properties must contain a "label".' ),
			'6.5.0'
		);
		return false;
	}

	// Validates that the source properties contain the get_value_callback.
	if ( ! isset( $source_properties['get_value_callback'] ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'The $source_properties must contain a "get_value_callback".' ),
			'6.5.0'
		);
		return false;
	}

	// Validates that the get_value_callback is a valid callback.
	if ( ! is_callable( $source_properties['get_value_callback'] ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'The "get_value_callback" parameter must be a valid callback.' ),
			'6.5.0'
		);
		return false;
	}

	// Validates that the uses_context parameter is an array.
	if ( isset( $source_properties['uses_context'] ) && ! is_array( $source_properties['uses_context'] ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'The "uses_context" parameter must be an array.' ),
			'6.5.0'
		);
		return false;
	}

	if ( ! empty( array_diff( array_keys( $source_properties ), $this->allowed_source_properties ) ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'The $source_properties array contains invalid properties.' ),
			'6.5.0'
		);
		return false;
	}

	$source = new WP_Block_Bindings_Source(
		$source_name,
		$source_properties
	);

	$this->sources[ $source_name ] = $source;

	return $source;
}

View all references View on Trac View on GitHub