State API

Same name and namespace in other branches
  1. 9 core/core.api.php \state_api
  2. 8.9.x core/core.api.php \state_api
  3. 10 core/core.api.php \state_api

Information about the State API.

The State API is one of several methods in Drupal for storing information. See the Information types topic for an overview of the different types of information.

The basic entry point into the State API is \Drupal::state(), which returns an object of class \Drupal\Core\State\StateInterface. This class has methods for storing and retrieving state information; each piece of state information is associated with a string-valued key. Example:

// Get the state class.
$state = \Drupal::state();
// Find out when cron was last run; the key is 'system.cron_last'.
$time = $state->get('system.cron_last');
// Set the cron run time to the current request time.
$state->set('system.cron_last', \Drupal::time()->getRequestTime());

For more on the State API, see


core/core.api.php, line 172


Title Sort descending File name Summary
StateInterface core/lib/Drupal/Core/State/StateInterface.php Defines the interface for the state system.

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