Ultimate Member plugin has some useful field validations for your Register & Profile forms. Since not everything has been included in the list of built-in field validations, Ultimate Member provides a callback function option to extend the functionality for your custom validation.
When you edit a field settings, you will be able to add custom validation using your function. Here’s an example function that validates a PH based mobiler number:
/**
* Mobile number validation
*/
add_action("um_custom_field_validation_validate_philippines_mobile_number","validate_philippines_mobile_number", 10, 3);
function validate_philippines_mobile_number $key, $array, $args ){
if( empty( $args[ $key ] ) ){
return;
}
if( ! preg_match('#^(09|639)\d{9}$#', $args[ $key ] ) ){
UM()->form()->add_error( $key, __('Please enter a valid SMART/Globe/Sun mobile number','ultimate-member') );
}else{ // Valid mobile number
$has_users = get_users('meta_value='.$args[ $key ].'&meta_key=ph_mobile_number' );
foreach ( $has_users as $user) {
UM()->form()->add_error( $key, __('This mobile number is already in use and cannot be transferred to another account.','ultimate-member') );
return;
}
$has_users = get_users('meta_value='.substr_replace( $args[ $key ], "639", 0, 2 ).'&meta_key=ph_mobile_number' );
foreach ( $has_users as $user) {
UM()->form()->add_error( $key, __('This mobile number is already in use and cannot be transferred to another account.','ultimate-member') );
return;
}
$has_users = get_users('meta_value='.substr_replace( $args[ $key ], "09", 0, 3 ).'&meta_key=ph_mobile_number' );
foreach ( $has_users as $user) {
UM()->form()->add_error( $key, __('This mobile number is already in use and cannot be transferred to another account.','ultimate-member') );
return;
}
}
}
Let’s breakdown the code..
Ultimate Member has an action hook that attaches your custom function to validate strings or integer values: um_custom_field_validation_{your_custom_action_function_name}
$key – returns field name e.g. ph_mobile_number
$array – returns field settings
$args – returns field value e.g. $mobile_number = $args[ $key ];
add_action("um_custom_field_validation_validate_philippines_mobile_number","validate_philippines_mobile_number", 10, 3);
function validate_philippines_mobile_number $key, $array, $args ){
// do something
}
If the field value is empty, don’t validate.
if( empty( $args[ $key ] ) ){
return;
}
All mobile numbers in PH start with 639 or 09 followed by 9-digit number to complete the format of 11 or 12-digit.
So when the user input doesn’t follow the pattern, it will return an invalid error notice:
if( ! preg_match('#^(09|639)\d{9}$#', $args[ $key ] ) ){
UM()->form()->add_error( $key, __('Please enter a valid SMART/Globe/Sun mobile number','ultimate-member') );
}
But if the user input has passed the mobile number validation, the registration or profile update will proceed to the next validation. If you need to check whether the mobile number has been added or being used by other user, you can do that by using the following code:
$has_users = get_users('meta_value='.$args[ $key ].'&meta_key=ph_mobile_number' );
foreach ( $has_users as $user) {
UM()->form()->add_error( $key, __('This mobile number is already in use and cannot be transferred to another account.','ultimate-member') );
return;
}
$has_users = get_users('meta_value='.substr_replace( $args[ $key ], "639", 0, 2 ).'&meta_key=ph_mobile_number' );
foreach ( $has_users as $user) {
UM()->form()->add_error( $key, __('This mobile number is already in use and cannot be transferred to another account.','ultimate-member') );
return;
}
$has_users = get_users('meta_value='.substr_replace( $args[ $key ], "09", 0, 3 ).'&meta_key=ph_mobile_number' );
foreach ( $has_users as $user) {
UM()->form()->add_error( $key, __('This mobile number is already in use and cannot be transferred to another account.','ultimate-member') );
return;
}
There are 3 validations for the field key ph_mobile_number. When one of the validations matches the user input in the usermeta table, it will return the error to the form. If you notice the 3 lookups, user may input a mobile number that starts with 09 or 639 – so this condition makes the validation consistent in finding exact mobile numbers.
I hope this can help you with adding a custom the field validation in Ultimate Member forms!
