云策 WordPress 开发者社区

函数文档

wp_admin_headers()

查看官方原文 ↗
💡 云策文档标注

概述

wp_admin_headers() 函数用于发送 Referrer-Policy 头部，以防止管理屏幕的引用信息被外部发送。它通过设置默认策略并允许过滤器修改来实现此功能。

关键要点

  • 函数发送 Referrer-Policy 头部，默认值为 'strict-origin-when-cross-origin'。
  • 提供 admin_referrer_policy 过滤器，允许开发者自定义策略值。
  • 函数在 WordPress 4.9.0 引入，6.8.0 版本中从 wp-admin/includes/misc.php 移至 wp-includes/functions.php。

代码示例

function wp_admin_headers() {
    $policy = 'strict-origin-when-cross-origin';
    $policy = apply_filters( 'admin_referrer_policy', $policy );
    header( sprintf( 'Referrer-Policy: %s', $policy ) );
}

注意事项

  • 使用 admin_referrer_policy 过滤器时，需确保返回有效的 Referrer-Policy 值。
  • 函数位置变更可能影响依赖旧路径的代码，需在升级时检查。
📄 原文内容

Sends a referrer policy header so referrers are not sent externally from administration screens.

Source

function wp_admin_headers() {
	$policy = 'strict-origin-when-cross-origin';

	/**
	 * Filters the admin referrer policy header value.
	 *
	 * @since 4.9.0
	 * @since 4.9.5 The default value was changed to 'strict-origin-when-cross-origin'.
	 *
	 * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Referrer-Policy
	 *
	 * @param string $policy The admin referrer policy header value. Default 'strict-origin-when-cross-origin'.
	 */
	$policy = apply_filters( 'admin_referrer_policy', $policy );

	header( sprintf( 'Referrer-Policy: %s', $policy ) );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘admin_referrer_policy’, string $policy )

Filters the admin referrer policy header value.

Uses Description
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
6.8.0 This function was moved from wp-admin/includes/misc.php to wp-includes/functions.php.
4.9.0 Introduced.