IpCacheContext.php

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

Namespace

Drupal\Core\Cache\Context

File

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

View source
<?php

namespace Drupal\Core\Cache\Context;

use Drupal\Core\Cache\CacheableMetadata;

/**
 * Defines the IpCacheContext service, for "per IP address" caching.
 *
 * Cache context ID: 'ip'.
 */
class IpCacheContext extends RequestStackCacheContextBase implements CacheContextInterface {
    
    /**
     * {@inheritdoc}
     */
    public static function getLabel() {
        return t('IP address');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContext() {
        return $this->requestStack
            ->getCurrentRequest()
            ->getClientIp();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheableMetadata() {
        return new CacheableMetadata();
    }

}

Classes

Title Deprecated Summary
IpCacheContext Defines the IpCacheContext service, for "per IP address" caching.

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