Giter VIP home page Giter VIP logo

varunsridharan / wp-ajaxer Goto Github PK

View Code? Open in Web Editor NEW
5.0 3.0 1.0 149 KB

Simple Lightweight Ajax Handler For WP Theme/Plugin Developers

Home Page: https://varunsridharan.github.io/wp-ajaxer/

License: GNU General Public License v3.0

PHP 100.00%
wp-library wp-developers wordpress wordpress-development wordpress-theme wordpress-plugin wordpress-plugin-library wordpress-theme-library library php

wp-ajaxer's Introduction

WP Ajaxer

Simple Lightweight Ajax Handler For WP Theme/Plugin Developers

Latest Stable Version Total Downloads Latest Unstable Version License composer.lock available

Installation

The preferred way to install this extension is through Composer.

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:

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

Sample Usage

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, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

๐Ÿค Contributing

If you would like to help, please take a look at the list of issues.

๐Ÿ“œ License & Conduct

๐Ÿ“ฃ Feedback

  • โญ This repository if this project helped you! ๐Ÿ˜‰
  • Create An ๐Ÿ”ง Issue if you need help / found a bug

๐Ÿ’ฐ Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. 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
  • โ˜•๏ธโ˜•๏ธ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
  • ๐Ÿ”ฐ We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
  • ๐Ÿš€ Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

Connect & Say ๐Ÿ‘‹


Built With โ™ฅ By Varun Sridharan


wp-ajaxer's People

Contributors

varunsridharan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

reswordpress

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.