W3cubDocs

/Drupal 8

public function ConfigEntityInterface::status

public ConfigEntityInterface::status()

Returns whether the configuration entity is enabled.

Status implementations for configuration entities should follow these general rules:

  • Status does not affect the loading of entities. I.e. Disabling configuration entities should only have UI/access implications.
  • It should only take effect when a 'status' key is explicitly declared in the entity_keys info of a configuration entity's annotation data.
  • Each entity implementation (entity/controller) is responsible for checking and managing the status.

Return value

bool Whether the entity is enabled or not.

File

core/lib/Drupal/Core/Config/Entity/ConfigEntityInterface.php, line 64

Class

ConfigEntityInterface
Defines a common interface for configuration entities.

Namespace

Drupal\Core\Config\Entity

Code

public function status();

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Config!Entity!ConfigEntityInterface.php/function/ConfigEntityInterface::status/8.1.x