WordPress at a glance

wp_logout_url() WP 1.0

Retrieves the logout URL.

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

Is the basis for: wp_loginout()
Hooks from function:
Return

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

Usage

wp_logout_url( $redirect );
$redirect(string)
Path to redirect to on logout.
Default: ''

Code of wp_logout_url: wp-includes/general-template.php VER 5.0.1

<?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 );
}

Related Functions

From category: Login/Logout

More from Template Tags: Main Functions

No comments
    Hello, !     Log In . Register