function hook_ajax_render_alter

You are here

7 system.api.php hook_ajax_render_alter(&$commands)
8 system.api.php hook_ajax_render_alter(array &$data)

Alter the commands that are sent to the user through the Ajax framework.

Parameters

$commands: An array of all commands that will be sent to the user.

See also

ajax_render()

Related topics

1 invocation of hook_ajax_render_alter()
ajax_render in includes/ajax.inc
Renders a commands array into JSON.

File

modules/system/system.api.php, line 878
Hooks provided by Drupal core and the System module.

Code

function hook_ajax_render_alter(&$commands) {
  // Inject any new status messages into the content area.
  $commands[] = ajax_command_prepend('#block-system-main .content', theme('status_messages'));
}

Comments

function mymodule_ajax_render_alter(&$commands) {
  $commands[] = ajax_command_alert('Winning!');
}