Filter wp_sms_sms_otp_length

Updated on Sep 17, 2024

The wp_sms_sms_otp_lengthfilter allows developers to modify the length of the One-Time Passcode (OTP) generated by the createCode function. By default, the OTP length is passed as a parameter to the createCode function, but this filter can be used to dynamically adjust it before the OTP is generated

Filter Hook: wp_sms_sms_otp_length

This filter provides flexibility to modify the length of the OTP according to specific requirements.

Parameters

  • $length (int): The default length of the OTP passed to the createCode function. This value is typically between 2 and 10.

Example Usage

/**
 * Modify the OTP length to 4 digits.
 *
 * @param int $length The original length of the OTP.
 * @return int Modified length of the OTP.
 */
function custom_otp_length($length) {
    // Set the OTP length to 4 digits
    return 4;
}
add_filter('wp_sms_sms_otp_length', 'custom_otp_length');

Notes

  • The $length parameter must be an integer between 2 and 10.
  • If the length is modified to a value outside this range, the createCode function will throw an InvalidArgumentException.

This filter provides a simple way to adjust the OTP length without modifying the core functionality of the plugin.