W3cubDocs

/WordPress

wp_logout_url( string $redirect = '' )

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 value: ''

Return

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

Source

File: wp-includes/general-template.php

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

	$logout_url = add_query_arg( $args, site_url( 'wp-login.php', '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 );
}

Changelog

Version Description
2.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_logout_url