Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Ajax/ReplaceCommand.php \Drupal\Core\Ajax\ReplaceCommand
- 9 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 CommandInterface, CommandWithAttachedAssetsInterface uses CommandWithAttachedAssetsTrait
- class \Drupal\Core\Ajax\ReplaceCommand
Expanded class hierarchy of ReplaceCommand
Related topics
8 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 - ckeditor5.module in core/
modules/ ckeditor5/ ckeditor5.module - LayoutRebuildTrait.php in core/
modules/ layout_builder/ src/ Controller/ LayoutRebuildTrait.php - ManagedFile.php in core/
modules/ file/ src/ Element/ ManagedFile.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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ReplaceCommand:: |
public | function |
Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides InsertCommand:: |
|
InsertCommand:: |
public | function | Constructs an InsertCommand object. | |
InsertCommand:: |
protected | property | A settings array to be passed to any attached JavaScript behavior. | |
InsertCommand:: |
protected | property | A CSS selector string. | |
InsertCommand:: |
protected | property | The content for the matched element(s). | |
CommandWithAttachedAssetsTrait:: |
protected | function | Processes the content for output. | |
CommandWithAttachedAssetsTrait:: |
public | function | Gets the attached assets. | |
CommandWithAttachedAssetsTrait:: |
protected | property | The attached assets for this Ajax command. |