function hook_registration_entity_settings in Entity Registration 8

Same name and namespace in other branches

1. 8.2 registration.api.php \hook_registration_entity_settings()
2. 7.2 registration.api.php \hook_registration_entity_settings()
3. 7 registration.api.php \hook_registration_entity_settings()

Provide a form API element exposed as a Registration entity setting.

Parameters

array $settings: Existing settings values.

Return value

array A FAPI array for a registration setting.

2 functions implement hook_registration_entity_settings()

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

registration_entity_access_registration_entity_settings in modules/registration_entity_access/registration_entity_access.module

Implements hook_registration_entity_settings().

registration_waitlist_registration_entity_settings in modules/registration_waitlist/registration_waitlist.module

Implements hook_registration_entity_settings().

1 invocation of hook_registration_entity_settings()

registration_entity_settings_form in includes/registration.forms.inc

Return a form for an entity's registration settings.

File

./registration.api.php, line 31

API documentation for Relation module.

Code

function hook_registration_entity_settings($settings) {
  return array(
    'registration_entity_access_roles' => array(
      '#type' => 'checkboxes',
      '#title' => t('Roles'),
      '#description' => t('Override default access control settings by selecting which roles can register for this event.'),
      '#options' => user_roles(),
      '#default_value' => isset($settings['settings']['registration_entity_access_roles']) ? $settings['settings']['registration_entity_access_roles'] : NULL,
    ),
  );
}