Automattic\WooCommerce\Admin\Features\ProductBlockEditor

BlockTemplateUtils{} │ WC 1.0

Utils for block templates.

No Hooks.

Usage

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

Methods

1. public static get_block_template_path( $slug )
2. public static get_template_content( $file_path )
3. public static get_template_file_data( $file_path )
4. ERROR: no method name found on line ``
5. ERROR: no method name found on line ``
6. ERROR: no method name found on line ``
7. ERROR: no method name found on line `'title' => 'Title',`
8. ERROR: no method name found on line ``
9. ERROR: no method name found on line ``
10. ERROR: no method name found on line ``
11. ERROR: no method name found on line ``
12. ERROR: no method name found on line ``
13. ERROR: no method name found on line ``
14. ERROR: no method name found on line `* Get the template data from the headers.`
15. ERROR: no method name found on line ``
16. ERROR: no method name found on line ``
17. private static get_templates_directory( $template_type = 'wp_template' )
18. ERROR: no method name found on line ``
19. ERROR: no method name found on line ``
20. ERROR: no method name found on line ``
21. ERROR: no method name found on line ``
22. ERROR: no method name found on line ``
23. ERROR: no method name found on line ``
24. ERROR: no method name found on line ``
25. ERROR: no method name found on line ``
26. ERROR: no method name found on line ``
27. ERROR: no method name found on line ``
28. ERROR: no method name found on line ``
29. ERROR: no method name found on line ``

Changelog

BlockTemplateUtils{} BlockTemplateUtils{} code ^{WC 10.9.4}

class BlockTemplateUtils {
	/**
	 * Directory which contains all templates
	 *
	 * @var string
	 */
	const TEMPLATES_ROOT_DIR = 'templates';

	/**
	 * Directory names.
	 *
	 * @var array
	 */
	const DIRECTORY_NAMES = array(
		'TEMPLATES'      => 'product-form',
		'TEMPLATE_PARTS' => 'product-form/parts',
	);

	/**
	 * Gets the directory where templates of a specific template type can be found.
	 *
	 * @param string $template_type wp_template or wp_template_part.
	 * @return string
	 */
	private static function get_templates_directory( $template_type = 'wp_template' ) {
		$root_path                = dirname( __DIR__, 4 ) . '/' . self::TEMPLATES_ROOT_DIR . DIRECTORY_SEPARATOR;
		$templates_directory      = $root_path . self::DIRECTORY_NAMES['TEMPLATES'];
		$template_parts_directory = $root_path . self::DIRECTORY_NAMES['TEMPLATE_PARTS'];

		if ( 'wp_template_part' === $template_type ) {
			return $template_parts_directory;
		}

		return $templates_directory;
	}

	/**
	 * Return the path to a block template file.
	 * Otherwise, False.
	 *
	 * @param string $slug - Template slug.
	 * @return string|bool   Path to the template file or false.
	 */
	public static function get_block_template_path( $slug ) {
		$directory = self::get_templates_directory();
		$path      = trailingslashit( $directory ) . $slug . '.php';

		if ( ! file_exists( $path ) ) {
			return false;
		}

		return $path;
	}

	/**
	 * Get the template data from the headers.
	 *
	 * @param string $file_path - File path.
	 * @return array              Template data.
	 */
	public static function get_template_file_data( $file_path ) {
		if ( ! file_exists( $file_path ) ) {
			return array();
		}

		$file_data = get_file_data(
			$file_path,
			array(
				'title'         => 'Title',
				'slug'          => 'Slug',
				'description'   => 'Description',
				'product_types' => 'Product Types',
			),
		);

		$file_data['product_types'] = explode( ',', trim( $file_data['product_types'] ) );

		return $file_data;
	}

	/**
	 * Get the template content from the file.
	 *
	 * @param string $file_path - File path.
	 * @return string Content.
	 */
	public static function get_template_content( $file_path ) {
		if ( ! file_exists( $file_path ) ) {
			return '';
		}

		ob_start();
		include $file_path;
		$content = ob_get_contents();
		ob_end_clean();

		return $content;
	}
}