function OpenModalDialogCommand::__construct

Same name in other branches
  1. 9 core/lib/Drupal/Core/Ajax/OpenModalDialogCommand.php \Drupal\Core\Ajax\OpenModalDialogCommand::__construct()
  2. 10 core/lib/Drupal/Core/Ajax/OpenModalDialogCommand.php \Drupal\Core\Ajax\OpenModalDialogCommand::__construct()
  3. 11.x core/lib/Drupal/Core/Ajax/OpenModalDialogCommand.php \Drupal\Core\Ajax\OpenModalDialogCommand::__construct()

Constructs an OpenModalDialog object.

The modal dialog differs from the normal modal provided by OpenDialogCommand in that a modal prevents other interactions on the page until the modal has been completed. Drupal provides a built-in modal for this purpose, so no selector needs to be provided.

Parameters

string $title: The title of the dialog.

string|array $content: The content that will be placed in the dialog, either a render array or an HTML string.

array $dialog_options: (optional) Settings to be passed to the dialog implementation. Any jQuery UI option can be used. See http://api.jqueryui.com/dialog.

array|null $settings: (optional) Custom settings that will be passed to the Drupal behaviors on the content of the dialog. If left empty, the settings will be populated automatically from the current request.

Overrides OpenDialogCommand::__construct

File

core/lib/Drupal/Core/Ajax/OpenModalDialogCommand.php, line 33

Class

OpenModalDialogCommand
Defines an AJAX command to open certain content in a dialog in a modal dialog.

Namespace

Drupal\Core\Ajax

Code

public function __construct($title, $content, array $dialog_options = [], $settings = NULL) {
    $dialog_options['modal'] = TRUE;
    parent::__construct('#drupal-modal', $title, $content, $dialog_options, $settings);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.