function ajax_command_insert

Creates a Backdrop Ajax 'insert' command using the method in #ajax['method'].

This command instructs the client to insert the given HTML using whichever jQuery DOM manipulation method has been specified in the #ajax['method'] variable of the element that triggered the request.

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

Parameters

string $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.

string $html: The data to use with the jQuery method.

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

Return value

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

Related topics

File

core/includes/ajax.inc, line 930

Functions for use with Backdrop's Ajax framework.

Code

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