You are here

function hook_social_event_managers_action_ACTION_ID_finish in Open Social 8.6

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php \hook_social_event_managers_action_ACTION_ID_finish()
  2. 8.5 modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php \hook_social_event_managers_action_ACTION_ID_finish()
  3. 8.7 modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php \hook_social_event_managers_action_ACTION_ID_finish()
  4. 8.8 modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php \hook_social_event_managers_action_ACTION_ID_finish()
  5. 10.3.x modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php \hook_social_event_managers_action_ACTION_ID_finish()
  6. 10.0.x modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php \hook_social_event_managers_action_ACTION_ID_finish()
  7. 10.1.x modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php \hook_social_event_managers_action_ACTION_ID_finish()
  8. 10.2.x modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php \hook_social_event_managers_action_ACTION_ID_finish()

Provide a method to show some message when action is completed.

Parameters

bool $success: Was the process successfull?

Return value

array An associative array which contains two single-line text values for a situation when action finish with one result ("single" array key) and many results ("plural" array key).

5 functions implement hook_social_event_managers_action_ACTION_ID_finish()

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

social_event_an_enroll_enrolments_export_social_event_managers_action_social_event_an_enroll_enrolments_export_action_finish in modules/social_features/social_event/modules/social_event_an_enroll_enrolments_export/social_event_an_enroll_enrolments_export.module
Implements hook_social_event_managers_action_ACTION_ID_finish().
social_event_an_enroll_social_event_managers_action_social_event_an_enroll_send_email_action_finish in modules/social_features/social_event/modules/social_event_an_enroll/social_event_an_enroll.module
Implements hook_social_event_action_ACTION_ID_finish().
social_event_enrolments_export_social_event_managers_action_social_event_enrolments_export_enrollments_action_finish in modules/social_features/social_event/modules/social_event_enrolments_export/social_event_enrolments_export.module
Implements hook_social_event_action_ACTION_ID_finish().
social_event_managers_social_event_managers_action_social_event_managers_delete_event_enrollment_action_finish in modules/social_features/social_event/modules/social_event_managers/social_event_managers.module
Implements hook_social_event_action_ACTION_ID_finish().
social_event_managers_social_event_managers_action_social_event_managers_send_email_action_finish in modules/social_features/social_event/modules/social_event_managers/social_event_managers.module
Implements hook_social_event_action_ACTION_ID_finish().

File

modules/social_features/social_event/modules/social_event_managers/social_event_managers.api.php, line 26
Hooks provided by the Social Event Organisers module.

Code

function hook_social_event_managers_action_ACTION_ID_finish($success) {
  if ($success) {
    return [
      'singular' => 'Your email has been sent to 1 selected enrollee successfully',
      'plural' => 'Your email has been sent to @count selected enrollees successfully',
    ];
  }
  return [
    'singular' => 'Your email has not been sent to 1 selected enrollee successfully',
    'plural' => 'Your email has not been sent to @count selected enrollees successfully',
  ];
}