mahdy/wpnonce

running wordpress nonce in opject orianted manner

WpNonce

Wordpress nonce in an object-oriented manner, _(*1)

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., _(*2)

Environment

it tested against WordPress v4.9., _(*3)

Installation

either via direct composer command :, _(*4)

composer require mahdy/wpnonce

or via editing composer.json file and then use composer update, _(*5)

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

How to use

the package used for generating and verifying the WordPress Nonce., _(*6)

Set the Action

1- via constructor, _(*7)

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

2- via setter function, _(*8)

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

Set the name (Optional)

It used for URL and form field. The default value is "_wpnonce", _(*9)

$nonce->setName("theNewName");

Generate the Nonce string

1- Exciplicitly, _(*10)

/*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, _(*11)

/*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), _(*12)

$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, _(*13)

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

Verify Nonce from submitted

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

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

Verify Ajax requist

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

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

Running the UnitTest

1- you have first to install PHPUnit, _(*16)

2- open the package folder: vendor/mahdy/wpnonce change to this directory to run the phpunit, _(*17)

3- before run change the vendor/mahdy/wpnonce/bootstrap.php and change the WORDPRESS_PATH to your WordPress installation directory., _(*18)

4- in command line from package directory run, _(*19)

$ phpunit