Codex

Function Reference/wp nonce field

Contents

Description

Retrieve 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.

If you set $echo to false and set $referer to true, then you will need to retrieve the referer field using wp_referer_field(). If you have the $referer set to true and are echoing the nonce field, it will also echo the referer field.

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.

Usage

<?php wp_nonce_field( $action, $name, $referer, $echo ) ?>

Parameters

$action
(string) (optional) Action name.
Default: -1
$name
(string) (optional) Nonce name.
Default: "_wpnonce"
$referer
(boolean) (optional) default true. Whether to set the referer field for validation.
Default: true
$echo
(boolean) (optional) default true. Whether to display or return hidden form field.
Default: true

Return Values

(string) 
Nonce field.

Examples

Notes

Change Log

Since: 2.0.4

Source File

wp_nonce_field() is located in wp-includes/functions.php.

Related

Retrieved from "http://codex.wordpress.org/Function_Reference/wp_nonce_field"

Codex Resources