You are here

Home » API reference » Drupal 10 » Layout.php » Layout

public property Layout::$description in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Layout/Annotation/Layout.php \Drupal\Core\Layout\Annotation\Layout::description
  2. 9 core/lib/Drupal/Core/Layout/Annotation/Layout.php \Drupal\Core\Layout\Annotation\Layout::description

A description for advanced layouts.

This property is optional and it does not need to be declared.

Sometimes layouts are so complex that the name is insufficient to describe a layout such that a visually impaired administrator could layout a page for a non-visually impaired audience. If specified, it will provide a description that is used for accessibility purposes.

Type: string

Related topics

Annotation for translatable text
Describes how to put translatable UI text into annotations.

File

core/lib/Drupal/Core/Layout/Annotation/Layout.php, line 56

Class

Layout
Defines a Layout annotation object.

Namespace

Drupal\Core\Layout\Annotation

Code

public $description;