class Action
Same name in this branch
- 9 core/modules/action/src/Plugin/migrate/source/Action.php \Drupal\action\Plugin\migrate\source\Action
- 9 core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
- 9 core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
Same name in other branches
- 8.9.x core/modules/action/src/Plugin/migrate/source/Action.php \Drupal\action\Plugin\migrate\source\Action
- 8.9.x core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
- 8.9.x core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
- 10 core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
- 10 core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
- 10 core/lib/Drupal/Core/Action/Attribute/Action.php \Drupal\Core\Action\Attribute\Action
- 10 core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
- 11.x core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
- 11.x core/modules/system/src/Plugin/migrate/source/Action.php \Drupal\system\Plugin\migrate\source\Action
- 11.x core/lib/Drupal/Core/Action/Attribute/Action.php \Drupal\Core\Action\Attribute\Action
- 11.x core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
Defines an Action annotation object.
Plugin Namespace: Plugin\Action
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\Core\Annotation\Action extends \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of Action
See also
\Drupal\Core\Action\ActionInterface
\Drupal\Core\Action\ActionManager
\Drupal\Core\Action\ActionBase
\Drupal\Core\Action\Plugin\Action\UnpublishAction
Related topics
33 string references to 'Action'
- 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.
- ActionListTest::testEmptyActionList in core/
modules/ action/ tests/ src/ Functional/ ActionListTest.php - Tests the behavior when there are no actions to list in the admin page.
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.
File
-
core/
lib/ Drupal/ Core/ Annotation/ Action.php, line 20
Namespace
Drupal\Core\AnnotationView 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.
*
* 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
Title Sort descending | 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 | 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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.