wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_generate_password › WordPress Function

Since2.5.0
Deprecatedn/a
wp_generate_password ( $length = 12, $special_chars = true, $extra_special_chars = false )
Parameters: (3)
  • (int) $length Optional. The length of password to generate. Default 12.
    Required: No
    Default: 12
  • (bool) $special_chars Optional. Whether to include standard special characters. Default true.
    Required: No
    Default: true
  • (bool) $extra_special_chars Optional. Whether to include other special characters. Used when generating secret keys and salts. Default false.
    Required: No
    Default: false
Returns:
  • (string) The random password.
Defined at:
Codex:

Generates a random password drawn from the defined set of characters.

Uses wp_rand() to create passwords with far less predictability than similar native PHP functions like rand() or mt_rand().


Source

function wp_generate_password( $length = 12, $special_chars = true, $extra_special_chars = false ) {
		$chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
		if ( $special_chars ) {
			$chars .= '!@#$%^&*()';
		}
		if ( $extra_special_chars ) {
			$chars .= '-_ []{}<>~`+=,.;:/?|';
		}

		$password = '';
		for ( $i = 0; $i < $length; $i++ ) {
			$password .= substr( $chars, wp_rand( 0, strlen( $chars ) - 1 ), 1 );
		}

		/**
		 * Filters the randomly-generated password.
		 *
		 * @since 3.0.0
		 * @since 5.3.0 Added the `$length`, `$special_chars`, and `$extra_special_chars` parameters.
		 *
		 * @param string $password            The generated password.
		 * @param int    $length              The length of password to generate.
		 * @param bool   $special_chars       Whether to include standard special characters.
		 * @param bool   $extra_special_chars Whether to include other special characters.
		 */
		return apply_filters( 'random_password', $password, $length, $special_chars, $extra_special_chars );
	}
endif;

if ( ! function_exists( 'wp_rand' ) ) :
	/**
	 * Generates a random non-negative number.
	 *
	 * @since 2.6.2
	 * @since 4.4.0 Uses PHP7 random_int() or the random_compat library if available.
	 * @since 6.1.0 Returns zero instead of a random number if both `$min` and `$max` are zero.
	 *
	 * @global string $rnd_value
	 *
	 * @param int $min Optional. Lower limit for the generated number.
	 *                 Accepts positive integers or zero. Defaults to 0.
	 * @param int $max Optional. Upper limit for the generated number.
	 *                 Accepts positive integers. Defaults to 4294967295.
	 * @return int A random non-negative number between min and max.
	 */