diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php index 3859806087..419c59dabb 100644 --- a/wp-includes/general-template.php +++ b/wp-includes/general-template.php @@ -147,6 +147,7 @@ function get_template_part( $slug, $name = null ) { * * @since 2.7.0 * @param boolean $echo Default to echo and not return the form. + * @return string|null String when retrieving, null when displaying or if searchform.php exists. */ function get_search_form($echo = true) { do_action( 'get_search_form' ); @@ -181,6 +182,7 @@ function get_search_form($echo = true) { * * @param string $redirect Optional path to redirect to on login/logout. * @param boolean $echo Default to echo and not return the link. + * @return string|null String when retrieving, null when displaying. */ function wp_loginout($redirect = '', $echo = true) { if ( ! is_user_logged_in() ) @@ -205,6 +207,7 @@ function wp_loginout($redirect = '', $echo = true) { * @uses apply_filters() calls 'logout_url' hook on final logout url * * @param string $redirect Path to redirect to on logout. + * @return string A log out URL. */ function wp_logout_url($redirect = '') { $args = array( 'action' => 'logout' ); @@ -229,7 +232,7 @@ function wp_logout_url($redirect = '') { * * @param string $redirect Path to redirect to on login. * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false. - * @return string A log in url + * @return string A log in URL. */ function wp_login_url($redirect = '', $force_reauth = false) { $login_url = site_url('wp-login.php', 'login'); @@ -248,8 +251,8 @@ function wp_login_url($redirect = '', $force_reauth = false) { * the HTML immediately. Pass array('echo'=>false) to return the string instead. * * @since 3.0.0 - * @param array $args Configuration options to modify the form output - * @return Void, or string containing the form + * @param array $args Configuration options to modify the form output. + * @return string|null String when retrieving, null when displaying. */ function wp_login_form( $args = array() ) { $defaults = array( 'echo' => true, @@ -305,6 +308,7 @@ function wp_login_form( $args = array() ) { * @uses apply_filters() calls 'lostpassword_url' hook on the lostpassword url * * @param string $redirect Path to redirect to on login. + * @return string Lost password URL. */ function wp_lostpassword_url( $redirect = '' ) { $args = array( 'action' => 'lostpassword' ); @@ -328,6 +332,7 @@ function wp_lostpassword_url( $redirect = '' ) { * @param string $before Text to output before the link (defaults to