class Condition in Drupal 10

Defines a condition plugin annotation object.

Condition plugins provide generalized conditions for use in other operations, such as conditional block placement.

Plugin Namespace: Plugin\Condition

For a working example, see \Drupal\user\Plugin\Condition\UserRole.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\Core\Condition\Annotation\Condition

See also

\Drupal\Core\Condition\ConditionManager

\Drupal\Core\Condition\ConditionInterface

\Drupal\Core\Condition\ConditionPluginBase

Block API

Related topics

Annotations

Annotations for class discovery and metadata description.

Plugin API

Using the Plugin API

4 string references to 'Condition'

ConditionAggregate::compile in core/lib/Drupal/Core/Entity/Query/Sql/ConditionAggregate.php

ConnectionTest::providerGetDriverClass in core/tests/Drupal/Tests/Core/Database/ConnectionTest.php

Data provider for testGetDriverClass().

core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml

core/config/schema/core.data_types.schema.yml

QueryBase::conditionGroupFactory in core/lib/Drupal/Core/Entity/Query/QueryBase.php

Creates an object holding a group of conditions.

10 classes are annotated with Condition

BaloneySpam in core/modules/block/tests/modules/block_test/src/Plugin/Condition/BaloneySpam.php

Provides a 'baloney_spam' condition.

ConditionTestDualUser in core/modules/system/tests/modules/condition_test/src/Plugin/Condition/ConditionTestDualUser.php

Provides a condition that requires two users.

ConditionTestNoExistingType in core/modules/system/tests/modules/condition_test/src/Plugin/Condition/ConditionTestNoExistingType.php

Provides a condition that has a no existing context.

CurrentThemeCondition in core/modules/system/src/Plugin/Condition/CurrentThemeCondition.php

Provides a 'Current Theme' condition.

EntityBundle in core/lib/Drupal/Core/Entity/Plugin/Condition/EntityBundle.php

Provides the 'Entity Bundle' condition.

... See full list

File

core/lib/Drupal/Core/Condition/Annotation/Condition.php, line 26

Namespace

Drupal\Core\Condition\Annotation

class Condition extends Plugin {

  /**
   * The condition plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the condition.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The name of the module providing the type.
   *
   * @var string
   */
  public $module;

  /**
   * An array of context definitions describing the context used by the plugin.
   *
   * The array is keyed by context names.
   *
   * @var \Drupal\Core\Annotation\ContextDefinition[]
   */
  public $context_definitions = [];

  /**
   * The category under which the condition should listed in the UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $category;

}

Members

Name	Modifiers	Type	Description	Overrides
Condition::$category	public	property	The category under which the condition should listed in the UI.
Condition::$context_definitions	public	property	An array of context definitions describing the context used by the plugin.
Condition::$id	public	property	The condition plugin ID.
Condition::$label	public	property	The human-readable name of the condition.
Condition::$module	public	property	The name of the module providing the type.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	6
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass	1
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider	1
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass	1
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	3