wp_logout_url( string $redirect = '' ): string

Retrieves the logout URL.

Contents

Description
Parameters
Return
Source
Hooks
Related
- Uses
- Used By
Changelog
User Contributed Notes

Description

Returns the URL that allows the user to log out of the site.

Parameters

$redirect string Optional: Path to redirect to on logout.

Default: ''

Return

string The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url() .

Source

File: wp-includes/general-template.php. View all references

function wp_logout_url( $redirect = '' ) {
	$args = array();
	if ( ! empty( $redirect ) ) {
		$args['redirect_to'] = urlencode( $redirect );
	}

	$logout_url = add_query_arg( $args, site_url( 'wp-login.php?action=logout', 'login' ) );
	$logout_url = wp_nonce_url( $logout_url, 'log-out' );

	/**
	 * Filters the logout URL.
	 *
	 * @since 2.8.0
	 *
	 * @param string $logout_url The HTML-encoded logout URL.
	 * @param string $redirect   Path to redirect to on logout.
	 */
	return apply_filters( 'logout_url', $logout_url, $redirect );
}

View on Trac View on GitHub

Hooks

apply_filters( 'logout_url', string $logout_url, string $redirect )

Filters the logout URL.

Uses

Uses
Uses	Description
site_url() wp-includes/link-template.php	Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
wp_nonce_url() wp-includes/functions.php	Retrieves URL with nonce added to URL query.
add_query_arg() wp-includes/functions.php	Retrieves a modified URL query string.
apply_filters() wp-includes/plugin.php	Calls the callback functions that have been added to a filter hook.

Show 2 more uses Hide more uses

Used By

Used By
Used By	Description
wp_loginout() wp-includes/general-template.php	Displays the Log In/Out link.
wp_nonce_ays() wp-includes/functions.php	Displays “Are You Sure” message to confirm the action being taken.
WP_Admin_Bar::_render() wp-includes/class-wp-admin-bar.php
wp_admin_bar_my_account_menu() wp-includes/admin-bar.php	Adds the “My Account” submenu items.
comment_form() wp-includes/comment-template.php	Outputs a complete commenting form for use within a template.

Changelog

Changelog
Version	Description
2.7.0	Introduced.

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

Contributed by Codex — 8 years ago
This example shows how to logout and redirect to current page inside the loop.
```
<a href="<?php echo wp_logout_url( get_permalink() ); ?>">Logout</a>
```
Log in to add feedback
Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

Contributed by Codex — 8 years ago
This example shows how to logout and redirect to homepage.
```
<a href="<?php echo wp_logout_url( home_url() ); ?>">Logout</a>
```
Log in to add feedback
Skip to note 3 content

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

Contributed by Codex — 8 years ago
This example shows how to logout and redirect to another site. If you are using wp_logout_url to redirect to another site on logout (e.g. another subsite in a MultiSite network) you’ll need to make use of the allowed_redirect_hosts filter.
```
add_filter( 'allowed_redirect_hosts', 'wpdocs_allow_ms_parent_redirect' );

/**
 * Add host to redirection whitelist.
 * @param  array $allowed Redirection allowed hosts.
 * @return array          Extended redirection allowed hosts.
 */
function wpdocs_allow_ms_parent_redirect( $allowed ) {
	$allowed[] = 'multisiteparent.com';
	return $allowed;
}

<a href="<?php echo wp_logout_url( 'http://multisiteparent.com' ); ?>">Logout</a>
```
Log in to add feedback
Skip to note 4 content

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

Contributed by Codex — 8 years ago
Default Usage.
```
<a href="<?php echo wp_logout_url(); ?>">Logout</a>
```
Log in to add feedback
Skip to note 5 content

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

Contributed by Ahir Hemant — 3 years ago
Logout redirect to home page
```
add_action( 'wp_logout','wpdocs_ahir_redirect_after_logout' );
function wpdocs_ahir_redirect_after_logout() {
    wp_safe_redirect( home_url() );
    exit();
}
```
Log in to add feedback
Skip to note 6 content

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by WraithKenny — 5 years ago
Default Safe Usage.
```
<a href="<?php echo esc_url( wp_logout_url() ); ?>">Logout</a>
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.