class Action

Same name in this branch
  1. 8.9.x core/modules/action/src/Plugin/migrate/source/Action.php \Drupal\action\Plugin\migrate\source\Action
  2. 8.9.x core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
Same name in other branches
  1. 9 core/modules/action/src/Plugin/migrate/source/Action.php \Drupal\action\Plugin\migrate\source\Action
  2. 9 core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
  3. 9 core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
  4. 9 core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
  5. 10 core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
  6. 10 core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
  7. 10 core/lib/Drupal/Core/Action/Attribute/Action.php \Drupal\Core\Action\Attribute\Action
  8. 10 core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
  9. 11.x core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
  10. 11.x core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
  11. 11.x core/lib/Drupal/Core/Action/Attribute/Action.php \Drupal\Core\Action\Attribute\Action
  12. 11.x core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action

Defines an Action annotation object.

Plugin Namespace: Plugin\Action

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

Hierarchy

Expanded class hierarchy of 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.
38 string references to 'Action'
action.migrate_drupal.yml in core/modules/action/migrations/state/action.migrate_drupal.yml
core/modules/action/migrations/state/action.migrate_drupal.yml
action.routing.yml in core/modules/action/action.routing.yml
core/modules/action/action.routing.yml
ActionAdminManageForm::buildForm in core/modules/action/src/Form/ActionAdminManageForm.php
Form constructor.
ActionAdminManageForm::submitForm in core/modules/action/src/Form/ActionAdminManageForm.php
Form submission handler.
ActionFormBase::create in core/modules/action/src/Form/ActionFormBase.php
Instantiates a new instance of this class.

... See full list

31 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 21

Namespace

Drupal\Core\Annotation
View source 
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

Title Modifiers Object type Summary Overriden Title 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 5
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 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
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. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.