function ajax_command_invoke in Drupal 7

Creates a Drupal Ajax 'invoke' command.

The 'invoke' command will instruct the client to invoke the given jQuery method with the supplied arguments on the elements matched by the given selector. Intended for simple jQuery commands, such as attr(), addClass(), removeClass(), toggleClass(), etc.

This command is implemented by Drupal.ajax.prototype.commands.invoke() defined in misc/ajax.js.

Parameters

$selector: A jQuery selector string. If the command is a response to a request from an #ajax form element then this value can be NULL.

$method: The jQuery method to invoke.

$arguments: (optional) A list of arguments to the jQuery $method, if any.

Return value

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

Related topics

1 call to ajax_command_invoke()

ajax_forms_test_advanced_commands_invoke_callback in modules/simpletest/tests/ajax_forms_test.module

Ajax callback for 'invoke'.

File

includes/ajax.inc, line 1243

Functions for use with Drupal's Ajax framework.

Code

function ajax_command_invoke($selector, $method, array $arguments = array()) {
  return array(
    'command' => 'invoke',
    'selector' => $selector,
    'method' => $method,
    'arguments' => $arguments,
  );
}