wp_lostpassword_url

Returns the URL that allows the user to retrieve the lost password.

Description

(string) wp_lostpassword_url( (string) $redirect = '' ); 

Returns (string)

Lost password URL.

Parameters (1)

0. $redirect — Optional. (string) => ''
Path to redirect to on login.

Usage

  1. if ( !function_exists( 'wp_lostpassword_url' ) ) { 
  2.     require_once ABSPATH . WPINC . '/general-template.php'; 
  3. } 
  4.   
  5. // Path to redirect to on login. 
  6. $redirect = ''; 
  7.   
  8. // NOTICE! Understand what this does before running. 
  9. $result = wp_lostpassword_url($redirect); 
  10.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/general-template.php  
  1. function wp_lostpassword_url( $redirect = '' ) { 
  2.     $args = array( 'action' => 'lostpassword' ); 
  3.     if ( !empty($redirect) ) { 
  4.         $args['redirect_to'] = $redirect; 
  5.     } 
  6.  
  7.     $lostpassword_url = add_query_arg( $args, network_site_url('wp-login.php', 'login') ); 
  8.  
  9.     /** 
  10.      * Filters the Lost Password URL. 
  11.      * 
  12.      * @since 2.8.0 
  13.      * 
  14.      * @param string $lostpassword_url The lost password page URL. 
  15.      * @param string $redirect         The path to redirect to on login. 
  16.      */ 
  17.     return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect ); 
  18. }