class Action in Drupal 10

Defines an Action annotation object.

Plugin Namespace: Plugin\Action

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

\Drupal\Core\Action\Plugin\Action\UnpublishAction

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

11 string references to 'Action'

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

Form constructor.

BulkForm::defineOptions in core/modules/views/src/Plugin/views/field/BulkForm.php

BulkFormTest::testBulkForm in core/modules/views/tests/src/Functional/BulkFormTest.php

Tests the bulk form.

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

Form constructor for the comment overview administration form.

ConfigExportTest::testAjaxOnExportPage in core/modules/config/tests/src/FunctionalJavascript/ConfigExportTest.php

Tests Ajax form functionality on the config export page.

... See full list

23 classes are annotated with Action

ActionAjaxTest in core/modules/action/tests/action_form_ajax_test/src/Plugin/Action/ActionAjaxTest.php

Plugin used for testing AJAX in action config entity forms.

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.

BatchUserAction in core/modules/views/tests/modules/user_batch_action_test/src/Plugin/Action/BatchUserAction.php

Provides action that sets batch precessing.

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

Blocks a user.

... See full list

File

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

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.
   *
   * This property is optional and it does not need to be declared.
   *
   * @todo Provide a more generic way to allow an action to be confirmed first.
   *
   * @var string
   */
  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	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