wp_loginout() – Function | Developer.WordPress.org

Displays 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

$redirectstringoptional: Optional path to redirect to on login/logout.
Default:''
$displaybooloptional: Default to echo and not return the link.
Default:true

Return

void|string Void if $display argument is true, log in/out link if $display is false.

Source

function wp_loginout( $redirect = '', $display = 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 ( $display ) {
		/**
		 * Filters the HTML output for the Log In/Log Out link.
		 *
		 * @since 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 );
	}
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘loginout’, string $link ): Filters the HTML output for the Log In/Log Out link.

Uses	Description
wp_login_url()`wp-includes/general-template.php`	Retrieves the login URL.
wp_logout_url()`wp-includes/general-template.php`	Retrieves the logout URL.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
esc_url()`wp-includes/formatting.php`	Checks and cleans a URL.
is_user_logged_in()`wp-includes/pluggable.php`	Determines whether the current visitor is a logged in user.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 4 more Show less

Used by	Description
WP_Widget_Meta::widget()`wp-includes/widgets/class-wp-widget-meta.php`	Outputs the content for the current Meta widget instance.

Changelog

Version	Description
1.5.0	Introduced.

User Contributed Notes

Skip to note 3 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
Basic Example
```
<p><?php wp_loginout(); ?></p>
```
Log in to add feedback
Skip to note 4 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Add Log In/Out link to nav menu

Simply add this code to your parent or child themes functions.php file to display a Log In/Out link in the secondary navigation menu of the Twenty Fourteen default theme for WordPress.
```
add_filter( 'wp_nav_menu_secondary_items','wpdocs_loginout_menu_link' );

/**
 * Append Login In/Out link to menu with a redirect to this page
 */
function wpdocs_loginout_menu_link( $menu ) {
    $loginout = wp_loginout( $_SERVER['REQUEST_URI'], false );
    $menu .= $loginout;
    return $menu;
}
```
Other themes like Twenty Thirteen may require you to add a class to the code like this example.
```
$loginout = '<li class="nav-menu" class="menu-item">'
	. wp_loginout( $_SERVER['REQUEST_URI'], false )
	. '</li>';
```
Log in to add feedback

wp_loginout( string $redirect = ”, bool $display = true ): void|string

In this article