_filter_block_template_part_area() │ WP 5.9.0

Checks whether the input 'area' is a supported value. Returns the input if supported, otherwise returns the 'uncategorized' value.

Internal function — this function is designed to be used by the kernel itself. It is not recommended to use this function in your code.

No Hooks.

Return

String. Input if supported, else the uncategorized value.

Usage

_filter_block_template_part_area( $type );
$type(string) (required)
Template part area name.

Changelog

Since 5.9.0 Introduced.

_filter_block_template_part_area() code WP 6.5.2

wp-includes/block-template-utils.php 
function _filter_block_template_part_area( $type ) {
	$allowed_areas = array_map(
		static function ( $item ) {
			return $item['area'];
		},
		get_allowed_block_template_part_areas()
	);
	if ( in_array( $type, $allowed_areas, true ) ) {
		return $type;
	}

	$warning_message = sprintf(
		/* translators: %1$s: Template area type, %2$s: the uncategorized template area value. */
		__( '"%1$s" is not a supported wp_template_part area value and has been added as "%2$s".' ),
		$type,
		WP_TEMPLATE_PART_AREA_UNCATEGORIZED
	);
	trigger_error( $warning_message, E_USER_NOTICE );
	return WP_TEMPLATE_PART_AREA_UNCATEGORIZED;
}