wp_nonce_field( int|string $action = -1, string $name = '_wpnonce', bool $referer = true, bool $display = true ): string

Description

Parameters

$actionint|stringoptional

Action name. Default -1.Default: -1

$namestringoptional

Nonce name. Default '_wpnonce'.Default: '_wpnonce'

$refererbooloptional

Whether to set the referer field for validation. Default true.Default: true

$displaybooloptional

Whether to display or return hidden form field. Default true.Default: true

Return

string

Nonce field HTML markup.

Uses · 3

• esc_attr()Escaping for HTML attributes.
• wp_create_nonce()Creates a cryptographic token tied to a specific action, user, user session, and window of time.
• wp_referer_field()Retrieves or displays referer hidden field for forms.

Used by · 42

• Custom_Background::admin_page()Displays the custom background page.
• Custom_Image_Header::step_1()Displays first step of custom header image page.
• Custom_Image_Header::step_2()Displays second step of custom header image page.
• WP_Comments_List_Table::display()Displays the comments table.
• WP_Comments_List_Table::extra_tablenav()Displays extra controls between bulk actions and pagination.
• WP_List_Table::display_tablenav()Generates the table navigation above or below the table.
• WP_Post_Comments_List_Table::display()
• WP_Posts_List_Table::inline_edit()Outputs the hidden row displayed when inline editing
• WP_Screen::render_screen_options()Renders the screen options tab.
• WP_Terms_List_Table::inline_edit()Outputs the hidden row displayed when inline editing
• WP_Theme_Install_List_Table::display()Displays the theme install table.
• WP_Themes_List_Table::display()Displays the themes table.

Source

View on Trac ↗View on GitHub ↗

1906function wp_nonce_field( $action = -1, $name = '_wpnonce', $referer = true, $display = true ) {1907	$name        = esc_attr( $name );1908	$nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';1909 1910	if ( $referer ) {1911		$nonce_field .= wp_referer_field( false );1912	}1913 1914	if ( $display ) {1915		echo $nonce_field;1916	}1917 1918	return $nonce_field;1919}

History

Introduced in 2.0.4. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.