signup_form.inc in Signup 7
Same filename in this branch
Same filename and directory in other branches
Site-specific code related to the form when users signup for a node.
File
theme/signup_form.incView source
<?php
/**
* @file
* Site-specific code related to the form when users signup for a node.
*/
/**
* Return the site-specific custom fields for the signup user form.
*
* To customize this for your site, copy this entire function into
* your theme's template.php file, rename the function to
* THEMENAME_signup_user_form(), and modify to taste. Feel free to
* alter any elements in this section, remove them, or add any others.
*
* WARNING: If your site allows anonymous signups and you alter the
* 'Name' field in this function, you will probably have to implement a
* version of theme_signup_anonymous_username() for your site.
*
* In order for the form to be rendered properly and for the custom
* fields to be fully translatable when printed in other parts of the
* Signup module (displayed in signup lists, emails, etc), the name of
* the form element must be $form['signup_form_data']['NameOfDataField'],
* where NameOfDataField is replaced with the actual name of the data
* field. For translation to work, the displayed name of the field
* (the '#title' property) be the same as the name of the data field,
* but wrapped in t(). See below for examples.
*
* Fieldsets are not currently supported in this form. Any
* '#default_value' will be filled in by default when the form is
* presented to the user. Any field marked '#required' must be filled
* in before the user can sign up.
*
* If you do not want any additional fields, the function can simply
* return an empty array: "return array();"
*
* @param array $variables
* An array of variables including:
* - 'node': The fully loaded node object where this signup form is appearing.
*
* @return array
* Array defining the form to present to the user to signup for a node.
*
* @see theme_signup_anonymous_username()
*/
function theme_signup_user_form($variables) {
$node = $variables['node'];
global $user;
$form = array();
if (variable_get('signup_ignore_default_fields', 0)) {
return $form;
}
// If this function is providing any extra fields at all, the following
// line is required for form form to work -- DO NOT EDIT OR REMOVE.
$form['signup_form_data']['#tree'] = TRUE;
$form['signup_form_data']['Name'] = array(
'#type' => 'textfield',
'#title' => t('Name'),
'#size' => 40,
'#maxlength' => 64,
'#required' => TRUE,
);
$form['signup_form_data']['Phone'] = array(
'#type' => 'textfield',
'#title' => t('Phone'),
'#size' => 40,
'#maxlength' => 64,
);
// If the user is logged in, fill in their name by default.
if ($user->uid) {
$form['signup_form_data']['Name']['#default_value'] = $user->name;
}
return $form;
}
/**
* Returns the value to use for the user name for anonymous signups.
*
* This value is used for the %user_name email token for anonymous users, and
* also to identify a particular anonymous signup in various places in the UI.
*
* @param array $variables
* An array of variables including:
* - 'form_data': Array of custom signup form values for the current signup.
* - 'email': E-mail address of the anonymous user who signed up.
*
* @return string
* A string with the proper value for the %user_name email token.
*
* @see theme_signup_user_form()
*/
function theme_signup_anonymous_username($variables) {
$form_data = $variables['form_data'];
$email = $variables['email'];
// Use the name if possible.
if (isset($form_data['Name']) && !empty($form_data['Name'])) {
return $form_data['Name'];
}
return $email;
}
Functions
Name![]() |
Description |
---|---|
theme_signup_anonymous_username | Returns the value to use for the user name for anonymous signups. |
theme_signup_user_form | Return the site-specific custom fields for the signup user form. |