Filter: um_custom_{$message_key}

apply_filters( 'um_custom_{$message_key}', $message, $role, $role_data, $args ) → {string}

Filters pending or checkmail status messages after registration. Note: The message can have user placeholders. Please make sure that you use them in the proper context. Allowed placeholders by default: '{first_name}', '{last_name}', '{display_name}', '{user_avatar_small}', '{username}', '{nickname}', '{user_email}'.

Parameters:
Name Type Description
$message string

After registration message based on the user status.
$role string

User role.
$role_data array

User role data.
$args array

Registration form data arguments.
Since:
  • 2.11.3
Source:
Returns:

After registration message based on the user status.

Type
string
Examples

Change the registration message if the user has status `Waiting for admin review`.

function um_custom_pending_message( $message, $role, $role_data, $args ) {
    $message = 'Your custom message is here';
    return $message;
}
add_filter( 'um_custom_pending_message', 'um_custom_pending_message', 10, 4 );

Change the registration message if the user has status `Waiting for email activation`.

function um_custom_checkmail_message( $message, $role, $role_data, $args ) {
     $message = 'Your custom message is here';
     return $message;
}
add_filter( 'um_custom_checkmail_message', 'um_custom_checkmail_message', 10, 4 );