class RemoveCommand

Same name in other branches
  1. 9 core/lib/Drupal/Core/Ajax/RemoveCommand.php \Drupal\Core\Ajax\RemoveCommand
  2. 8.9.x core/lib/Drupal/Core/Ajax/RemoveCommand.php \Drupal\Core\Ajax\RemoveCommand
  3. 10 core/lib/Drupal/Core/Ajax/RemoveCommand.php \Drupal\Core\Ajax\RemoveCommand

AJAX command for calling the jQuery remove() method.

The 'remove' command instructs the client to use jQuery's remove() method to remove each of elements matched by the given selector, and everything within them.

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

Hierarchy

Expanded class hierarchy of RemoveCommand

See also

http://docs.jquery.com/Manipulation/remove#expr

Related topics

Ajax API
Overview for Drupal's Ajax API.
3 files declare their use of RemoveCommand
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
ckeditor5.module in core/modules/ckeditor5/ckeditor5.module

File

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

Namespace

Drupal\Core\Ajax
View source 
class RemoveCommand implements CommandInterface {
    
    /**
     * The CSS selector for the element(s) to be removed.
     *
     * @var string
     */
    protected $selector;
    
    /**
     * Constructs a RemoveCommand object.
     *
     * @param string $selector
     *   The selector.
     */
    public function __construct($selector) {
        $this->selector = $selector;
    }
    
    /**
     * Implements Drupal\Core\Ajax\CommandInterface:render().
     */
    public function render() {
        return [
            'command' => 'remove',
            'selector' => $this->selector,
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title
RemoveCommand::$selector protected property The CSS selector for the element(s) to be removed.
RemoveCommand::render public function Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides CommandInterface::render
RemoveCommand::__construct public function Constructs a RemoveCommand object.

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