wp_referer_field() – Function | Developer.WordPress.org

wp_referer_field( bool $display = true ): string

Retrieves or displays referer hidden field for forms.

Description

The referer link is the current Request URI from the server super global. The input name is ‘_wp_http_referer’, in case you wanted to check manually.

Parameters

$displaybooloptional: Whether to echo or return the referer field.
Default:true

Return

string Referer field HTML markup.

Source

function wp_referer_field( $display = true ) {
	$request_url   = remove_query_arg( '_wp_http_referer' );
	$referer_field = '<input type="hidden" name="_wp_http_referer" value="' . esc_url( $request_url ) . '" />';

	if ( $display ) {
		echo $referer_field;
	}

	return $referer_field;
}

View all references View on Trac View on GitHub

Uses	Description
remove_query_arg()`wp-includes/functions.php`	Removes an item or items from a query string.
esc_url()`wp-includes/formatting.php`	Checks and cleans a URL.

Used by	Description
WP_Plugin_Install_List_Table::display_tablenav()`wp-admin/includes/class-wp-plugin-install-list-table.php`
wp_nonce_field()`wp-includes/functions.php`	Retrieves or display nonce hidden field for forms.

Changelog

Version	Description
2.0.4	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.