A lightweight jQuery script for handerling REST API requests.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

RESTjQuery

License GitHub forks Tweet

A lightweight jQuery script for handerling REST API requests from or to your WordPress site.

Follow us

💻 Website 🐦Twitter

Overview 🔔

This project was created to save time writing more lines of code just to get the returned REST API response via jQuery. Perfect for keeping your own code to a minimum rather than repeating yourself.

Perfect for building web apps.

Is This Free?

Yes, it's free. But here's what you should really care about:

  • It's lightweight. Only 3.04 KB

What's the Catch?

This is a non-commercial project. As such:

  • Development time for it is effectively being donated and is therefore, limited.
  • Critical issues may not be resolved promptly.

Please understand that this repository is not a place to seek help with configuration-related issues. Use it to report bugs, propose improvements, or discuss new features.

Guide 📘

Documentation 📖

Requirements

To use this project you will need:

  • WordPress v4.4+

Installation 💽

If you want to use the script within your WordPress site:

  1. Go to WordPress Admin > Plugins > Add New.
  2. Search for WordPress REST API jQuery Support.
  3. Click Install Now and Activate the plugin.

... or if you wish to use the script in an app while keeping WordPress safe and secure elsewhere:

  1. Download the latest release from this Git repository.
  2. Copy wp-rest-api-jquery.min.js from dist folder to your app lib folder.
  3. Apply the script either to the header or footer of your app.
<script src="https://yourdomain.***/lib/wp-rest-api-jquery.min.js"></script>

Usage

Make sure that when you use the script in your app that you set the site_url to the location of WordPress. Otherwise it is NOT required!

var posts = restjQuery(
  site_url: "https://wordpress.location"
);

Support ⭐

RESTjQuery is released freely and openly. Feedback or ideas and approaches to solving limitations in RESTjQuery is greatly appreciated.

At present I do not offer a dedicated, premium support channel for RESTjQuery. Please understand this is a non-commercial project. As such:

  • Development time for it is effectively being donated and is therefore, limited.
  • Support inquiries may not be answered in a timely manner.
  • Critical issues may not be resolved promptly.

Reporting Issues 📝

If you think you have found a bug in the project, a problem with the documentation, or want to see a new feature added, please open a new issue and I will do my best to help you out.

Contribute

If you or your company use RESTjQuery or appreciate the work I’m doing in open source, please consider supporting me directly so I can continue maintaining it and keep evolving the project. It's pretty clear that software actually costs something, and even though it may be offered freely, somebody is paying the cost.

You'll be helping to ensure I can spend the time not just fixing bugs, adding features, releasing new versions, but also keeping the project afloat. Any contribution you make is a big help and is greatly appreciated.

Please also consider starring and sharing 👍 the repo! This helps the project getting known and grow with the community. 🙏

If you want to do a one-time donation, you can donate to:

If you have special requirements for a sponsorship, you can email me and we can talk.

If you would like to contribute code to this project then please follow these contribution guidelines.

Thank you for your support! 🙌

Development 💻

  1. Clone the GitHub repository: https://github.com/seb86/WordPress-REST-API-jQuery.git
  2. Browse to the folder in the command line.
  3. Run the npm install --only=dev command to install the development dependencies within a /node_modules/ folder.
  4. Run the grunt test command to check for any JS errors.
  5. Run the grunt build command for minifying the script ready for distribution.
  6. Run the grunt zip command to generate a release zipped up.

License

RESTjQuery is released under GNU General Public License v3.0.

Credits

RESTjQuery is developed and maintained by Sébastien Dumont.