Automattic\WooCommerce\LayoutTemplates

LayoutTemplateRegistry{} │ final │ WC 1.0

Removed layout template registry.

No Hooks.

Usage

$LayoutTemplateRegistry = new LayoutTemplateRegistry();
// use class methods

Methods

1. public __construct()
2. public static get_instance()
3. public instantiate_layout_templates( array $query_params = array() )
4. public is_registered( $layout_template_id )
5. public register( $layout_template_id, $layout_template_area, $layout_template_class_name )
6. public unregister_all()
7. private static maybe_log_removal_warning()

Changelog

LayoutTemplateRegistry{} LayoutTemplateRegistry{} code ^{WC 11.0.1}

final class LayoutTemplateRegistry {
	/**
	 * Singleton instance.
	 *
	 * @var LayoutTemplateRegistry|null
	 */
	private static $instance = null;

	/**
	 * Whether the removal warning has already been logged for the current request.
	 *
	 * @var bool
	 */
	private static $removal_warning_logged = false;

	/**
	 * Constructor.
	 */
	public function __construct() {
		self::maybe_log_removal_warning();
	}

	/**
	 * Get the singleton instance.
	 *
	 * @return LayoutTemplateRegistry
	 */
	public static function get_instance(): LayoutTemplateRegistry {
		$instance = self::$instance;

		if ( null === $instance ) {
			$instance       = new self();
			self::$instance = $instance;
		}

		self::maybe_log_removal_warning();

		return $instance;
	}

	/**
	 * Unregister all layout templates.
	 *
	 * @return void
	 */
	public function unregister_all() {
		self::maybe_log_removal_warning();
	}

	/**
	 * Check if a layout template is registered.
	 *
	 * @param string $layout_template_id Layout template ID.
	 * @return bool
	 */
	public function is_registered( $layout_template_id ): bool {
		unset( $layout_template_id );

		self::maybe_log_removal_warning();

		return false;
	}

	/**
	 * Register a single layout template.
	 *
	 * @param string $layout_template_id         Layout template ID.
	 * @param string $layout_template_area       Layout template area.
	 * @param string $layout_template_class_name Layout template class to register.
	 * @return void
	 */
	public function register( $layout_template_id, $layout_template_area, $layout_template_class_name ) {
		unset( $layout_template_id, $layout_template_area, $layout_template_class_name );

		self::maybe_log_removal_warning();
	}

	/**
	 * Instantiate the matching layout templates and return them.
	 *
	 * @param array $query_params Query params.
	 * @return array
	 */
	public function instantiate_layout_templates( array $query_params = array() ): array {
		unset( $query_params );

		self::maybe_log_removal_warning();

		return array();
	}

	/**
	 * Log a warning about the removed compatibility class.
	 */
	private static function maybe_log_removal_warning(): void {
		if ( self::$removal_warning_logged || ! function_exists( 'wc_get_logger' ) ) {
			return;
		}

		self::$removal_warning_logged = true;

		wc_get_logger()->warning(
			'Automattic\WooCommerce\LayoutTemplates\LayoutTemplateRegistry is a temporary compatibility shim and will be removed soon. Block template extension APIs were deprecated in WooCommerce 10.9.0, and the block templates API was removed in WooCommerce 11.0.0 with no replacement.',
			array( 'source' => 'block-templates' )
		);
	}
}