class Condition

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

File

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

Namespace

Drupal\Core\Condition\Annotation

Members

Name	Modifiers	Type	Description
Condition::$category	public	property	The category under which the condition should listed in the UI.
Condition::$context	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.
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
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
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
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.