class Action in Zircon Profile 8

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.

3 string references to 'Action'

ActionAdminManageForm::buildForm in core/modules/action/src/Form/ActionAdminManageForm.php

Form constructor.

CommentAdminOverview::buildForm in core/modules/comment/src/Form/CommentAdminOverview.php

Form constructor for the comment overview administration form.

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

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

24 classes are annotated with Action

AddRoleUser in core/modules/user/src/Plugin/Action/AddRoleUser.php

Adds a role to a user.

AssignOwnerNode in core/modules/node/src/Plugin/Action/AssignOwnerNode.php

Assigns ownership of a node to a user.

BlockUser in core/modules/user/src/Plugin/Action/BlockUser.php

Blocks a user.

CancelUser in core/modules/user/src/Plugin/Action/CancelUser.php

Cancels a user account.

DeleteNode in core/modules/node/src/Plugin/Action/DeleteNode.php

Redirects to a node deletion form.

... See full list

File

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

Contains \Drupal\Core\Annotation\Action.

Namespace

Drupal\Core\Annotation

class Action extends Plugin {

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

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

  /**
   * The route name for a confirmation form for this action.
   *
   * @todo Provide a more generic way to allow an action to be confirmed first.
   *
   * @var string (optional)
   */
  public $confirm_form_route_name = '';

  /**
   * The entity type the action can apply to.
   *
   * @todo Replace with \Drupal\Core\Plugin\Context\Context.
   *
   * @var string
   */
  public $type = '';

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

}

Members

Name	Modifiers	Type	Description	Overrides
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.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	2
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.	1