class OpenModalDialogCommand in Drupal 10

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

Hierarchy

• class \Drupal\Core\Ajax\OpenModalDialogCommand extends \Drupal\Core\Ajax\OpenDialogCommand

Related topics

Ajax API

Overview for Drupal's Ajax API.

3 files declare their use of OpenModalDialogCommand

MediaLibraryWidget.php in core/modules/media_library/src/Plugin/Field/FieldWidget/MediaLibraryWidget.php

ModalRenderer.php in core/lib/Drupal/Core/Render/MainContent/ModalRenderer.php

ViewsFormBase.php in core/modules/views_ui/src/Form/Ajax/ViewsFormBase.php

File

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

Namespace

Drupal\Core\Ajax

class OpenModalDialogCommand extends OpenDialogCommand {

  /**
   * 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.
   *
   * @param string $title
   *   The title of the dialog.
   * @param string|array $content
   *   The content that will be placed in the dialog, either a render array
   *   or an HTML string.
   * @param 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.
   * @param 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.
   */
  public function __construct($title, $content, array $dialog_options = [], $settings = NULL) {
    $dialog_options['modal'] = TRUE;
    parent::__construct('#drupal-modal', $title, $content, $dialog_options, $settings);
  }

}