https://github.com/micropackage/ajax
AJAX wrapper for WordPress
https://github.com/micropackage/ajax
ajax bracketspace micropackage php wordpress wrapper
Last synced: 2 months ago
JSON representation
AJAX wrapper for WordPress
- Host: GitHub
- URL: https://github.com/micropackage/ajax
- Owner: micropackage
- License: gpl-3.0
- Created: 2020-02-10T13:41:11.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2020-02-12T11:22:45.000Z (over 5 years ago)
- Last Synced: 2024-11-24T09:40:04.172Z (7 months ago)
- Topics: ajax, bracketspace, micropackage, php, wordpress, wrapper
- Language: PHP
- Size: 31.3 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ajax
[](https://bracketspace.com)
[](https://packagist.org/packages/micropackage/ajax)
[](https://packagist.org/packages/micropackage/ajax)
[](https://packagist.org/packages/micropackage/ajax)
[](https://packagist.org/packages/micropackage/ajax)
## 🧬 About Ajax
This micropackage is a wrapper for WordPress AJAX responses in PHP.
## 💾 Installation
``` bash
composer require micropackage/ajax
```
## 🕹 Usage
### Basic usage
```php
use Micropackage\Ajax\Response;
function ajax_action_handler() {
$response = new Response();
// Handle nonce.
$response->verify_nonce( $action = 'my_action', $query_arg = 'noncefield', $send_if_failed = true );
// Do some checks and immediately send an error.
if ( something_is_wrong() ) {
$response->error( 'Error message' );
}
// This is never reached.
$response->send( 'All good' );
}
```
### Error collecting
You can collect multiple errors in one response.
```php
use Micropackage\Ajax\Response;
function ajax_action_handler() {
$response = new Response();
// Do some checks.
if ( something_is_wrong() ) {
$response->add_error( 'Error message' );
}
// Do some checks.
if ( something_else_is_wrong() ) {
$response->add_error( 'Whoah!' );
}
// If no error added, the below message will be sent.
$response->send( 'All good if no errors' );
}
```
### Sending data
```php
use Micropackage\Ajax\Response;
function ajax_action_handler() {
$response = new Response();
$response->send( $data_array );
}
```
## 📦 About the Micropackage project
Micropackages - as the name suggests - are micro packages with a tiny bit of reusable code, helpful particularly in WordPress development.
The aim is to have multiple packages which can be put together to create something bigger by defining only the structure.
Micropackages are maintained by [BracketSpace](https://bracketspace.com).
## 📖 Changelog
[See the changelog file](./CHANGELOG.md).
## 📃 License
GNU General Public License (GPL) v3.0. See the [LICENSE](./LICENSE) file for more information.