RedirectCommand.php

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

Namespace

Drupal\Core\Ajax

File

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

View source
<?php

namespace Drupal\Core\Ajax;


/**
 * Defines an AJAX command to set the window.location, loading that URL.
 *
 * @ingroup ajax
 */
class RedirectCommand implements CommandInterface {
    
    /**
     * The URL that will be loaded into window.location.
     *
     * @var string
     */
    protected $url;
    
    /**
     * Constructs an RedirectCommand object.
     *
     * @param string $url
     *   The URL that will be loaded into window.location. This should be a full
     *   URL.
     */
    public function __construct($url) {
        $this->url = $url;
    }
    
    /**
     * Implements \Drupal\Core\Ajax\CommandInterface:render().
     */
    public function render() {
        return [
            'command' => 'redirect',
            'url' => $this->url,
        ];
    }

}

Classes

Title Deprecated Summary
RedirectCommand Defines an AJAX command to set the window.location, loading that URL.

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