unprefix / nonce
A OOP wrapper for WordPress Nonce
Requires
- php: >=5.6
- cocur/slugify: ^3.0
- unprefix/template-loader: ^3.0
Requires (Dev)
- brain/monkey: ^2.1
- phpunit/phpunit: ^5.7
This package is not auto-updated.
Last update: 2024-10-27 04:59:10 UTC
README
Unprefix Nonce
A WordPress package that wrap the nonce logic in a OOP way.
Requirements
- PHP 5.6+
- WordPress 4.8+
- Slugify ^3.0
- Unprefix Template Loader ^3.0
Installation
Use composer
composer require unprefix/nonce
License
The package is open source and released under GPL-2 license. See LICENSE for more info.
Issues
You can submit issues via github issues.
Documentation
Create a basic Nonce
use Unprefix\Nonce\Nonce; // This create a new nonce instance. $nonce = new Nonce('action_name'); // To retrieve the nonce just do this. $nonce->nonce(); // To retrieve the nonce action. $nonce->action();
Create a basic Nonce with helper
use Unprefix\Nonce\Nonce; // This will generate the nonce and return the nonce string, all at once. $nonce = Nonce::create('nonce_action');
Create a URL Nonce
The constructor for NonceUrl
take three parameters, a Nonce
instance, a nonce name and an url in which add the nonce.
use Unprefix\Nonce\NonceUrl; $nonceUrl = new NonceUrl( new Nonce('nonce_action'), 'nonce_name', 'http://www.mycustomurl.com' ); // Retrieve the url. $nonceUrl->url(); // To retrieve the name. $nonceUrl->name();
Create a nonce url with helper
You don't need to pass an Nonce
instance when using the helper function, just pass the action name as first
parameter.
use Unprefix\Nonce\NonceUrl; // Retrieve the nonce url string at once. $nonceUrl = NonceUrl::create('action_name', 'nonce_name', 'http://www.mycustomurl.com');
Create a nonce Field
Like NonceUrl
to create a NonceField
you must pass a Nonce
instance along with the name and the referrer parameter.
The referrer parameter is optional, you can ignore it if you don't want to include the referrer input field.
use Unprefix\Nonce\NonceField; $nonceField = new NonceField( new Nonce('nonce_action'), 'nonce_name', true ); // Show the nonce field. $nonceField->tmpl( $nonceField->data() );
The NonceField
class implements Unprefix\TemplateInterface from unprefix/unprefix-templateloader to print the markup of the field.
The file is searched within the views
directory two level up of the src/
directory.
It is possible to filter the template path by hooking into tmploader_template_file_path
filter as you can see in Loader.php
Also, like other classes you can use an helper function to print the field at once.
use Unprefix\Nonce\NonceField; NonceField::field('nonce_action', 'nonce_name', true);
Verify Nonce
To verify a nonce it is possible to use the NonceVerification
class.
The class provide a single method with which is possible to verify nonces, admin referrer and ajax referrer.
use Unprefix\Nonce\NonceValidation; // Create the instance $nonceVerify = new NonceVerification( new Nonce('nonce_action'), 'name_action', 'POST', // But can be GET, REQUEST false ); $nonceVerify->verify();