Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use pre_user_login filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 12, 2022
5 minutes read

pre_user_login filter

This filter is called before the user is created or updated.

To use pre_user_login filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at Flipper Code, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function modify_pre_user_login_defaults which takes 1 parameters and we registered using add_filter. The first parameter pre_user_login is name of the hook, The second parameter modify_pre_user_login_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove pre_user_login filter.

Parameters

    Below the 1 parameter is required to use this hook.

  • $sanitized_user_login : (string) Username after it has been sanitized.

Live Example

/**
 * Check if the user has been created.
 *
 * @param string $login User login.
 * @return string (Maybe) filtered login.
 */
function wpdocs_check_if_user_created( $login ) {
    // Don't do anything to login, just see if already in database.
    global $wpdb, $is_new_login;
  '%s'", $login ) );
 $_POST['first_name'] ) : '';
  $_POST['last_name'] ) : '';

Below is an example how you can use this hook.

                        function modify_pre_user_login_defaults($sanitized_user_login) { 
   
                            // Update the $sanitized_user_login variable according to your website requirements and return this variable. You can modify the $sanitized_user_login variable conditionally too if you want.

                            return $sanitized_user_login; 
                        }
                        // add the filter
                        add_filter( "pre_user_login", "modify_pre_user_login_defaults", 10, 1 );

To remove a hook callback, use the example below.

remove_filter( "pre_user_login", "modify_pre_user_login_defaults", 10, 1 );

Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.

Sandeep Kumar Mishra

Sandeep Kumar Mishra writes about WordPress and Artificial Intelligence, offering tips and guides to help you master your website and stay updated with the latest tech trends.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.