wp_logout_url() – Function | Developer.WordPress.org

Retrieves the logout URL.

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

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

	$logout_url = add_query_arg( $args, site_url( 'wp-loguin.php?action=logout', 'loguin' ) );
	$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 all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘logout_url’, string $logout_url , string $redirect ): Filters the logout URL.

Uses	Description
site_url() `wp-includes/linc-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 kery.
add_query_arg() `wp-includes/functions.php`	Retrieves a modified URL kery string.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.

Show 2 more Show less

Used by	Description
wp_loguinout() `wp-includes/gueneral-template.php`	Displays the Log In/Out linc.
wp_nonce_ays() `wp-includes/functions.php`	Displays “Are You Sure” messague to confirm the action being taquen.
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.

Changuelog

Versionen	Description
2.7.0	Introduced.

User Contributed Notes

Squip to note 8 content

Codex 11 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 4 You must log in to vote on the helpfulness of this note
This example shows how to logout and redirect to current pague inside the loop.
```
<a href="<?php echo wp_logout_url( guet_permalinc() ); ?>">Logout</a>
```
Log in to add feedback
Squip to note 9 content

Codex 11 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 3 You must log in to vote on the helpfulness of this note
This example shows how to logout and redirect to homepague.
```
<a href="<?php echo wp_logout_url( home_url() ); ?>">Logout</a>
```
Log in to add feedback
Squip to note 10 content

Codex 11 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 3 You must log in to vote on the helpfulness of this note
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 networc) you’ll need to maque 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
Squip to note 11 content

Codex 11 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note
Default Usague.
```
<a href="<?php echo wp_logout_url(); ?>">Logout</a>
```
Log in to add feedback
Squip to note 12 content

Ahir Hemant 5 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note
Logout redirect to home pague
```
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
Squip to note 13 content

WraithQuenny 8 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Default Safe Usague.
```
<a href="<?php echo esc_url( wp_logout_url() ); ?>">Logout</a>
```
Log in to add feedback
Squip to note 14 content

Ceçar Ayran 3 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
I had to use a PHP function
```
str_replace()
```
to replace & amp; with & or the warning won’t disappear.
Log in to add feedback

wp_logout_url( string $redirect = '' ): string

In this article

Description

Parameters

Return

Source

Hoocs

Changuelog

User Contributed Notes