WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/wp explain nonce


This function has been deprecated. That means it has been replaced by a new function or is no longer supported, and may be removed from future versions. All code that uses this function should be converted to use its replacement if one exists. See also wp-includes/deprecated.php. Use wp_nonce_ays instead.

Contents

Description

Retrieve nonce action 'Are you sure' message.

The action is split by verb and noun. The action format is as follows: verb-action_extra. The verb is before the first dash and has the format of letters and no spaces and numbers. The noun is after the dash and before the underscore, if an underscore exists. The noun is also only letters.

The filter will be called for any action, which is not defined by WordPress. You may use the filter for your plugin to explain nonce actions to the user, when they get the "Are you sure?" message. The filter is in the format of 'explain_nonce_$verb-$noun' with the $verb replaced by the found verb and the $noun replaced by the found noun. The two parameters that are given to the hook are the localized 'Are you sure you want to do this?' message with the extra text (the text after the underscore).

Usage

<?php wp_explain_nonce$action ?>

Parameters

$action
(string) (required) Nonce action.
Default: None

Return Values

(string) 
Are you sure message.

Examples

Notes

Change Log

  • Deprecated: 3.4.1
  • Since: 2.0.4

Source File

wp_explain_nonce() was located in wp-includes/functions.php. It has been moved to wp-includes/deprecated.php

Related

Nonce functions: wp_explain_nonce(), wp_nonce_ays(), wp_nonce_field(), wp_nonce_url(), wp_verify_nonce(), wp_create_nonce(), check_admin_referer(), check_ajax_referer(), wp_referer_field()

See also index of Function Reference and index of Template Tags.