How to use random_password filter in WordPress

random_password filter

Filters the randomly-generated password.

To use the `random_password` 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 WePlugins 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 `weplugins_modify_random_password_defaults` which takes 4 parameters and we registered using `add_filter`. The first parameter `random_password` is the name of the hook, the second parameter `weplugins_modify_random_password_defaults` is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use `remove_filter` to remove the `random_password` filter.

Parameters

Below are the 4 parameters required to use this hook.

• $password: (string) The generated password.
• $length: (int) The length of password to generate.
• $special_chars: (bool) Whether to include standard special characters.
• $extra_special_chars: (bool) Whether to include other special characters.

Live Examples

Generating a Random Password

This example demonstrates how to generate a random password with specific characters and length.

add_filter('random_password', 'weplugins_my_random_password');
function weplugins_my_random_password() {
    $characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
    $length = 10;
    $password = '';
    for ($i = 0; $i < $length; $i++) {
        $password .= substr($characters, wp_rand(0, strlen($characters) - 1), 1);
    }
    return $password;
}
&#91;/php&#93;

<h3>Modifying the Password Defaults</h3>
<p>Below is an example of how you can modify the default generated password according to your website requirements.</p>

function weplugins_modify_random_password_defaults($password, $length, $special_chars, $extra_special_chars) {
    // Update the $password variable according to your website requirements and return this variable. You can modify the $password variable conditionally too if you want.
    return $password;
}
// Add the filter
add_filter("random_password", "weplugins_modify_random_password_defaults", 10, 4);

Removing a Hook Callback

To remove a hook callback, use the example below.

remove_filter("random_password", "weplugins_modify_random_password_defaults", 10, 4);

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

Contact Us

If you need any customization or if you’re having any trouble using this hook, please contact us and we’d be happy to assist you.