mahdy/wpnonce

running wordpress nonce in opject orianted manner

1.0.0 2017-11-29 20:54 UTC

MIT

• Mahdy Nasr

README

Wordpress nonce in an object-oriented manner

Usage

this package used instead of wp_nonce_*() functions in WordPress. it built in an object-oriented way and also make the code more readable.

Environment

it tested against WordPress v4.9.

Installation

either via direct composer command :

composer require mahdy/wpnonce

or via editing composer.json file and then use composer update

{
    "require": {
        "mahdy/wpnonce" : "1.0.0"
    }
}

How to use

the package used for generating and verifying the WordPress Nonce.

Set the Action

1- via constructor

$nonce =  new \WpNonce\Nonce("Xaction");

2- via setter function

$nonce =  new \WpNonce\Nonce();
$nonce->setAction("Xaction");

Set the name (Optional)

It used for URL and form field. The default value is "_wpnonce"

$nonce->setName("theNewName");

Generate the Nonce string

1- Exciplicitly

/*if you didn't set the action in constructor, you have to use setter before to use this function*/
$nonce_string = $nonce->generateNonce();

2- As string

/*use the object directly */
$str = "the following object will return as Nonce string ".$nonce;

Generate the Nonce URL

$url = "https://somewebsite.com/";
$nonce_url = $nonce->generateNonceUrl($url);

Generate Nonce Field in form

It take 2 optional parametars: generateNonceField($referer = true, $echo = true)

$nonce_HTML_input = $generateNonceField()

Verifying Nonce string

it return 1 if the nonce generated in last 12h and 2 if it generated in last 24h

if (\WpNonce\NonceVerifier::verify($nonce, $action)) {...}

Verify Nonce from submitted

Verifying using checkAdminReferer($action, $input_name = "_wpnonce") function.

if (\WpNonce\NonceVerifier::checkAdminReferer($action)) {...}

Verify Ajax requist

the function checkAjaxReferer($action, $arg_name = false, $die = true) has 2 optional parametars.

if (\WpNonce\NonceVerifier::checkAjaxReferer($action)) {...}

Running the UnitTest

1- you have first to install PHPUnit

2- open the package folder: vendor/mahdy/wpnonce change to this directory to run the phpunit

3- before run change the vendor/mahdy/wpnonce/bootstrap.php and change the WORDPRESS_PATH to your WordPress installation directory.

4- in command line from package directory run

$ phpunit