function ajax_command_close_dialog

1.20.x ajax.inc ajax_command_close_dialog($selector)

Provides an AJAX command to close an open dialog.

This command is implemented by Backdrop.ajax.prototype.commands.closeDialog() defined in misc/dialog.ajax.js.

Parameters

$selector: A jQuery selector string for the dialog to be closed.

Return value

array: An array suitable for use with the ajax_render() function.

Related topics

Ajax framework commands Functions to create various Ajax commands.

3 calls to ajax_command_close_dialog()

ajax_command_close_modal_dialog in includes/ajax.inc: Provides a shortcut command for closing a modal dialog.
ajax_test_dialog_close in modules/simpletest/tests/ajax_test.module: Menu callback: Close the ajax dialog.
filter_format_editor_dialog_save in modules/filter/filter.pages.inc: Form AJAX callback. Sends the save editor AJAX command and closes the dialog.

File

includes/ajax.inc, line 1402: Functions for use with Backdrop's Ajax framework.

Code

function ajax_command_close_dialog($selector) {
  return array(
    'command' => 'closeDialog',
    'selector' => $selector,
  );
}