function ajax_command_html

7.x ajax.inc ajax_command_html($selector, $html, $settings = NULL)

Creates a Drupal Ajax 'insert/html' command.

The 'insert/html' command instructs the client to use jQuery's html() method to set the HTML content of each element matched by the given selector while leaving the outer tags intact.

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 html() 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/Attributes/html#val

Related topics

3 calls to ajax_command_html()
ajax_forms_test_advanced_commands_html_callback in modules/simpletest/tests/ajax_forms_test.module
Ajax callback for 'html'.
ajax_forms_test_simple_form_checkbox_callback in modules/simpletest/tests/ajax_forms_test.module
Ajax callback triggered by checkbox.
ajax_forms_test_simple_form_select_callback in modules/simpletest/tests/ajax_forms_test.module
Ajax callback triggered by select.

File

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

Code

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