You are here

function ajax_command_before in Drupal 7

Creates a Drupal Ajax 'insert/before' command.

The 'insert/before' command instructs the client to use jQuery's before() method to insert the given HTML content before each of elements matched by the given selector.

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

$html: The data to use with the jQuery before() method.

$settings: An optional array of settings that will be used for this command only.

Return value

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

See also

http://docs.jquery.com/Manipulation/before#content

Related topics

1 call to ajax_command_before()
ajax_forms_test_advanced_commands_before_callback in modules/simpletest/tests/ajax_forms_test.module
Ajax callback for 'before'.

File

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

Code

function ajax_command_before($selector, $html, $settings = NULL) {
  return array(
    'command' => 'insert',
    'method' => 'before',
    'selector' => $selector,
    'data' => $html,
    'settings' => $settings,
  );
}