wp_loginout( string $redirect = '', bool $display = true ): void|string
Displays the Log In/Out link.
Contents
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
string Optional -
Optional path to redirect to on login/logout.
Default:
''
-
$display
bool Optional -
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
File: wp-includes/general-template.php
.
View all references
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 );
}
}
Hooks
-
apply_filters( 'loginout',
string $link ) -
Filters the HTML output for the Log In/Log Out link.
Changelog
Version | Description |
---|---|
1.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Basic Example
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.
Other themes like Twenty Thirteen may require you to add a class to the code like this example.