Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/varunsridharan/wp-ajaxer

Simple Lightweight Ajax Handler For WP Theme/Plugin Developers
https://github.com/varunsridharan/wp-ajaxer

ajax ajax-handler ajax-library library php vsp-libs vsp-wp-ajaxer wordpress wordpress-ajax wordpress-development wordpress-plugin wordpress-plugin-library wordpress-theme wordpress-theme-library wp-ajax wp-ajax-handler wp-ajaxer wp-developers wp-library wp-theme

Last synced: 29 days ago
JSON representation

Simple Lightweight Ajax Handler For WP Theme/Plugin Developers

Host: GitHub
URL: https://github.com/varunsridharan/wp-ajaxer
Owner: varunsridharan
License: gpl-3.0
Created: 2018-03-27T02:44:31.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2021-04-29T19:35:48.000Z (over 3 years ago)
Last Synced: 2024-09-27T14:42:18.422Z (about 1 month ago)
Topics: ajax, ajax-handler, ajax-library, library, php, vsp-libs, vsp-wp-ajaxer, wordpress, wordpress-ajax, wordpress-development, wordpress-plugin, wordpress-plugin-library, wordpress-theme, wordpress-theme-library, wp-ajax, wp-ajax-handler, wp-ajaxer, wp-developers, wp-library, wp-theme
Language: PHP
Homepage: https://varunsridharan.github.io/wp-ajaxer/
Size: 146 KB
Stars: 5
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # WP Ajaxer

Simple Lightweight Ajax Handler For WP Theme/Plugin Developers

[![Latest Stable Version](https://poser.pugx.org/varunsridharan/wp-ajaxer/version)](https://packagist.org/packages/varunsridharan/wp-ajaxer)

[![Total Downloads](https://poser.pugx.org/varunsridharan/wp-ajaxer/downloads)](https://packagist.org/packages/varunsridharan/wp-ajaxer)

[![Latest Unstable Version](https://poser.pugx.org/varunsridharan/wp-ajaxer/v/unstable)](//packagist.org/packages/varunsridharan/wp-ajaxer)

[![License](https://poser.pugx.org/varunsridharan/wp-ajaxer/license)](https://packagist.org/packages/varunsridharan/wp-ajaxer)

[![composer.lock available](https://poser.pugx.org/varunsridharan/wp-ajaxer/composerlock)](https://packagist.org/packages/varunsridharan/wp-ajaxer)

## Installation

The preferred way to install this extension is through [Composer](http://getcomposer.org/download/).

To install **WP_Ajaxer library**, simply:

    $ composer require Varunsridharan/WP_Ajaxer

The previous command will only install the necessary files, if you prefer to **download the entire source code** you can use:

    $ composer require Varunsridharan/WP_Ajaxer --prefer-source

You can also **clone the complete repository** with Git:

    $ git clone https://github.com/varunsridharan/wp-ajaxer.git

Or **install it manually**:

[Download WP_Ajaxer.php](https://raw.githubusercontent.com/varunsridharan/wp-ajaxer/master/class-ajaxer.php):

    $ wget https://raw.githubusercontent.com/varunsridharan/wp-ajaxer/master/class-ajaxer.php

## Sample Usage

```php

class BoilerPlate_Ajax extends Varunsridharan\WordPress\Ajaxer {

	/**

	 * Ajax Action Prefix

	 *

	 * @example for wordpress_show_popup wordpress is the prefix

	 *

	 * @var string

	 */

	protected $action_prefix = 'bp';

	/**

	 * Ajax Action Surfix

	 *

	 * @example for wordpress_show_popup_data data is the surfix

	 *

	 * @var string

	 */

	protected $action_surfix = '';

	/**

	 * Action Name

	 * provide value if all ajax requests runs in a single action key.

	 *

	 * @var string

	 */

	protected $action = 'bp-plugin';

	/**

	 * Array of ajax actions

	 *

	 * @example array('ajax_action_1' => true,'ajax_action_2' => false)

	 *          if value set to true then it runs for both loggedout / logged in users

	 *          if value set to false then it runs only for the logged in user

	 *

	 * @var array

	 */

	protected $actions = array(

		'action1'   => false,

		'action-12' => false,

	);

	/**

	 * Set to true if plugin's ajax runs in a single action

	 *

	 * @example Single Ajax Action

	 *          admin-ajax.php?action=plugin-slug&plugin-slug-action=ajax-action&param1=value1&param2=value=2

	 *          Multiple Ajax Actions

	 *          admin-ajax.php?action=plugin-slug-ajax-action1&param1=value1=param2=value2

	 *

	 * @var bool

	 */

	protected $is_single = true;

	/**

	 * Provide a action key if $this->is_single is set to true

	 *

	 * @var string

	 */

	protected $single_ajax_key = '';

	public function __construct( ) {

		parent::__construct();

	}

	public function action1() {

		///do some action here

	}

}

```

## Methods

* `is_get()` -> Checks if current ajax is requested Via **GET** Method

* `is_post()` -> Check if current ajax is requested Via **POST** Method

* `get($key,$default)` -> Retrives Value of the given key from **$_GET** Variable 

* `post($key,$default)` -> Retrives Value of the given key from **$_POST** Variable 

* `request($key,$default)` -> Retrives Value of the given key from **$_REQUEST** Variable 

* `json_error($data,$status_code)` -> Triggers `wp_send_json_error`

* `json_success($data,$status_code)` -> Triggers `wp_send_json_success`

* `validate_post($key,$error)` -> Checks if given key is exits in **$_POST** if not send an error

* `validate_get($key,$error)` -> Checks if given key is exits in **$_GET** if not send an error

---

## 📝 Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

[Checkout CHANGELOG.md](https://github.com/varunsridharan/wp-ajaxer/blob/main/CHANGELOG.md)

## 🤝 Contributing

If you would like to help, please take a look at the list of [issues](https://github.com/varunsridharan/wp-ajaxer/issues/).

## 📜  License & Conduct

- [**GNU General Public License v3.0**](https://github.com/varunsridharan/wp-ajaxer/blob/main/LICENSE) © [Varun Sridharan](website)

- [Code of Conduct](https://github.com/varunsridharan/.github/blob/main/CODE_OF_CONDUCT.md)

## 📣 Feedback

- ⭐ This repository if this project helped you! :wink:

- Create An [🔧 Issue](https://github.com/varunsridharan/wp-ajaxer/issues/) if you need help / found a bug

## 💰 Sponsor

[I][twitter] fell in love with open-source in 2013 and there has been no looking back since! You can read more about me [here][website].

If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

- ☕ How about we get to know each other over coffee? Buy me a cup for just [**$9.99**][buymeacoffee]

- ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as [**$9.99**][buymeacoffee]

- 🔰         We love bettering open-source projects. Support 1-hour of open-source maintenance for [**$24.99 one-time?**][paypal]

- 🚀         Love open-source tools? Me too! How about supporting one hour of open-source development for just [**$49.99 one-time ?**][paypal]

[paypal]: https://sva.onl/paypal

[buymeacoffee]: https://sva.onl/buymeacoffee

[twitter]: https://sva.onl/twitter/

[website]: https://sva.onl/website/

## Connect & Say 👋

- **Follow** me on [👨‍💻 Github][github] and stay updated on free and open-source software

- **Follow** me on [🐦 Twitter][twitter] to get updates on my latest open source projects

- **Message** me on [📠 Telegram][telegram]

- **Follow** my pet on [Instagram][sofythelabrador] for some _dog-tastic_ updates!

[sofythelabrador]: https://www.instagram.com/sofythelabrador/

[github]: https://sva.onl/github/

[twitter]: https://sva.onl/twitter/

[telegram]: https://sva.onl/telegram/

---



Built With ♥ By Varun Sridharan 

     



   



---

[composer]: http://getcomposer.org/download/

[downloadzip]:https://github.com/varunsridharan/wp-ajaxer/archive/master.zip

[latest-stable-version-img]: https://poser.pugx.org/varunsridharan/wp-ajaxer/version

[latest-Unstable-version-img]: https://poser.pugx.org/varunsridharan/wp-ajaxer/v/unstable

[total-downloads-img]: https://poser.pugx.org/varunsridharan/wp-ajaxer/downloads

[Latest-Unstable-version-img]: https://poser.pugx.org/varunsridharan/wp-ajaxer/v/unstable

[wpcs-img]: https://img.shields.io/badge/WordPress-Standar-1abc9c.svg

[license-img]: https://poser.pugx.org/varunsridharan/wp-ajaxer/license

[composerlock-img]: https://poser.pugx.org/varunsridharan/wp-ajaxer/composerlock

[latest-stable-version-link]: https://packagist.org/packages/varunsridharan/wp-ajaxer

[latest-Unstable-version-link]: https://packagist.org/packages/varunsridharan/wp-ajaxer

[total-downloads-link]: https://packagist.org/packages/varunsridharan/wp-ajaxer

[Latest-Unstable-Version-link]: https://packagist.org/packages/varunsridharan/wp-ajaxer

[wpcs-link]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/

[license-link]: https://packagist.org/packages/varunsridharan/wp-ajaxer

[composerlock-link]: https://packagist.org/packages/varunsridharan/wp-ajaxer