interface ActionInterface

Provides an interface for an Action plugin.

@todo WARNING: The action API is going to receive some additions before release. The following additions are likely to happen:

• The way configuration is handled and configuration forms are built is likely to change in order for the plugin to be of use for Rules.
• Actions are going to become context-aware in https://www.drupal.org/node/2011038, what will deprecated the 'type' annotation.
• Instead of action implementations saving entities, support for marking required context as to be saved by the execution manager will be added as part of https://www.drupal.org/node/2347017.
• Actions will receive a data processing API that allows for token replacements to happen outside of the action plugin implementations, see https://www.drupal.org/node/2347023.

Hierarchy

• interface \Drupal\Core\Executable\ExecutableInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\Core\Action\ActionInterface

See also

\Drupal\Core\Annotation\Action

\Drupal\Core\Action\ActionManager

\Drupal\Core\Action\ActionBase

Plugin API

File

core/lib/Drupal/Core/Action/ActionInterface.php, line 31

Namespace

Drupal\Core\Action

Members

Name	Modifiers	Type	Description
ActionInterface::access	public	function	Checks object access.
ActionInterface::executeMultiple	public	function	Executes the plugin for an array of objects.
ExecutableInterface::execute	public	function	Executes the plugin.
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.