get_block_templates( array $query = array(), string $template_type = 'wp_template' ): WP_Block_Template[]

Parameters

$queryarrayoptional

Arguments to retrieve templates.Default: array()

• $slug__instring[]

  List of slugs to include.

• $wp_idint

  Post ID of customized template.

• $areastring

  A 'wp_template_part_area' taxonomy value to filter by (for 'wp_template_part' template type only).

• $post_typestring

  Post type to get the templates for.

$template_typestringoptional

Template type. Either 'wp_template' or 'wp_template_part'.Default: 'wp_template'

Return

WP_Block_Template[]

Array of block templates.

Hooks fired · 2

2 hooks fire while get_block_templates() runs, in this order:

1. 1
   apply_filters( pre_get_block_templates )filterline 1125 (+20 into the body)

   Filters the block templates array before the query takes place.

2. 2
   apply_filters( get_block_templates )filterline 1275 (+170 into the body)

   Filters the array of queried block templates array after they've been fetched.

Uses · 12

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_stylesheet()Retrieves name of the current stylesheet.
• _build_block_template_result_from_post()Builds a unified template object based a post Object.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• _get_block_templates_files()Retrieves the template files from the theme.
• _build_block_template_result_from_file()Builds a unified template object based on a theme file.
• get_default_block_template_types()Returns a filtered list of default template types, containing their localized titles and descriptions.
• apply_block_hooks_to_content()Runs the hooked blocks algorithm on the given content.
• WP_Query::__construct()Constructor.
• WP_Block_Templates_Registry::get_instance()::get_by_query()
• WP_Block_Templates_Registry::get_instance()Utility method to retrieve the main instance of the class.

Used by · 7

• WP_REST_Templates_Controller::create_item()Creates a single template.
• WP_REST_Templates_Controller::get_items()Returns a list of templates.
• WP_Theme::get_post_templates()Returns the theme's post templates.
• build_template_part_block_instance_variations()Returns an array of instance variation objects for the template part block
• resolve_block_template()Returns the correct 'wp_template' to render for the request template type.
• wp_generate_block_templates_export_file()Creates an export of the current templates and template parts from the site editor at the specified path in a ZIP file.
• wp_get_post_content_block_attributes()Retrieves Post Content block attributes from the current post template.

Source

View on Trac ↗View on GitHub ↗

1105function get_block_templates( $query = array(), $template_type = 'wp_template' ) {1106	/**1107	 * Filters the block templates array before the query takes place.1108	 *1109	 * Return a non-null value to bypass the WordPress queries.1110	 *1111	 * @since 5.9.01112	 *1113	 * @param WP_Block_Template[]|null $block_templates Return an array of block templates to short-circuit the default query,1114	 *                                                  or null to allow WP to run its normal queries.1115	 * @param array  $query {1116	 *     Arguments to retrieve templates. All arguments are optional.1117	 *1118	 *     @type string[] $slug__in  List of slugs to include.1119	 *     @type int      $wp_id     Post ID of customized template.1120	 *     @type string   $area      A 'wp_template_part_area' taxonomy value to filter by (for 'wp_template_part' template type only).1121	 *     @type string   $post_type Post type to get the templates for.1122	 * }1123	 * @param string $template_type Template type. Either 'wp_template' or 'wp_template_part'.1124	 */1125	$templates = apply_filters( 'pre_get_block_templates', null, $query, $template_type );1126	if ( ! is_null( $templates ) ) {1127		return $templates;1128	}1129 1130	$post_type     = $query['post_type'] ?? '';1131	$wp_query_args = array(1132		'post_status'         => array( 'auto-draft', 'draft', 'publish' ),1133		'post_type'           => $template_type,1134		'posts_per_page'      => -1,1135		'no_found_rows'       => true,1136		'lazy_load_term_meta' => false,1137		'tax_query'           => array(1138			array(1139				'taxonomy' => 'wp_theme',1140				'field'    => 'name',1141				'terms'    => get_stylesheet(),1142			),1143		),1144	);1145 1146	if ( 'wp_template_part' === $template_type && isset( $query['area'] ) ) {1147		$wp_query_args['tax_query'][]           = array(1148			'taxonomy' => 'wp_template_part_area',1149			'field'    => 'name',1150			'terms'    => $query['area'],1151		);1152		$wp_query_args['tax_query']['relation'] = 'AND';1153	}1154 1155	if ( ! empty( $query['slug__in'] ) ) {1156		$wp_query_args['post_name__in']  = $query['slug__in'];1157		$wp_query_args['posts_per_page'] = count( array_unique( $query['slug__in'] ) );1158	}1159 1160	// This is only needed for the regular templates/template parts post type listing and editor.1161	if ( isset( $query['wp_id'] ) ) {1162		$wp_query_args['p'] = $query['wp_id'];1163	} else {1164		$wp_query_args['post_status'] = 'publish';1165	}1166 1167	$template_query = new WP_Query( $wp_query_args );1168	$query_result   = array();1169	foreach ( $template_query->posts as $post ) {1170		$template = _build_block_template_result_from_post( $post );1171 1172		if ( is_wp_error( $template ) ) {1173			continue;1174		}1175 1176		if ( $post_type && ! $template->is_custom ) {1177			continue;1178		}1179 1180		if (1181			$post_type &&1182			isset( $template->post_types ) &&1183			! in_array( $post_type, $template->post_types, true )1184		) {

History

Introduced in 5.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/block-template-utils.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.