social_event.api.php in Open Social 10.1.x

Hooks provided by the Social Event module.

File

modules/social_features/social_event/social_event.api.php

<?php

/**
 * @file
 * Hooks provided by the Social Event module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Provide a description for a given key from the enroll method #options.
 *
 * @param string $description
 *   The descriptive.
 *
 * @ingroup social_event_api
 */
function hook_social_event_enroll_method_description_alter($key, &$description) {
  switch ($key) {
    case 'join_method_extra':
      $description = '<strong>' . t('QR Code')
        ->render() . '</strong>';
      $description .= '-' . t('All users can join by scanning a QR code')
        ->render();
      $description .= '</p>';
      break;
    case 'single_sign_on':
      $description = '<strong>' . t('Single Sign on')
        ->render() . '</strong>';
      $description .= '-' . t('All users can join by SSO')
        ->render();
      $description .= '</p>';
      break;
  }
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Name	Description
hook_social_event_enroll_method_description_alter	Provide a description for a given key from the enroll method #options.