HtmlCommand.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Ajax/HtmlCommand.php
  2. 8.9.x core/lib/Drupal/Core/Ajax/HtmlCommand.php
  3. 11.x core/lib/Drupal/Core/Ajax/HtmlCommand.php

Namespace

Drupal\Core\Ajax

File

core/lib/Drupal/Core/Ajax/HtmlCommand.php

View source
<?php

namespace Drupal\Core\Ajax;


/**
 * AJAX command for calling the jQuery html() method.
 *
 * The 'insert/html' command instructs the client to use jQuery's html() method
 * to set the HTML content of each element matched by the given selector while
 * leaving the outer tags intact using a given render array or HTML markup.
 *
 * This command is implemented by Drupal.AjaxCommands.prototype.insert()
 * defined in misc/ajax.js.
 *
 * @see http://docs.jquery.com/Attributes/html#val
 *
 * @ingroup ajax
 */
class HtmlCommand extends InsertCommand {
    
    /**
     * Implements Drupal\Core\Ajax\CommandInterface:render().
     */
    public function render() {
        return [
            'command' => 'insert',
            'method' => 'html',
            'selector' => $this->selector,
            'data' => $this->getRenderedContent(),
            'settings' => $this->settings,
        ];
    }

}

Classes

Title Deprecated Summary
HtmlCommand AJAX command for calling the jQuery html() method.

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