class HtmlCommand
Same name in other branches
- 9 core/lib/Drupal/Core/Ajax/HtmlCommand.php \Drupal\Core\Ajax\HtmlCommand
- 8.9.x core/lib/Drupal/Core/Ajax/HtmlCommand.php \Drupal\Core\Ajax\HtmlCommand
- 11.x 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 \Drupal\Core\Ajax\CommandInterface, \Drupal\Core\Ajax\CommandWithAttachedAssetsInterface uses \Drupal\Core\Ajax\CommandWithAttachedAssetsTrait
- class \Drupal\Core\Ajax\HtmlCommand extends \Drupal\Core\Ajax\InsertCommand
Expanded class hierarchy of HtmlCommand
See also
http://docs.jquery.com/Attributes/html#val
Related topics
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
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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
CommandWithAttachedAssetsTrait::$attachedAssets | protected | property | The attached assets for this Ajax command. | |
CommandWithAttachedAssetsTrait::getAttachedAssets | public | function | Gets the attached assets. | |
CommandWithAttachedAssetsTrait::getRenderedContent | protected | function | Processes the content for output. | |
HtmlCommand::render | public | function | Implements Drupal\Core\Ajax\CommandInterface:render(). | Overrides InsertCommand::render |
InsertCommand::$content | protected | property | The content for the matched element(s). | |
InsertCommand::$selector | protected | property | A CSS selector string. | |
InsertCommand::$settings | protected | property | A settings array to be passed to any attached JavaScript behavior. | |
InsertCommand::__construct | public | function | Constructs an InsertCommand object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.