ympervej/wp-oop-nonces-csrf

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

This package enables the wordpress nonce function in an object-oriented environment

Maintainers

Details

github.com/Yeasir/wp-oop-nonces-csrf

Source

Issues

Installs: 9

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:wordpress-package

1.0.0 2018-01-19 09:43 UTC

Requires

  • php: >=5.6.0

Requires (Dev)

Unknown License dcf345958c01cd1d2c1a413978aa05c289aa1983

  • Yeasir <pervej86.woop@gmail.com>

This package is not auto-updated.

Last update: 2025-06-22 07:47:35 UTC

README

#WordPress Nonces in OOP Environment

A composer package, which serves the functionality working with WordPress Nonces in an object orientated environment.

#Requirement

Wordpress Version: Minimum 4.8
PHP Version: Minimum 5.6
PHP Unit Version: 5

#Installation Add this package as requirement at your composer.json file and then run 'composer update'

"ympervej/wp-oop-nonces-csrf": "1.0.*"

Or directly run

composer require ympervej/wp-oop-nonces-csrf

##Usage

add to your functions.php, in the active theme

// Autoload files using Composer autoload
require __DIR__ . '/vendor/autoload.php';

##Examples

###Create a nonce

This will creates a cryptographic token tied to a specific action

####### Arguments string or int $action Scalar value to add context to the nonce. ####### Return The token.

$Wp_Csrf_Nonce = new \wp_oop_nonce_csrf\Wp_Oop_Nonces_Csrf();
$csrf_nonce_create = $Wp_Csrf_Nonce->wp_oop_create_nonce( $action );

For example:

<a href='my_url.php?nonce_something=nonce_action&_wpnonce=<?php echo $csrf_nonce_create; ?>'>Your Nonce Action</a>

###Verify a nonce

Verify that correct nonce was used with time limit.

####### Arguments $nonce and $action. ####### Return Boolean or 1.

$Wp_Csrf_Nonce = new \wp_oop_nonce_csrf\Wp_Oop_Nonces_Csrf();
$csrf_nonce_verify = $Wp_Csrf_Nonce->wp_oop_verify_nonce( $nonce, $action );

###Add a nonce to a URL

Retrieve URL with nonce added to URL query.

####### Arguments $action_url and $action and $name. ####### Return Escaped URL with nonce action added.

$Wp_Csrf_Nonce = new \wp_oop_nonce_csrf\Wp_Oop_Nonces_Csrf();
$csrf_nonce_url = $Wp_Csrf_Nonce->wp_oop_nonce_csrf_URL($action_url, $action, $name );

###Add a nonce to a form

Retrieve URL with nonce added to URL query.

####### Arguments action, $name, $referer, $echo. ####### Return Nonce field HTML markup.

$Wp_Csrf_Nonce = new \wp_oop_nonce_csrf\Wp_Oop_Nonces_Csrf();
$csrf_nonce_field = $Wp_Csrf_Nonce->wp_oop_nonce_csrf_field(action, $name, $referer, $echo );

###Ajax Nonce Verification ###Verify a nonce passed in an AJAX request ####### Arguments $action, $query_arg, $die. ####### Return Boolean or 1.

$Wp_Csrf_Nonce = new \wp_oop_nonce_csrf\Wp_Oop_Nonces_Csrf();
$csrf_nonce_ajax_ref = $Wp_Csrf_Nonce->wp_oop_nonce_csrf_checka_ajax_referer($action, $query_arg, $die);

Admin Nonce Verification.

####Makes sure that a user was referred from another admin page. ####### Arguments $action, $query_arg. ####### Return Boolean or 1.

$Wp_Csrf_Nonce = new \wp_oop_nonce_csrf\Wp_Oop_Nonces_Csrf();
$csrf_nonce_admin_ref = $Wp_Csrf_Nonce->wp_oop_nonce_csrf_check_admin_referer($action, $query_arg);

###Display Nonce Action Message. ####This will display 'Are you sure you want to do this?' message to confirm the action being taken. ####### Arguments $action. ####### Return Boolean or 1.

$Wp_Csrf_Nonce = new \wp_oop_nonce_csrf\Wp_Oop_Nonces_Csrf();
$csrf_action_text = $Wp_Csrf_Nonce->wp_oop_nonce_csrf_ays($action);

###Retrieve or display referer hidden field for forms. ####The referer link is the current Request URI from the server super global. ####### Arguments $echo Boolean. ####### Return Referer field HTML markup.

$Wp_Csrf_Nonce = new \wp_oop_nonce_csrf\Wp_Oop_Nonces_Csrf();
$csrf_refer_field = $Wp_Csrf_Nonce->wp_oop_nonce_csrf_referer_field($echo);

How to run Unit Tests

  1. In Terminal Run this
$ CD /wordpress/your-theme-folder/wp-oop-nonces-csrf
  1. Install PHP Unit on dev
$ composer require --dev phpunit/phpunit:~5

  1. Copy the Test Directory from "/vendor/ympervej/wp-oop-nonces-csrf/tests" to "your-theme-folder/wp-oop-nonces-csrf"

  2. Run Composer Update

$ composer update
  1. Run This in Terminal to test
$ ./vendor/bin/phpunit --bootstrap vendor/autoload.php tests/WpOopCsrfTest
  1. You can also test with this
$ ./vendor/bin/phpunit --bootstrap vendor/autoload.php --testdox tests

Thanks to

License

MIT