class ReplaceCommand
Same name in other branches
- 9 core/lib/Drupal/Core/Ajax/ReplaceCommand.php \Drupal\Core\Ajax\ReplaceCommand
- 8.9.x core/lib/Drupal/Core/Ajax/ReplaceCommand.php \Drupal\Core\Ajax\ReplaceCommand
- 10 core/lib/Drupal/Core/Ajax/ReplaceCommand.php \Drupal\Core\Ajax\ReplaceCommand
AJAX command for calling the jQuery replace() method.
The 'insert/replaceWith' command instructs the client to use jQuery's replaceWith() method to replace each element matched by the given selector with the given render array or HTML.
This command is implemented by Drupal.AjaxCommands.prototype.insert() defined in misc/ajax.js.
See jQuery replaceWith command
Hierarchy
- class \Drupal\Core\Ajax\InsertCommand implements \Drupal\Core\Ajax\CommandInterface, \Drupal\Core\Ajax\CommandWithAttachedAssetsInterface uses \Drupal\Core\Ajax\CommandWithAttachedAssetsTrait
- class \Drupal\Core\Ajax\ReplaceCommand extends \Drupal\Core\Ajax\InsertCommand
Expanded class hierarchy of ReplaceCommand
Related topics
12 files declare their use of ReplaceCommand
- AddFormBase.php in core/
modules/ media_library/ src/ Form/ AddFormBase.php - AjaxCommandsTest.php in core/
tests/ Drupal/ Tests/ Core/ Ajax/ AjaxCommandsTest.php - BigPipe.php in core/
modules/ big_pipe/ src/ Render/ BigPipe.php - ckeditor5.module in core/
modules/ ckeditor5/ ckeditor5.module - EntityDisplayFormBase.php in core/
modules/ field_ui/ src/ Form/ EntityDisplayFormBase.php
File
-
core/
lib/ Drupal/ Core/ Ajax/ ReplaceCommand.php, line 20
Namespace
Drupal\Core\AjaxView source
class ReplaceCommand extends InsertCommand {
/**
* Implements Drupal\Core\Ajax\CommandInterface:render().
*/
public function render() {
return [
'command' => 'insert',
'method' => 'replaceWith',
'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. | |
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. | |
ReplaceCommand::render | public | function | Implements Drupal\Core\Ajax\CommandInterface:render(). | Overrides InsertCommand::render |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.