WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

_add_block_template_part_area_info()

_add_block_template_part_area_info( array $template_info ): array

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Attempts to add the template part’s area information to the input template.

Parameters

$template_infoarrayrequired
Template to add information to (requires 'type' and 'slug' fields).

Return

array Template info.

Source

function _add_block_template_part_area_info( $template_info ) {
	if ( wp_theme_has_theme_json() ) {
		$theme_data = wp_get_theme_data_template_parts();
	}

	if ( isset( $theme_data[ $template_info['slug'] ]['area'] ) ) {
		$template_info['title'] = $theme_data[ $template_info['slug'] ]['title'];
		$template_info['area']  = _filter_block_template_part_area( $theme_data[ $template_info['slug'] ]['area'] );
	} else {
		$template_info['area'] = WP_TEMPLATE_PART_AREA_UNCATEGORIZED;
	}

	return $template_info;
}

View all references View on Trac View on GitHub

UsesDescription
wp_get_theme_data_template_parts()wp-includes/global-styles-and-settings.php

Returns the metadata for the template parts defined by the theme.

wp_theme_has_theme_json()wp-includes/global-styles-and-settings.php

Checks whether a theme or its parent has a theme.json file.

_filter_block_template_part_area()wp-includes/block-template-utils.php

Checks whether the input ‘area’ is a supported value.

Used byDescription
_get_block_template_file()wp-includes/block-template-utils.php

Retrieves the template file from the theme for a given slug.

_get_block_templates_files()wp-includes/block-template-utils.php

Retrieves the template files from the theme.

Changelog

VersionDescription
5.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.