=== Tori Ajax ===
Contributors: alvinmuthui
Donate link: https://www.buymeacoffee.com/alvinmuthui
Tags: tori_ajax, ajax, wordpress, toria_add_ajax, javascript
Requires at least: 3.0.0
Tested up to: 6.8.3
Stable tag: 2.0.3
Requires PHP: 5.6.20
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Adds Ajax in WordPress with a few lines of code. Adding Ajax is now simple as calling toria_add_ajax($action_name, $php_callback, $js_script_path) function
== Description ==
Add AJAX easily by passing an action name, PHP callback, and JavaScript file path to the toria_add_ajax() function with the Tori Ajax plugin.
== Installation ==
1. Upload `tori-ajax` folder to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Add custom code to add ajax in your theme functions or anywhere else desirable. For example:
~~~~
function my_simple_ajax() {
// Magic happens here.
echo json_encode( 'Welcome to Tori Ajax' );
}
if ( function_exists( 'toria_add_ajax' ) ) {
toria_add_ajax(
'simple',
'my_simple_ajax',
get_stylesheet_directory_uri() . '/inc/my_custom_ajax/toria_ajax.js'
);
}
~~~~
4. Create a javascript file in the `inc/my_custom_ajax/toria_ajax.js`.
5. Add Javascript code. For example:
~~~~
function tori_ajax() {
jQuery.ajax({
type: "post",
url: toria.ajax_url, // admin-ajax.php path,
data: {
action: toria.action, // action
nonce: toria.nonce, // pass the nonce here
},
success: function (data) {
console.log(data.trim());
//alert(data.trim());
},
error: function (errorThrown) {
console.log(errorThrown);
}
});
}
tori_ajax();// call the function.
~~~~
== Documentation ==
Please check out the [Tori Ajax plugin Documentation](https://toriajax.com/documentation)
== Frequently Asked Questions ==
= How to solve toria_add_ajax() is undefined? =
* By ensuring the Tori Ajax plugin is installed.
* Use the if statement to check if the toria_add_ajax() exists first before using it. For example:
~~~~
if ( function_exists( 'toria_add_ajax' ) ) {
toria_add_ajax(
'simple',
'my_simple_ajax',
get_stylesheet_directory_uri() . '/inc/my_custom_ajax/toria_ajax.js'
);
}
~~~~
= How to register action for both logged in and non logged in users?=
You can use the fourth parameter to set the mode to *'both'*.
By default, the mode is set to *'private'* for authenticated Ajax actions for logged-in users.
You can also use *'public'* to expose the Ajax action to non-authenticated Ajax actions for logged-out users
**Summary**
*both* - For exposing the Ajax action to authenticated Ajax actions for logged-in users and non-authenticated Ajax actions for logged-out users.
Example
~~~~
if ( function_exists( 'toria_add_ajax' ) ) {
toria_add_ajax(
'simple',
'my_simple_ajax',
get_stylesheet_directory_uri() . '/inc/my_custom_ajax/toria_ajax.js',
'both'
);
}
~~~~
*private* - For exposing the Ajax action to authenticated Ajax actions for logged-in users.
Example
~~~~
if ( function_exists( 'toria_add_ajax' ) ) {
toria_add_ajax(
'simple',
'my_simple_ajax',
get_stylesheet_directory_uri() . '/inc/my_custom_ajax/toria_ajax.js',
'private'
);
}
~~~~
Or
~~~~
if ( function_exists( 'toria_add_ajax' ) ) {
toria_add_ajax(
'simple',
'my_simple_ajax',
get_stylesheet_directory_uri() . '/inc/my_custom_ajax/toria_ajax.js'
);
}
~~~~
*public* - For exposing the Ajax action to non-authenticated Ajax actions for logged-out users.
Example
~~~~
if ( function_exists( 'toria_add_ajax' ) ) {
toria_add_ajax(
'simple',
'my_simple_ajax',
get_stylesheet_directory_uri() . '/inc/my_custom_ajax/toria_ajax.js',
'public'
);
}
~~~~
== Screenshots ==
1. Sample theme functions PHP code
2. Sample Javascript code
3. Sample theme functions PHP code for authenticated and non-authenticated Ajax actions.
4. Sample theme functions PHP code for authenticated Ajax actions.
5. Sample theme functions PHP code for non-authenticated Ajax actions.
== Changelog ==
= 1.0.0 =
* The beginning of the Tori Ajax plugin.
= 1.0.1 =
* Fixed: Uncaught ArgumentCountError during the nonce check.
* Added JSON output for nonce messages.
= 1.0.2 =
* Added 3 optional arguments to *toria_add_ajax()* function:
1. `$script_depends` (string[]) (Optional) An array of registered script handles this script depends on. Default value: array().
2. `$script_version` (string|bool|null) (Optional) String specifying script version number, if it has one, which is added to the URL as a query string for cache busting purposes. If the version is set to false, a version number is automatically added equal to the current installed Tori Ajax version. If set to null, no version is added. Default value: false.
3. `$script_in_footer` (bool) (Optional) Whether to enqueue the script before instead of in the