Actions
Actions
Functions that perform an action on a certain system object.
Action functions are declared by modules by implementing hook_action_info(). Modules can cause action functions to run by calling actions_do(), and trigger.module provides a user interface that lets administrators define events that cause action functions to run.
Each action function takes two to four arguments:
- $entity: The object that the action acts on, such as a node, comment, or user.
- $context: Array of additional information about what triggered the action.
- $a1, $a2: Optional additional information, which can be passed into actions_do() and will be passed along to the action function.
File
- includes/actions.inc, line 8
- This is the actions engine for executing stored actions.
Functions
Name | Location | Description |
---|---|---|
actions_do | includes/actions.inc | Performs a given list of actions by executing their callback functions. |
comment_publish_action | modules/comment/comment.module | Publishes a comment. |
comment_save_action | modules/comment/comment.module | Saves a comment. |
comment_unpublish_action | modules/comment/comment.module | Unpublishes a comment. |
comment_unpublish_by_keyword_action | modules/comment/comment.module | Unpublishes a comment if it contains certain keywords. |
hook_action_info | modules/system/system.api.php | Declares information about actions. |
node_assign_owner_action | modules/node/node.module | Assigns ownership of a node to a user. |
node_make_sticky_action | modules/node/node.module | Sets the sticky-at-top-of-list property of a node to 1. |
node_make_unsticky_action | modules/node/node.module | Sets the sticky-at-top-of-list property of a node to 0. |
node_promote_action | modules/node/node.module | Sets the promote property of a node to 1. |
node_publish_action | modules/node/node.module | Sets the status of a node to 1 (published). |
node_save_action | modules/node/node.module | Saves a node. |
node_unpromote_action | modules/node/node.module | Sets the promote property of a node to 0. |
node_unpublish_action | modules/node/node.module | Sets the status of a node to 0 (unpublished). |
node_unpublish_by_keyword_action | modules/node/node.module | Unpublishes a node containing certain keywords. |
system_block_ip_action | modules/system/system.module | Blocks the current user's IP address. |
system_goto_action | modules/system/system.module | Redirects to a different URL. |
system_message_action | modules/system/system.module | Sends a message to the current user's screen. |
system_send_email_action | modules/system/system.module | Sends an e-mail message. |
user_block_user_action | modules/user/user.module | Blocks a specific user or the current user, if one is not specified. |
© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!actions.inc/group/actions/7.x