template. So we know if to load our own in or not. * * @param string $template_name name of the template file without .html extension e.g. 'single-product'. * @return boolean */ public static function theme_has_template_part( $template_name ) { return ! ! self::get_theme_template_path( $template_name, 'wp_template_part' ); } /** * Checks to see if they are using a compatible version of WP, or if not they have a compatible version of the Gutenberg plugin installed. * * @return boolean */ public static function supports_block_templates() { if ( ! wc_current_theme_is_fse_theme() && ( ! function_exists( 'gutenberg_supports_block_templates' ) || ! gutenberg_supports_block_templates() ) ) { return false; } return true; } /** * Retrieves a single unified template object using its id. * * @param string $id Template unique identifier (example: theme_slug//template_slug). * @param string $template_type Optional. Template type: `'wp_template'` or '`wp_template_part'`. * Default `'wp_template'`. * * @return WP_Block_Template|null Template. */ public static function get_block_template( $id, $template_type ) { if ( function_exists( 'get_block_template' ) ) { return get_block_template( $id, $template_type ); } if ( function_exists( 'gutenberg_get_block_template' ) ) { return gutenberg_get_block_template( $id, $template_type ); } return null; } /** * Checks if we can fall back to the `archive-product` template for a given slug. * * `taxonomy-product_cat`, `taxonomy-product_tag`, `taxonomy-product_attribute` templates can * generally use the `archive-product` as a fallback if there are no specific overrides. * * @param string $template_slug Slug to check for fallbacks. * @return boolean */ public static function template_is_eligible_for_product_archive_fallback( $template_slug ) { return in_array( $template_slug, self::ELIGIBLE_FOR_ARCHIVE_PRODUCT_FALLBACK, true ); } /** * Checks if we can fall back to an `archive-product` template stored on the db for a given slug. * * @param string $template_slug Slug to check for fallbacks. * @param array $db_templates Templates that have already been found on the db. * @return boolean */ public static function template_is_eligible_for_product_archive_fallback_from_db( $template_slug, $db_templates ) { $eligible_for_fallback = self::template_is_eligible_for_product_archive_fallback( $template_slug ); if ( ! $eligible_for_fallback ) { return false; } $array_filter = array_filter( $db_templates, function ( $template ) use ( $template_slug ) { return 'archive-product' === $template->slug; } ); return count( $array_filter ) > 0; } /** * Gets the `archive-product` fallback template stored on the db for a given slug. * * @param string $template_slug Slug to check for fallbacks. * @param array $db_templates Templates that have already been found on the db. * @return boolean|object */ public static function get_fallback_template_from_db( $template_slug, $db_templates ) { $eligible_for_fallback = self::template_is_eligible_for_product_archive_fallback( $template_slug ); if ( ! $eligible_for_fallback ) { return false; } foreach ( $db_templates as $template ) { if ( 'archive-product' === $template->slug ) { return $template; } } return false; } /** * Checks if we can fall back to the `archive-product` file template for a given slug in the current theme. * * `taxonomy-product_cat`, `taxonomy-product_tag`, `taxonomy-attribute` templates can * generally use the `archive-product` as a fallback if there are no specific overrides. * * @param string $template_slug Slug to check for fallbacks. * @return boolean */ public static function template_is_eligible_for_product_archive_fallback_from_theme( $template_slug ) { return self::template_is_eligible_for_product_archive_fallback( $template_slug ) && ! self::theme_has_template( $template_slug ) && self::theme_has_template( 'archive-product' ); } /** * Sets the `has_theme_file` to `true` for templates with fallbacks * * There are cases (such as tags, categories and attributes) in which fallback templates * can be used; so, while *technically* the theme doesn't have a specific file * for them, it is important that we tell Gutenberg that we do, in fact, * have a theme file (i.e. the fallback one). * * **Note:** this function changes the array that has been passed. * * It returns `true` if anything was changed, `false` otherwise. * * @param array $query_result Array of template objects. * @param object $template A specific template object which could have a fallback. * * @return boolean */ public static function set_has_theme_file_if_fallback_is_available( $query_result, $template ) { foreach ( $query_result as &$query_result_template ) { if ( $query_result_template->slug === $template->slug && $query_result_template->theme === $template->theme ) { if ( self::template_is_eligible_for_product_archive_fallback_from_theme( $template->slug ) ) { $query_result_template->has_theme_file = true; } return true; } } return false; } /** * Filter block templates by feature flag. * * @param WP_Block_Template[] $block_templates An array of block template objects. * * @return WP_Block_Template[] An array of block template objects. */ public static function filter_block_templates_by_feature_flag( $block_templates ) { $feature_gating = new FeatureGating(); $flag = $feature_gating->get_flag(); /** * An array of block templates with slug as key and flag as value. * * @var array */ $block_templates_with_feature_gate = array(); return array_filter( $block_templates, function( $block_template ) use ( $flag, $block_templates_with_feature_gate ) { if ( isset( $block_templates_with_feature_gate[ $block_template->slug ] ) ) { return $block_templates_with_feature_gate[ $block_template->slug ] <= $flag; } return true; } ); } /** * Removes templates that were added to a theme's block-templates directory, but already had a customised version saved in the database. * * @param \WP_Block_Template[]|\stdClass[] $templates List of templates to run the filter on. * * @return array List of templates with duplicates removed. The customised alternative is preferred over the theme default. */ public static function remove_theme_templates_with_custom_alternative( $templates ) { // Get the slugs of all templates that have been customised and saved in the database. $customised_template_slugs = array_map( function( $template ) { return $template->slug; }, array_values( array_filter( $templates, function( $template ) { // This template has been customised and saved as a post. return 'custom' === $template->source; } ) ) ); // Remove theme (i.e. filesystem) templates that have the same slug as a customised one. We don't need to check // for `woocommerce` in $template->source here because woocommerce templates won't have been added to $templates // if a saved version was found in the db. This only affects saved templates that were saved BEFORE a theme // template with the same slug was added. return array_values( array_filter( $templates, function( $template ) use ( $customised_template_slugs ) { // This template has been customised and saved as a post, so return it. return ! ( 'theme' === $template->source && in_array( $template->slug, $customised_template_slugs, true ) ); } ) ); } /** * Returns whether the blockified templates should be used or not. * If the option is not stored on the db, we need to check if the current theme is a block one or not. * * @return boolean */ public static function should_use_blockified_product_grid_templates() { $use_blockified_templates = get_option( Options::WC_BLOCK_USE_BLOCKIFIED_PRODUCT_GRID_BLOCK_AS_TEMPLATE ); if ( false === $use_blockified_templates ) { return wc_current_theme_is_fse_theme(); } return wc_string_to_bool( $use_blockified_templates ); } /** * Returns whether the passed `$template` has a title, and it's different from the slug. * * @param object $template The template object. * @return boolean */ public static function template_has_title( $template ) { return ! empty( $template->title ) && $template->title !== $template->slug; } }