class Action

Defines an Action annotation object.

Plugin Namespace: Plugin\Action

For a working example, see \Drupal\node\Plugin\Action\UnpublishNode

Hierarchy

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

See also

\Drupal\Core\Action\ActionInterface

\Drupal\Core\Action\ActionManager

\Drupal\Core\Action\ActionBase

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

File

core/lib/Drupal/Core/Annotation/Action.php, line 21

Namespace

Drupal\Core\Annotation

Members

Name	Modifiers	Type	Description
Action::$category	public	property	The category under which the action should be listed in the UI.
Action::$confirm_form_route_name	public	property	The route name for a confirmation form for this action.
Action::$id	public	property	The plugin ID.
Action::$label	public	property	The human-readable name of the action plugin.
Action::$type	public	property	The entity type the action can apply to.
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.