perezlabs/wp-nonce-wrapper-class

There is no license information available for the latest version (dev-master) of this package.

A package that provides the functionality of working with WordPress Nonces in an object orientated way.

dev-master 2016-02-02 14:10 UTC

This package is not auto-updated.

Last update: 2024-09-20 09:42:04 UTC


README

This class provides the functionality of working with WordPress Nonces in an object orientated way.

Table of contents:

Requirements

  • PHP >= 5.4
  • WordPress >= 3.5

Installation

You can install this class via command-line or drag it into the root of your plugin directory.

via Command-line

Using Composer, add Nonce Wrapper Class to your plugin's dependencies.

composer require perezlabs/wp-nonce-wrapper-class:dev-master

Another way

  1. Download the latest zip of this repo.
  2. Unzip the master.zip file.
  3. Drag it into the root of your plugin directory.
  4. Happy coding :)!

Usage

Setup the minimum required thigs:

<?php
require_once 'vendor/autoload.php';

use Perezlabs\WpNonceWrapper\WpNonceWrapper;

// Instantiate the class
$nonce = new WpNonceWrapper();

Examples

Adding a nonce to a URL:

$complete_url = $nonce->wpNonceUrl( $bare_url, 'trash-post_'.$post->ID );

Adding a nonce to a form:

$nonce->wpNonceField( 'delete-comment_'.$comment_id );

Creating a nonce:

$newNonce = $nonce->wpCreateNonce( 'my-action_'.$post->ID );

Verifying a nonce:

$nonce->checkAdminReferer( 'delete-comment_'.$comment_id );

Verifying a nonce passed in an AJAX request:

$nonce->checkAjaxReferer( 'process-comment' );

Verifying a nonce passed in some other context:

$nonce->wpVerifyNonce( $_REQUEST['my_nonce'], 'process-comment'.$comment_id );