WordPress函数:wp_logout_url

一、函数简介

WordPress 中用于生成用户登出链接的函数。它返回一个指向登出处理程序的 URL,并允许指定登出后重定向的目标页面。‌‌

<a href="<?php echo wp_logout_url(); ?>" title="Logout">登出</a>

二、函数参数

  • $redirect‌(可选):指定登出后重定向的 URL。如果未提供,用户将被重定向到登录页面或网站首页。支持相对路径(如 /login-page)或绝对 URL(如 http://example.com)。‌‌

三、函数案例

  • 重定向到当前页面
<a href="<?php echo wp_logout_url(get_permalink()); ?>">登出</a>
  • 重定向到外部网站
<a href="<?php echo wp_logout_url('http://example.com'); ?>">登出</a>

四、调试效果

五、源代码

/**
 * Retrieves the logout URL.
 *
 * Returns the URL that allows the user to log out of the site.
 *
 * @since 2.7.0
 *
 * @param string $redirect Path to redirect to on logout.
 * @return string The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url().
 */
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 );
}

THE END