class ReplaceCommand in Drupal 8

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 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

Related topics

Ajax API

Overview for Drupal's Ajax API.

10 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

LayoutRebuildTrait.php in core/modules/layout_builder/src/Controller/LayoutRebuildTrait.php

ManagedFile.php in core/modules/file/src/Element/ManagedFile.php

... See full list

File

core/lib/Drupal/Core/Ajax/ReplaceCommand.php, line 20

Namespace

Drupal\Core\Ajax

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
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