FileMaster

Edit File: class-wc-brands-block-templates.php

<?php

declare( strict_types = 1);

//phpcs:disable Squiz.Classes.ClassFileName.NoMatch, Squiz.Classes.ValidClassName.NotCamelCaps
/**
 * Utils for compatibility with WooCommerce Full Site Editor Blocks
 *
 * Important: For internal use only by the Automattic\WooCommerce\Internal\Brands package.
 *
 * @version 9.4.0
 */
class WC_Brands_Block_Templates {

/**
	 * Constructor.
	 */
	public function __construct() {
		add_action( 'get_block_templates', array( $this, 'get_block_templates' ), 10, 3 );
		add_filter( 'get_block_file_template', array( $this, 'get_block_file_template' ), 10, 3 );
		add_filter( 'woocommerce_has_block_template', array( $this, 'has_block_template' ), 10, 2 );
	}

/**
	 * Get the taxonomy-product_brand template from DB in case a user customized it in FSE
	 *
	 * @return WP_Post|null The taxonomy-product_brand
	 */
	private function get_product_brand_template_db() {
		$posts = get_posts(
			array(
				'name'           => 'taxonomy-product_brand',
				'post_type'      => 'wp_template',
				'post_status'    => 'publish',
				'posts_per_page' => 1,
			)
		);

if ( count( $posts ) ) {
			return $posts[0];
		}

return null;
	}

/**
	 * Fixes a bug regarding taxonomies and FSE.
	 * Without this, the system will always load archive-product.php version instead of taxonomy_product_brand.html
	 * it will show a deprecation error if that happens.
	 *
	 * Triggered by woocommerce_has_block_template filter
	 *
	 * @param bool   $has_template  True if the template is available.
	 * @param string $template_name The name of the template.
	 *
	 * @return bool True if the system is checking archive-product
	 */
	public function has_block_template( $has_template, $template_name ) {
		if ( 'archive-product' === $template_name || 'taxonomy-product_brand' === $template_name ) {
			$has_template = true;
		}

return $has_template;
	}

/**
	 * Get the block template for Taxonomy Product Brand. First it attempts to load the last version from DB
	 * Otherwise it loads the file based template.
	 *
	 * @param string $template_type The post_type for the template. Normally wp_template or wp_template_part.
	 *
	 * @return WP_Block_Template The taxonomy-product_brand template.
	 */
	private function get_product_brands_template( $template_type ) {
		$template_db = $this->get_product_brand_template_db();

if ( $template_db ) {
			return BlockTemplateUtilsDuplicated::gutenberg_build_template_result_from_post( $template_db );
		}

$template_path = BlockTemplateUtilsDuplicated::should_use_blockified_product_grid_templates()
			? WC()->plugin_path() . '/templates/templates/blockified/taxonomy-product_brand.html'
			: WC()->plugin_path() . '/templates/templates/taxonomy-product_brand.html';

$template_file = BlockTemplateUtilsDuplicated::create_new_block_template_object( $template_path, $template_type, 'taxonomy-product_brand', false );

return BlockTemplateUtilsDuplicated::gutenberg_build_template_result_from_file( $template_file, $template_type );
	}

/**
	 * Function to check if a template name is woocommerce/taxonomy-product_brand
	 *
	 * Notice depending on the version of WooCommerce this could be:
	 *
	 * woocommerce//taxonomy-product_brand
	 * woocommerce/woocommerce//taxonomy-product_brand
	 *
	 * @param  String $id The string to check if contains the template name.
	 *
	 * @return bool True if the template is woocommerce/taxonomy-product_brand
	 */
	private function is_taxonomy_product_brand_template( $id ) {
		return strpos( $id, 'woocommerce//taxonomy-product_brand' ) !== false;
	}

/**
	 * Get the block template for Taxonomy Product Brand if requested.
	 * Triggered by get_block_file_template action
	 *
	 * @param WP_Block_Template|null $block_template The current Block Template loaded, if any.
	 * @param string                 $id The template id normally in the format theme-slug//template-slug.
	 * @param string                 $template_type The post_type for the template. Normally wp_template or wp_template_part.
	 *
	 * @return WP_Block_Template|null The taxonomy-product_brand template.
	 */
	public function get_block_file_template( $block_template, $id, $template_type ) {
		if ( $this->is_taxonomy_product_brand_template( $id ) && is_null( $block_template ) ) {
			$block_template = $this->get_product_brands_template( $template_type );
		}

return $block_template;
	}

/**
	 * Add the Block template in the template query results needed by FSE
	 * Triggered by get_block_templates action
	 *
	 * @param array  $query_result The list of templates to render in the query.
	 * @param array  $query The current query parameters.
	 * @param string $template_type The post_type for the template. Normally wp_template or wp_template_part.
	 *
	 * @return WP_Block_Template[] Array of the matched Block Templates to render.
	 */
	public function get_block_templates( $query_result, $query, $template_type ) {
		// We don't want to run this if we are looking for template-parts. Like the header.
		if ( 'wp_template' !== $template_type ) {
			return $query_result;
		}

$post_id = isset( $_REQUEST['postId'] ) ? wc_clean( wp_unslash( $_REQUEST['postId'] ) ) : null; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
		$slugs   = $query['slug__in'] ?? array();

// Only add the template if  asking for Product Brands.
		if (
			in_array( 'taxonomy-product_brand', $slugs, true ) ||
			( ! $post_id && ! count( $slugs ) ) ||
			( ! count( $slugs ) && $this->is_taxonomy_product_brand_template( $post_id ) )
		) {
			$query_result[] = $this->get_product_brands_template( $template_type );
		}

return $query_result;
	}
}

new WC_Brands_Block_Templates();

Back