class HtmlCommand in Drupal 10

AJAX command for calling the jQuery html() method.

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.AjaxCommands.prototype.insert() defined in misc/ajax.js.

Hierarchy

• class \Drupal\Core\Ajax\InsertCommand implements CommandInterface, CommandWithAttachedAssetsInterface uses CommandWithAttachedAssetsTrait
  • class \Drupal\Core\Ajax\HtmlCommand

See also

http://docs.jquery.com/Attributes/html#val

Related topics

Ajax API

Overview for Drupal's Ajax API.

11 files declare their use of HtmlCommand

AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php

AjaxTestController.php in core/modules/system/tests/modules/ajax_test/src/Controller/AjaxTestController.php

AjaxTestImageEffect.php in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php

ajax_forms_test.module in core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.module

Mock module for Ajax forms testing.

Callbacks.php in core/modules/system/tests/modules/ajax_forms_test/src/Callbacks.php

... See full list

File

core/lib/Drupal/Core/Ajax/HtmlCommand.php, line 19

Namespace

Drupal\Core\Ajax

class HtmlCommand extends InsertCommand {

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return [
      'command' => 'insert',
      'method' => 'html',
      'selector' => $this->selector,
      'data' => $this
        ->getRenderedContent(),
      'settings' => $this->settings,
    ];
  }

}