8.3.x ConfigEntityInterface.php public ConfigEntityInterface::status()
8.0.x ConfigEntityInterface.php public ConfigEntityInterface::status()
8.1.x ConfigEntityInterface.php public ConfigEntityInterface::status()
8.2.x ConfigEntityInterface.php public ConfigEntityInterface::status()
8.4.x ConfigEntityInterface.php 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.

2 methods override ConfigEntityInterface::status()
ConfigEntityBase::status in core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php
Returns whether the configuration entity is enabled.
ViewUI::status in core/modules/views_ui/src/ViewUI.php
Returns whether the configuration entity is enabled.

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();