You are here

function hook_signup_form_data_display_alter in Signup 6.2

Implementation of hook_signup_form_data_display_alter().

Allow modules to alter signup form data prior to displaying signup records in, for example, a node's list of signups at node/N/signups/admin.

This allows modules that implement signup panes for format or even inject their own data.

Parameters

$form_data: The user's signup data to alter.

$nid: The node id for the signup-enabled node.

$sid: The signup record id.

$uid: The user id whose signup this is; 0 if this is an anonymous signup.

$type: The type of output being prepared. Possible values are:

  • 'list': The hardcoded admin lists of signups, eg at node/X/signups/admin
  • 'view': The form data field in Views.
  • 'mail': Email output. This is likely the only one that needs special handling; in this case, modules should be more generous about supplying data since there's no other place to see it.
3 functions implement hook_signup_form_data_display_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

signup_pane_example_signup_form_data_display_alter in modules/signup_pane_example/signup_pane_example.module
Implementation of hook_signup_form_data_display_alter().
signup_profile_signup_form_data_display_alter in modules/signup_profile/signup_profile.module
Implementation of hook_signup_form_data_display_alter().
signup_webform_signup_form_data_display_alter in modules/signup_webform/signup_webform.module
Implementation of hook_signup_form_data_display_alter().
4 invocations of hook_signup_form_data_display_alter()
signup_handler_field_signup_user_form_data::pre_render in views/handlers/signup_handler_field_signup_user_form_data.inc
Set each field value to "$key: $value" when rendering all fields.
signup_node_admin_details_form in includes/node_admin.inc
signup_sign_up_user in ./signup.module
Signs up a user to a node.
_signup_get_username in ./signup.module
Get the name to use for a given signup.

File

./signup.api.php, line 287
This file documents the hooks invoked by the Signup module.

Code

function hook_signup_form_data_display_alter(&$form_data, $nid, $sid, $uid, $type = 'list') {
  foreach ($form_data as $pane_id => $pane_data) {

    // If this is one of your panes, do stuff to it.
  }
}