Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Ajax/HtmlCommand.php \Drupal\Core\Ajax\HtmlCommand
- 9 core/lib/Drupal/Core/Ajax/HtmlCommand.php \Drupal\Core\Ajax\HtmlCommand
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 using a given render array or HTML markup.
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
Expanded class hierarchy of HtmlCommand
See also
http://docs.jquery.com/Attributes/html#val
Related topics
10 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 - 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 - ContentModerationConfigureEntityTypesForm.php in core/
modules/ content_moderation/ src/ Form/ ContentModerationConfigureEntityTypesForm.php
File
- core/
lib/ Drupal/ Core/ Ajax/ HtmlCommand.php, line 19
Namespace
Drupal\Core\AjaxView source
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,
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommandWithAttachedAssetsTrait:: |
protected | property | The attached assets for this Ajax command. | |
CommandWithAttachedAssetsTrait:: |
public | function | Gets the attached assets. | |
CommandWithAttachedAssetsTrait:: |
protected | function | Processes the content for output. | |
HtmlCommand:: |
public | function |
Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides InsertCommand:: |
|
InsertCommand:: |
protected | property | The content for the matched element(s). | |
InsertCommand:: |
protected | property | A CSS selector string. | |
InsertCommand:: |
protected | property | A settings array to be passed to any attached JavaScript behavior. | |
InsertCommand:: |
public | function | Constructs an InsertCommand object. |