IsSuperUserCacheContext.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Cache/Context/IsSuperUserCacheContext.php
  2. 10 core/lib/Drupal/Core/Cache/Context/IsSuperUserCacheContext.php
  3. 11.x core/lib/Drupal/Core/Cache/Context/IsSuperUserCacheContext.php

Namespace

Drupal\Core\Cache\Context

File

core/lib/Drupal/Core/Cache/Context/IsSuperUserCacheContext.php

View source
<?php

namespace Drupal\Core\Cache\Context;

use Drupal\Core\Cache\CacheableMetadata;

/**
 * Defines the IsSuperUserCacheContext service, for "super user or not" caching.
 *
 * Cache context ID: 'user.is_super_user'.
 */
class IsSuperUserCacheContext extends UserCacheContextBase implements CacheContextInterface {
    
    /**
     * {@inheritdoc}
     */
    public static function getLabel() {
        return t('Is super user');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContext() {
        return (int) $this->user
            ->id() === 1 ? '1' : '0';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheableMetadata() {
        return new CacheableMetadata();
    }

}

Classes

Title Deprecated Summary
IsSuperUserCacheContext Defines the IsSuperUserCacheContext service, for "super user or not" caching.

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