You are here

function ajax_command_remove in Drupal 7

Creates a Drupal Ajax 'remove' command.

The 'remove' command instructs the client to use jQuery's remove() method to remove each of elements matched by the given selector, and everything within them.

This command is implemented by Drupal.ajax.prototype.commands.remove() 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.

Return value

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

See also

http://docs.jquery.com/Manipulation/remove#expr

Related topics

1 call to ajax_command_remove()
ajax_forms_test_advanced_commands_remove_callback in modules/simpletest/tests/ajax_forms_test.module
Ajax callback for 'remove'.

File

includes/ajax.inc, line 1096
Functions for use with Drupal's Ajax framework.

Code

function ajax_command_remove($selector) {
  return array(
    'command' => 'remove',
    'selector' => $selector,
  );
}