File Manager

📂 File Manager

📝 Edit File: class-wp-block-templates-registry.php

<?php
/**
 * Templates registry functions.
 *
 * @package WordPress
 * @since 6.7.0
 */

/**
 * Core class used for interacting with templates.
 *
 * @since 6.7.0
 */
final class WP_Block_Templates_Registry {
	/**
	 * Registered templates, as `$name => $instance` pairs.
	 *
	 * @since 6.7.0
	 * @var WP_Block_Template[] $registered_block_templates Registered templates.
	 */
	private $registered_templates = array();

/**
	 * Container for the main instance of the class.
	 *
	 * @since 6.7.0
	 * @var WP_Block_Templates_Registry|null
	 */
	private static $instance = null;

/**
	 * Registers a template.
	 *
	 * @since 6.7.0
	 *
	 * @param string $template_name Template name including namespace.
	 * @param array  $args          Optional. Array of template arguments.
	 * @return WP_Block_Template|WP_Error The registered template on success, or WP_Error on failure.
	 */
	public function register( $template_name, $args = array() ) {

$template = null;

$error_message = '';
		$error_code    = '';

if ( ! is_string( $template_name ) ) {
			$error_message = __( 'Template names must be strings.' );
			$error_code    = 'template_name_no_string';
		} elseif ( preg_match( '/[A-Z]+/', $template_name ) ) {
			$error_message = __( 'Template names must not contain uppercase characters.' );
			$error_code    = 'template_name_no_uppercase';
		} elseif ( ! preg_match( '/^[a-z0-9_\-]+\/\/[a-z0-9_\-]+$/', $template_name ) ) {
			$error_message = __( 'Template names must contain a namespace prefix. Example: my-plugin//my-custom-template' );
			$error_code    = 'template_no_prefix';
		} elseif ( $this->is_registered( $template_name ) ) {
			/* translators: %s: Template name. */
			$error_message = sprintf( __( 'Template "%s" is already registered.' ), $template_name );
			$error_code    = 'template_already_registered';
		}

if ( $error_message ) {
			_doing_it_wrong(
				__METHOD__,
				$error_message,
				'6.7.0'
			);
			return new WP_Error( $error_code, $error_message );
		}

if ( ! $template ) {
			$theme_name             = get_stylesheet();
			list( $plugin, $slug )  = explode( '//', $template_name );
			$default_template_types = get_default_block_template_types();

$template              = new WP_Block_Template();
			$template->id          = $theme_name . '//' . $slug;
			$template->theme       = $theme_name;
			$template->plugin      = $plugin;
			$template->author      = null;
			$template->content     = isset( $args['content'] ) ? $args['content'] : '';
			$template->source      = 'plugin';
			$template->slug        = $slug;
			$template->type        = 'wp_template';
			$template->title       = isset( $args['title'] ) ? $args['title'] : $template_name;
			$template->description = isset( $args['description'] ) ? $args['description'] : '';
			$template->status      = 'publish';
			$template->origin      = 'plugin';
			$template->is_custom   = ! isset( $default_template_types[ $template_name ] );
			$template->post_types  = isset( $args['post_types'] ) ? $args['post_types'] : array();
		}

$this->registered_templates[ $template_name ] = $template;

return $template;
	}

/**
	 * Retrieves all registered templates.
	 *
	 * @since 6.7.0
	 *
	 * @return WP_Block_Template[] Associative array of `$template_name => $template` pairs.
	 */
	public function get_all_registered() {
		return $this->registered_templates;
	}

/**
	 * Retrieves a registered template by its name.
	 *
	 * @since 6.7.0
	 *
	 * @param string $template_name Template name including namespace.
	 * @return WP_Block_Template|null The registered template, or null if it is not registered.
	 */
	public function get_registered( $template_name ) {
		if ( ! $this->is_registered( $template_name ) ) {
			return null;
		}

return $this->registered_templates[ $template_name ];
	}

/**
	 * Retrieves a registered template by its slug.
	 *
	 * @since 6.7.0
	 *
	 * @param string $template_slug Slug of the template.
	 * @return WP_Block_Template|null The registered template, or null if it is not registered.
	 */
	public function get_by_slug( $template_slug ) {
		$all_templates = $this->get_all_registered();

if ( ! $all_templates ) {
			return null;
		}

foreach ( $all_templates as $template ) {
			if ( $template->slug === $template_slug ) {
				return $template;
			}
		}

return null;
	}

/**
	 * Retrieves registered templates matching a query.
	 *
	 * @since 6.7.0
	 *
	 * @param array  $query {
	 *     Arguments to retrieve templates. Optional, empty by default.
	 *
	 *     @type string[] $slug__in     List of slugs to include.
	 *     @type string[] $slug__not_in List of slugs to skip.
	 *     @type string   $post_type    Post type to get the templates for.
	 * }
	 * @return WP_Block_Template[] Associative array of `$template_name => $template` pairs.
	 */
	public function get_by_query( $query = array() ) {
		$all_templates = $this->get_all_registered();

if ( ! $all_templates ) {
			return array();
		}

$query            = wp_parse_args(
			$query,
			array(
				'slug__in'     => array(),
				'slug__not_in' => array(),
				'post_type'    => '',
			)
		);
		$slugs_to_include = $query['slug__in'];
		$slugs_to_skip    = $query['slug__not_in'];
		$post_type        = $query['post_type'];

$matching_templates = array();
		foreach ( $all_templates as $template_name => $template ) {
			if ( $slugs_to_include && ! in_array( $template->slug, $slugs_to_include, true ) ) {
				continue;
			}

if ( $slugs_to_skip && in_array( $template->slug, $slugs_to_skip, true ) ) {
				continue;
			}

if ( $post_type && ! in_array( $post_type, $template->post_types, true ) ) {
				continue;
			}

$matching_templates[ $template_name ] = $template;
		}

return $matching_templates;
	}

/**
	 * Checks if a template is registered.
	 *
	 * @since 6.7.0
	 *
	 * @param string $template_name Template name.
	 * @return bool True if the template is registered, false otherwise.
	 */
	public function is_registered( $template_name ) {
		return isset( $this->registered_templates[ $template_name ] );
	}

/**
	 * Unregisters a template.
	 *
	 * @since 6.7.0
	 *
	 * @param string $template_name Template name including namespace.
	 * @return WP_Block_Template|WP_Error The unregistered template on success, or WP_Error on failure.
	 */
	public function unregister( $template_name ) {
		if ( ! $this->is_registered( $template_name ) ) {
			_doing_it_wrong(
				__METHOD__,
				/* translators: %s: Template name. */
				sprintf( __( 'Template "%s" is not registered.' ), $template_name ),
				'6.7.0'
			);
			/* translators: %s: Template name. */
			return new WP_Error( 'template_not_registered', __( 'Template "%s" is not registered.' ) );
		}

$unregistered_template = $this->registered_templates[ $template_name ];
		unset( $this->registered_templates[ $template_name ] );

return $unregistered_template;
	}

/**
	 * Utility method to retrieve the main instance of the class.
	 *
	 * The instance will be created if it does not exist yet.
	 *
	 * @since 6.7.0
	 *
	 * @return WP_Block_Templates_Registry The main instance.
	 */
	public static function get_instance() {
		if ( null === self::$instance ) {
			self::$instance = new self();
		}

return self::$instance;
	}
}

Type	Item Name	Actions
📁	..
📁	assets
📁	block-bindings
📁	block-patterns
📁	block-supports
📁	blocks
📁	certificates
📁	css
📁	customize
📁	fonts
📁	html-api
📁	ID3
📁	images
📁	interactivity-api
📁	IXR
📁	js
📁	l10n
📁	php-compat
📁	PHPMailer
📁	pomo
📁	Requests
📁	rest-api
📁	SimplePie
📁	sitemaps
📁	sodium_compat
📁	style-engine
📁	Text
📁	theme-compat
📁	widgets
📄	admin-bar.php
📄	atomlib.php
📄	author-template.php
📄	block-bindings.php
📄	block-editor.php
📄	block-i18n.json
📄	block-patterns.php
📄	block-template-utils.php
📄	block-template.php
📄	blocks.php
📄	bookmark-template.php
📄	bookmark.php
📄	cache-compat.php
📄	cache.php
📄	canonical.php
📄	capabilities.php
📄	category-template.php
📄	category.php
📄	class-avif-info.php
📄	class-feed.php
📄	class-http.php
📄	class-IXR.php
📄	class-json.php
📄	class-oembed.php
📄	class-phpass.php
📄	class-phpmailer.php
📄	class-pop3.php
📄	class-requests.php
📄	class-simplepie.php
📄	class-smtp.php
📄	class-snoopy.php
📄	class-walker-category-dropdown.php
📄	class-walker-category.php
📄	class-walker-comment.php
📄	class-walker-nav-menu.php
📄	class-walker-page-dropdown.php
📄	class-walker-page.php
📄	class-wp-admin-bar.php
📄	class-wp-ajax-response.php
📄	class-wp-application-passwords.php
📄	class-wp-block-bindings-registry.php
📄	class-wp-block-bindings-source.php
📄	class-wp-block-editor-context.php
📄	class-wp-block-list.php
📄	class-wp-block-metadata-registry.php
📄	class-wp-block-parser-block.php
📄	class-wp-block-parser-frame.php
📄	class-wp-block-parser.php
📄	class-wp-block-pattern-categories-registry.php
📄	class-wp-block-patterns-registry.php
📄	class-wp-block-styles-registry.php
📄	class-wp-block-supports.php
📄	class-wp-block-template.php
📄	class-wp-block-templates-registry.php
📄	class-wp-block-type-registry.php
📄	class-wp-block-type.php
📄	class-wp-block.php
📄	class-wp-classic-to-block-menu-converter.php
📄	class-wp-comment-query.php
📄	class-wp-comment.php
📄	class-wp-customize-control.php
📄	class-wp-customize-manager.php
📄	class-wp-customize-nav-menus.php
📄	class-wp-customize-panel.php
📄	class-wp-customize-section.php
📄	class-wp-customize-setting.php
📄	class-wp-customize-widgets.php
📄	class-wp-date-query.php
📄	class-wp-dependencies.php
📄	class-wp-dependency.php
📄	class-wp-duotone.php
📄	class-wp-editor.php
📄	class-wp-embed.php
📄	class-wp-error.php
📄	class-wp-exception.php
📄	class-wp-fatal-error-handler.php
📄	class-wp-feed-cache-transient.php
📄	class-wp-feed-cache.php
📄	class-wp-hook.php
📄	class-wp-http-cookie.php
📄	class-wp-http-curl.php
📄	class-wp-http-encoding.php
📄	class-wp-http-ixr-client.php
📄	class-wp-http-proxy.php
📄	class-wp-http-requests-hooks.php
📄	class-wp-http-requests-response.php
📄	class-wp-http-response.php
📄	class-wp-http-streams.php
📄	class-wp-http.php
📄	class-wp-image-editor-gd.php
📄	class-wp-image-editor-imagick.php
📄	class-wp-image-editor.php
📄	class-wp-list-util.php
📄	class-wp-locale-switcher.php
📄	class-wp-locale.php
📄	class-wp-matchesmapregex.php
📄	class-wp-meta-query.php
📄	class-wp-metadata-lazyloader.php
📄	class-wp-navigation-fallback.php
📄	class-wp-network-query.php
📄	class-wp-network.php
📄	class-wp-object-cache.php
📄	class-wp-oembed-controller.php
📄	class-wp-oembed.php
📄	class-wp-paused-extensions-storage.php
📄	class-wp-plugin-dependencies.php
📄	class-wp-post-type.php
📄	class-wp-post.php
📄	class-wp-query.php
📄	class-wp-recovery-mode-cookie-service.php
📄	class-wp-recovery-mode-email-service.php
📄	class-wp-recovery-mode-key-service.php
📄	class-wp-recovery-mode-link-service.php
📄	class-wp-recovery-mode.php
📄	class-wp-rewrite.php
📄	class-wp-role.php
📄	class-wp-roles.php
📄	class-wp-script-modules.php
📄	class-wp-scripts.php
📄	class-wp-session-tokens.php
📄	class-wp-simplepie-file.php
📄	class-wp-simplepie-sanitize-kses.php
📄	class-wp-site-query.php
📄	class-wp-site.php
📄	class-wp-styles.php
📄	class-wp-tax-query.php
📄	class-wp-taxonomy.php
📄	class-wp-term-query.php
📄	class-wp-term.php
📄	class-wp-text-diff-renderer-inline.php
📄	class-wp-text-diff-renderer-table.php
📄	class-wp-textdomain-registry.php
📄	class-wp-theme-json-data.php
📄	class-wp-theme-json-resolver.php
📄	class-wp-theme-json-schema.php
📄	class-wp-theme-json.php
📄	class-wp-theme.php
📄	class-wp-token-map.php
📄	class-wp-user-meta-session-tokens.php
📄	class-wp-user-query.php
📄	class-wp-user-request.php
📄	class-wp-user.php
📄	class-wp-walker.php
📄	class-wp-widget-factory.php
📄	class-wp-widget.php
📄	class-wp-xmlrpc-server.php
📄	class-wp.php
📄	class-wpdb.php
📄	class.wp-dependencies.php
📄	class.wp-scripts.php
📄	class.wp-styles.php
📄	comment-template.php
📄	comment.php
📄	compat.php
📄	cron.php
📄	date.php
📄	default-constants.php
📄	default-filters.php
📄	default-widgets.php
📄	deprecated.php
📄	embed-template.php
📄	embed.php
📄	error-protection.php
📄	feed-atom-comments.php
📄	feed-atom.php
📄	feed-rdf.php
📄	feed-rss.php
📄	feed-rss2-comments.php
📄	feed-rss2.php
📄	feed.php
📄	fonts.php
📄	formatting.php
📄	functions.php
📄	functions.wp-scripts.php
📄	functions.wp-styles.php
📄	general-template.php
📄	global-styles-and-settings.php
📄	http.php
📄	https-detection.php
📄	https-migration.php
📄	kses.php
📄	l10n.php
📄	link-template.php
📄	load.php
📄	locale.php
📄	media-template.php
📄	media.php
📄	meta.php
📄	ms-blogs.php
📄	ms-default-constants.php
📄	ms-default-filters.php
📄	ms-deprecated.php
📄	ms-files.php
📄	ms-functions.php
📄	ms-load.php
📄	ms-network.php
📄	ms-settings.php
📄	ms-site.php
📄	nav-menu-template.php
📄	nav-menu.php
📄	option.php
📄	pluggable-deprecated.php
📄	pluggable.php
📄	plugin.php
📄	post-formats.php
📄	post-template.php
📄	post-thumbnail-template.php
📄	post.php
📄	query.php
📄	registration-functions.php
📄	registration.php
📄	rest-api.php
📄	revision.php
📄	rewrite.php
📄	robots-template.php
📄	rss-functions.php
📄	rss.php
📄	script-loader.php
📄	script-modules.php
📄	session.php
📄	shortcodes.php
📄	sitemaps.php
📄	spl-autoload-compat.php
📄	style-engine.php
📄	taxonomy.php
📄	template-canvas.php
📄	template-loader.php
📄	template.php
📄	theme-i18n.json
📄	theme-previews.php
📄	theme-templates.php
📄	theme.json
📄	theme.php
📄	update.php
📄	user.php
📄	vars.php
📄	version.php
📄	widgets.php
📄	wp-db.php
📄	wp-diff.php