class PrependCommand

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

AJAX command for calling the jQuery insert() method.

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

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

Hierarchy

Expanded class hierarchy of PrependCommand

See also

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

Related topics

6 files declare their use of PrependCommand
AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php
AjaxRenderer.php in core/lib/Drupal/Core/Render/MainContent/AjaxRenderer.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
FormAjaxSubscriber.php in core/lib/Drupal/Core/Form/EventSubscriber/FormAjaxSubscriber.php

... See full list

File

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

Namespace

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

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
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.
PrependCommand::render public function Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides InsertCommand::render

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