You are here

mobile_number.api.php in Mobile Number 8

Same filename and directory in other branches
  1. 7 mobile_number.api.php
  2. 2.0.x mobile_number.api.php

File

mobile_number.api.php
View source
<?php

/**
 * @file
 * mobile_number.api.php
 */

/**
 * Alter hook for setting an sms callback for using the verification functionality.
 *
 * Only one sms callback can be defined and it's with this hook.
 *
 * The callback gets the arguments:
 * - string $phone_number (string, international format)
 * - string $message (string)
 *
 * If an sms module has a function with these two needed arguments, then here is
 * where it should be defined, otherwise a wrapper function can be used.
 *
 * @param string $send_sms_callback
 *   Defaults to 'sms_send' if the SMS Framework module  is enabled.
 */
function hook_mobile_number_send_sms_callback_alter(&$send_sms_callback) {
  $send_sms_callback = 'my_sms_callback';
}

Functions

Namesort descending Description
hook_mobile_number_send_sms_callback_alter Alter hook for setting an sms callback for using the verification functionality.