云策 WordPress 开发者社区

函数文档

wp_get_referer()

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

概述

wp_get_referer() 函数用于从 '_wp_http_referer' 查询变量或 HTTP referer 中检索来源 URL。如果来源 URL 与当前请求 URL 相同，则返回 false。

关键要点

  • 函数返回字符串（成功时）或 false（失败时），失败情况包括来源 URL 与当前请求 URL 相同或 wp_validate_redirect() 未定义。
  • HTTP referer 是服务器变量，注意 'referer' 是故意拼写错误的。
  • 函数内部调用 wp_get_raw_referer() 获取未验证的来源，并通过 wp_validate_redirect() 进行验证。
  • 相关函数包括 wp_get_raw_referer()、wp_validate_redirect()、wp_unslash() 和 home_url()。
  • 在 WordPress 核心中广泛使用，例如在 WP_Recovery_Mode、WP_Customize_Manager 和多个管理功能中。

代码示例

if ( wp_get_referer() ) {
	wp_safe_redirect( wp_get_referer() );
} else {
	wp_safe_redirect( get_home_url() );
}
📄 原文内容

Retrieves referer from ‘_wp_http_referer’ or HTTP referer.

Description

If it’s the same as the current request URL, will return false.

Return

string|false Referer URL on success, false on failure.

More Information

HTTP referer is a server variable. ‘referer’ is deliberately misspelled.

If page “refered” (form posted) to itself, returns false (because $_SERVER[‘HTTP_REFERER’] == $_REQUEST[‘_wp_http_referer’])

Source

function wp_get_referer() {
	// Return early if called before wp_validate_redirect() is defined.
	if ( ! function_exists( 'wp_validate_redirect' ) ) {
		return false;
	}

	$ref = wp_get_raw_referer();

	if ( $ref && wp_unslash( $_SERVER['REQUEST_URI'] ) !== $ref
		&& home_url() . wp_unslash( $_SERVER['REQUEST_URI'] ) !== $ref
	) {
		return wp_validate_redirect( $ref, false );
	}

	return false;
}

View all references View on Trac View on GitHub

Uses Description
wp_get_raw_referer()wp-includes/functions.php

Retrieves unvalidated referer from the ‘_wp_http_referer’ URL query variable or the HTTP referer.
wp_validate_redirect()wp-includes/pluggable.php

Validates a URL for use in a redirect.
wp_unslash()wp-includes/formatting.php

Removes slashes from a string or recursively removes slashes from strings within an array.
home_url()wp-includes/link-template.php

Retrieves the URL for the current site where the front end is accessible.

Show 2 moreShow less

Used by Description
WP_Recovery_Mode::handle_exit_recovery_mode()wp-includes/class-wp-recovery-mode.php

Handles a request to exit Recovery Mode.
the_block_editor_meta_box_post_form_hidden_fields()wp-admin/includes/post.php

Renders the hidden form required for the meta boxes form.
WP_Customize_Manager::get_return_url()wp-includes/class-wp-customize-manager.php

Gets URL to link the user to when closing the Customizer.
WP_Terms_List_Table::handle_row_actions()wp-admin/includes/class-wp-terms-list-table.php

Generates and displays row action links.
wp_media_attach_action()wp-admin/includes/media.php

Encapsulates the logic for Attach/Detach actions.
set_screen_options()wp-admin/includes/misc.php

Saves option for number of rows when listing posts, pages, comments, etc.
_admin_notice_post_locked()wp-admin/includes/post.php

Outputs the HTML for the notice to say that someone else is editing or has taken over editing of this post.
WP_Terms_List_Table::column_name()wp-admin/includes/class-wp-terms-list-table.php
redirect_post()wp-admin/includes/post.php

Redirects to previous page.
auth_redirect()wp-includes/pluggable.php

Checks if a user is logged in, if not it redirects them to the login page.
check_admin_referer()wp-includes/pluggable.php

Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
wp_nonce_ays()wp-includes/functions.php

Displays “Are You Sure” message to confirm the action being taken.
wp_original_referer_field()wp-includes/functions.php

Retrieves or displays original referer hidden field for forms.

Show 8 moreShow less

Changelog

Version Description
2.0.4 Introduced.

User Contributed Notes