Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/Ajax/OpenModalDialogCommand.php
  2. 8.9.x core/lib/Drupal/Core/Ajax/OpenModalDialogCommand.php
  3. 10 core/lib/Drupal/Core/Ajax/OpenModalDialogCommand.php





View source

namespace Drupal\Core\Ajax;

 * Defines an AJAX command to open certain content in a dialog in a modal dialog.
 * @ingroup 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|\Stringable|null $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
     * @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(string|\Stringable|null $title, $content, array $dialog_options = [], $settings = NULL) {
        $dialog_options['modal'] = TRUE;
        parent::__construct('#drupal-modal', $title, $content, $dialog_options, $settings);



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

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