Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function system_message_action

Sends a message to the current user's screen.

Parameters

object $entity: An optional node object, which will be added as $context['node'] if provided.

array $context: Array with the following elements:

  • 'message': The message to send. This will be passed through token_replace().
  • Other elements will be used as the data for token replacement in the message.

Related topics

Actions
Functions that perform an action on a certain system object.
2 string references to 'system_message_action'
TriggerActionTestCase::assignSystemMessageAction in modules/trigger/trigger.test
Assigns a system message action to the passed-in trigger.
TriggerOtherTestCase::testActionsUser in modules/trigger/trigger.test
Tests triggering on user create and user login.

File

modules/system/system.module, line 3351

Code

function system_message_action (&$entity, $context = array()) {
 if (empty($context['node'])) {
 $context['node'] = $entity;
 }
 $context['message'] = token_replace (filter_xss_admin ($context['message']), $context);
 drupal_set_message ($context['message']);
}

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