TextFormat

Provides a text format render element.

Properties:

• #base_type: The form element #type to use for the 'value' element. 'textarea' by default.
• #format: (optional) The text format ID to preselect. If omitted, the default format for the current user will be used.
• #allowed_formats: (optional) An array of text format IDs that are available for this element. If omitted, all text formats that the current user has access to will be allowed.

Usage Example:

$form['body'] = array(
  '#type' => 'text_format',
  '#title' => 'Body',
  '#format' => 'full_html',
  '#default_value' => '<p>The quick brown fox jumped over the lazy dog.</p>',
);

Plugin annotation

@RenderElement("text_format")

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\filter\Element\TextFormat

See also

\Drupal\Core\Render\Element\Textarea

File

core/modules/filter/src/Element/TextFormat.php, line 36

Namespace

Drupal\filter\Element

Members