get_allowed_block_template_part_areas() – Returns a filtered list of allowed area values for template parts.

You appear to be a bot. Output may be restricted

Description

Returns a filtered list of allowed area values for template parts.

Usage

$array = get_allowed_block_template_part_areas();

Parameters

Returns

array The supported template part area values.

Source

File name: wordpress/wp-includes/block-template-utils.php
Lines:

1 to 40 of 40
function get_allowed_block_template_part_areas() {
  $default_area_definitions = array(
    array(
      'area'        => WP_TEMPLATE_PART_AREA_UNCATEGORIZED,
      'label'       => __( 'General' ),
      'description' => __(
        'General templates often perform a specific role like displaying post content, and are not tied to any particular area.'
      ),
      'icon'        => 'layout',
      'area_tag'    => 'div',
    ),
    array(
      'area'        => WP_TEMPLATE_PART_AREA_HEADER,
      'label'       => __( 'Header' ),
      'description' => __(
        'The Header template defines a page area that typically contains a title, logo, and main navigation.'
      ),
      'icon'        => 'header',
      'area_tag'    => 'header',
    ),
    array(
      'area'        => WP_TEMPLATE_PART_AREA_FOOTER,
      'label'       => __( 'Footer' ),
      'description' => __(
        'The Footer template defines a page area that typically contains site credits, social links, or any other combination of blocks.'
      ),
      'icon'        => 'footer',
      'area_tag'    => 'footer',
    ),
  );

  
/**
 * Filters the list of allowed template part area values.
 *
 * @since 5.9.0
 *
 * @param array $default_area_definitions An array of supported area objects.
 */
  return apply_filters( 'default_wp_template_part_areas', $default_area_definitions );
}
 

 View on GitHub View on Trac