wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_nonce_field › WordPress Function

Since2.0.4
Deprecatedn/a
› wp_nonce_field ( $action = -1, $name = '_wpnonce', $referer = true, $display = true )
Parameters: (4)
  • (int|string) $action Optional. Action name. Default -1.
    Required: No
    Default: -1
  • (string) $name Optional. Nonce name. Default '_wpnonce'.
    Required: No
    Default: '_wpnonce'
  • (bool) $referer Optional. Whether to set the referer field for validation. Default true.
    Required: No
    Default: true
  • (bool) $display Optional. Whether to display or return hidden form field. Default true.
    Required: No
    Default: true
Returns:
  • (string) Nonce field HTML markup.
Defined at:
Codex:

Retrieves or display nonce hidden field for forms.

The nonce field is used to validate that the contents of the form came from the location on the current site and not somewhere else. The nonce does not offer absolute protection, but should protect against most cases. It is very important to use nonce field in forms. The $action and $name are optional, but if you want to have better security, it is strongly suggested to set those two parameters. It is easier to just call the function without any parameters, because validation of the nonce doesn't require any parameters, but since crackers know what the default is it won't be difficult for them to find a way around your nonce and cause damage. The input name will be whatever $name value you gave. The input value will be the nonce creation value.


Related Functions: signup_nonce_fields, wp_nonce_url, wp_nonce_tick, wp_nonce_ays, wp_referer_field

Source 

function wp_nonce_field( $action = -1, $name = '_wpnonce', $referer = true, $display = true ) {
	$name        = esc_attr( $name );
	$nonce_field = '<input type="hidden" id="' . $name . '" name="' . $name . '" value="' . wp_create_nonce( $action ) . '" />';

	if ( $referer ) {
		$nonce_field .= wp_referer_field( false );
	}

	if ( $display ) {
		echo $nonce_field;
	}

	return $nonce_field;
}