class AppendCommand in Drupal 9

An AJAX command for calling the jQuery append() method.

The 'insert/append' command instructs the client to use jQuery's append() method to append the given HTML content to the inside of each element matched by the given selector.

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

Hierarchy

• class \Drupal\Core\Ajax\InsertCommand implements CommandInterface, CommandWithAttachedAssetsInterface uses CommandWithAttachedAssetsTrait
  • class \Drupal\Core\Ajax\AppendCommand

See also

http://docs.jquery.com/Manipulation/append#content

Related topics

Ajax API

Overview for Drupal's Ajax API.

3 files declare their use of AppendCommand

AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php

ajax_forms_test.module in core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.module

Simpletest mock module for Ajax forms testing.

FrameworkTest.php in core/modules/system/tests/src/Functional/Ajax/FrameworkTest.php

File

core/lib/Drupal/Core/Ajax/AppendCommand.php, line 19

Namespace

Drupal\Core\Ajax

class AppendCommand extends InsertCommand {

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return [
      'command' => 'insert',
      'method' => 'append',
      'selector' => $this->selector,
      'data' => $this
        ->getRenderedContent(),
      'settings' => $this->settings,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AppendCommand::render	public	function	Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides InsertCommand::render
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.