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.

Functions & methods

actions_doincludes/actions.incPerforms a given list of actions by executing their callback functions.
comment_publish_actionmodules/comment/comment.modulePublishes a comment.
comment_save_actionmodules/comment/comment.moduleSaves a comment.
comment_unpublish_actionmodules/comment/comment.moduleUnpublishes a comment.
comment_unpublish_by_keyword_actionmodules/comment/comment.moduleUnpublishes a comment if it contains certain keywords.
hook_action_infomodules/system/system.api.phpDeclares information about actions.
node_assign_owner_actionmodules/node/node.moduleAssigns ownership of a node to a user.
node_make_sticky_actionmodules/node/node.moduleSets the sticky-at-top-of-list property of a node to 1.
node_make_unsticky_actionmodules/node/node.moduleSets the sticky-at-top-of-list property of a node to 0.
node_promote_actionmodules/node/node.moduleSets the promote property of a node to 1.
node_publish_actionmodules/node/node.moduleSets the status of a node to 1 (published).
node_save_actionmodules/node/node.moduleSaves a node.
node_unpromote_actionmodules/node/node.moduleSets the promote property of a node to 0.
node_unpublish_actionmodules/node/node.moduleSets the status of a node to 0 (unpublished).
node_unpublish_by_keyword_actionmodules/node/node.moduleUnpublishes a node containing certain keywords.
system_block_ip_actionmodules/system/system.moduleBlocks the current user's IP address.
system_goto_actionmodules/system/system.moduleRedirects to a different URL.
system_message_actionmodules/system/system.moduleSends a message to the current user's screen.
system_send_email_actionmodules/system/system.moduleSends an e-mail message.
user_block_user_actionmodules/user/user.moduleBlocks the current user.


includes/, line 8
This is the actions engine for executing stored actions.