AjaxHelperTrait.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php
  2. 8.9.x core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php
  3. 10 core/lib/Drupal/Core/Ajax/AjaxHelperTrait.php

Namespace

Drupal\Core\Ajax

File

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

View source
<?php

namespace Drupal\Core\Ajax;

use Drupal\Core\EventSubscriber\MainContentViewSubscriber;

/**
 * Provides a helper to determine if the current request is via AJAX.
 *
 * @internal
 */
trait AjaxHelperTrait {
  
  /**
   * Determines if the current request is via AJAX.
   *
   * @return bool
   *   TRUE if the current request is via AJAX, FALSE otherwise.
   */
  protected function isAjax() {
    $wrapper_format = $this->getRequestWrapperFormat() ?? '';
    return str_contains($wrapper_format, 'drupal_ajax') || str_contains($wrapper_format, 'drupal_modal') || str_contains($wrapper_format, 'drupal_dialog');
  }
  
  /**
   * Gets the wrapper format of the current request.
   *
   * @return string|null
   *   The wrapper format. NULL if the wrapper format is not set.
   */
  protected function getRequestWrapperFormat() {
    return \Drupal::request()->get(MainContentViewSubscriber::WRAPPER_FORMAT);
  }

}

Traits

Title Deprecated Summary
AjaxHelperTrait Provides a helper to determine if the current request is via AJAX.

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