mailing_list module - hooks created by the mailing_list module
- These hooks allow modules to override and extend the default mailing list.
hook_mailing_list_service_list
Parameters:
None
Returns:
array(
'module_name' => 'Human Readable Name'
)
)
Description:
Return the machine and human readable names of a module that implements
mailing_list hooks
hook_mailing_list_manage_fields
Parameters:
None
Returns:
array() per forms API
Description:
Return form elements for administering this node from manage/mailing_list
hook_mailing_list_manage_validate
Parameters:
$form - array (per forms API)
&$form_state - array (per forms API)
Returns:
none
Description:
Validate the form from manage/mailing_list
hook_mailing_list_manage_submit
Parameters:
$form - array (per forms API)
&$form_state - array (per forms API)
Returns:
none
Description:
Submit the form from manage/mailing_list
hook_mailing_list_join
Parameters:
none
Returns:
none (default and most common case)
array() per forms API
Description:
Return form elements to build mailing list signup on mailing_list
hook_mailing_list_join_validate
Parameters:
$form - array (per forms API)
&$form_state - array (per forms API)
Returns:
none
Description:
Validate the form from mailing_list
hook_mailing_list_join_submit
Parameters:
$form - array (per forms API)
&$form_state - array (per forms API)
Returns:
none
Description:
Submit the form from mailing_list
hook_mailing_list_get_link
Parameters:
none
Returns:
array(
'#text' => 'Human readable text',
'#destination' => 'link/path'
'#query' => array(elements passed directly to l() ),
)
OR TRUE|FALSE
Description:
Link settings to generate mailing_list link for public display. Returning TRUE tells the system to use the default link. Returning FALSE displays nothing.
hook_mailing_list_subscribe
Parameters:
$fields - array - containing - at minimum - a field with the key "email"
$list - string - ID of the mailing list
Returns:
TRUE|FALSE - was the process completed sucessfully?
Description:
Prompt the currently-selected mailing_list_service to create a subscription using the provided details
hook_mailing_list_unsubscribe
Parameters:
$fields - array - containing - at minimum - a field with the key "email"
$list - string - ID of the mailing list
Returns:
TRUE|FALSE - was the process completed sucessfully?
Description:
Prompt the currently-selected mailing_list_service to cancel a subscription using the provided details