wp_create_nonce( string|int $action = -1 )

Creates a cryptographic token tied to a specific action, user, user session, and window of time.


Description Description


Parameters Parameters

$action

(string|int) (Optional) Scalar value to add context to the nonce.

Default value: -1


Top ↑

Return Return

(string) The token.


Top ↑

Source Source

File: wp-includes/pluggable.php

function wp_create_nonce($action = -1) {
	$user = wp_get_current_user();
	$uid = (int) $user->ID;
	if ( ! $uid ) {
		/** This filter is documented in wp-includes/pluggable.php */
		$uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
	}

	$token = wp_get_session_token();
	$i = wp_nonce_tick();

	return substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
}

Top ↑

Changelog Changelog

Changelog
Version Description
4.0.0 Session tokens were integrated with nonce creation
2.0.3 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    Contributed by Codex

    Example
    In this simple example, we create an nonce and use it as one of the GET query parameters in a URL for a link. When the user clicks the link they are directed to a page where a certain action will be performed (for example, a post might be deleted). On the target page the nonce is verified to insure that the request was valid (this user really clicked the link and really wants to perform this action).

    /*
     * Step A: Create an nonce for a link.
     * We pass it as a GET parameter.
     * The target page will perform some action based on the 'do_something' parameter.
     */
    $nonce = wp_create_nonce( 'my-nonce' );
    ?>
    <a href='myplugin.php?do_something=some_action&_wpnonce=<?php echo esc_attr( $nonce ); ?>'><?php esc_html_e( 'Do some action', 'textdomain' ); ?></a>
    
    
    /*
     * Step B: This code would go in the target page.
     * We need to verify the nonce.
     */
    $nonce = $_REQUEST['_wpnonce'];
    if ( ! wp_verify_nonce( $nonce, 'my-nonce' ) ) {
    	// This nonce is not valid.
    	die( __( 'Security check', 'textdomain' ) ); 
    } else {
    	// The nonce was valid.
    	// Do stuff here.
    }
    

    In the above example we simply called our nonce my-nonce. It is best to choose a name for the nonce that is specific to the action. For example, if we were to create an nonce that would be part of a request to delete a post, we might call it delete_post. Then to make it more specific, we could append the ID of the particular post that the nonce was for. For example delete_post-5 for the post with ID 5.

    wp_create_nonce( 'delete_post-' . $post_id );
    

    Then we would verify the nonce like this:

    wp_verify_nonce( $nonce, "delete_post-{$_REQUEST['post_id']}" );
    

    In general, it is best to make the name for the action as specific as possible.

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