class ReplaceCommand

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Ajax/ReplaceCommand.php \Drupal\Core\Ajax\ReplaceCommand
  2. 9 core/lib/Drupal/Core/Ajax/ReplaceCommand.php \Drupal\Core\Ajax\ReplaceCommand
  3. 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 HTML.

This command is implemented by Drupal.AjaxCommands.prototype.insert() defined in misc/ajax.js.

See jQuery replaceWith command

Hierarchy

Expanded class hierarchy of ReplaceCommand

Related topics

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
View 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,
    ];
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.