wp_loginout( string $redirect = '', bool $echo = true )

Display the Log In/Out link.


Description

Displays a link, which allows users to navigate to the Log In page to log in or log out depending on whether they are currently logged in.


Parameters

$redirect

(Optional) path to redirect to on login/logout.

Default value: ''

$echo

(Optional) Default to echo and not return the link.

Default value: true


Return

(string|void) String when retrieving.


Source

File: wp-includes/general-template.php

function wp_loginout($redirect = '', $echo = true) {
	if ( ! is_user_logged_in() )
		$link = '<a href="' . esc_url( wp_login_url($redirect) ) . '">' . __('Log in') . '</a>';
	else
		$link = '<a href="' . esc_url( wp_logout_url($redirect) ) . '">' . __('Log out') . '</a>';

	if ( $echo ) {
		/**
		 * Filters the HTML output for the Log In/Log Out link.
		 *
		 * @since WP-1.5.0
		 *
		 * @param string $link The HTML link content.
		 */
		echo apply_filters( 'loginout', $link );
	} else {
		/** This filter is documented in wp-includes/general-template.php */
		return apply_filters( 'loginout', $link );
	}
}


Changelog

Changelog
Version Description
WP-1.5.0 Introduced.