函数文档

wp_admin_bar_recovery_mode_menu()

💡 云策文档标注

概述

wp_admin_bar_recovery_mode_menu() 是一个 WordPress 函数,用于在恢复模式激活时,在管理工具栏添加退出恢复模式的链接。

关键要点

  • 函数仅在 WordPress 处于恢复模式时执行,通过 wp_is_recovery_mode() 检测。
  • 生成退出恢复模式的 URL,包括登录 URL、查询参数和非ce验证。
  • 使用 WP_Admin_Bar::add_node() 在管理工具栏的 top-secondary 区域添加节点。
  • 相关函数包括 wp_is_recovery_mode()、wp_login_url()、add_query_arg()、wp_nonce_url() 和 __()。

代码示例

function wp_admin_bar_recovery_mode_menu( $wp_admin_bar ) {
	if ( ! wp_is_recovery_mode() ) {
		return;
	}

	$url = wp_login_url();
	$url = add_query_arg( 'action', WP_Recovery_Mode::EXIT_ACTION, $url );
	$url = wp_nonce_url( $url, WP_Recovery_Mode::EXIT_ACTION );

	$wp_admin_bar->add_node(
		array(
			'parent' => 'top-secondary',
			'id'     => 'recovery-mode',
			'title'  => __( 'Exit Recovery Mode' ),
			'href'   => $url,
		)
	);
}

注意事项

  • 此函数从 WordPress 5.2.0 版本开始引入。
  • 确保在恢复模式下使用,否则函数会提前返回。
  • 节点 ID 为 'recovery-mode',便于自定义或扩展。

📄 原文内容

Adds a link to exit recovery mode when Recovery Mode is active.

Parameters

$wp_admin_barWP_Admin_Barrequired
The WP_Admin_Bar instance.

Source

function wp_admin_bar_recovery_mode_menu( $wp_admin_bar ) {
	if ( ! wp_is_recovery_mode() ) {
		return;
	}

	$url = wp_login_url();
	$url = add_query_arg( 'action', WP_Recovery_Mode::EXIT_ACTION, $url );
	$url = wp_nonce_url( $url, WP_Recovery_Mode::EXIT_ACTION );

	$wp_admin_bar->add_node(
		array(
			'parent' => 'top-secondary',
			'id'     => 'recovery-mode',
			'title'  => __( 'Exit Recovery Mode' ),
			'href'   => $url,
		)
	);
}

Changelog

Version Description
5.2.0 Introduced.