/rest-ajax-plugin

Primary LanguagePHP

REST AJAX

Utilizes WordPress REST API (instead of admin-ajax.php). This plugin works as a controller for the AJAX handlers.

AJAX handlers lives in app/AjaxHandler. All files in app/AjaxHandler uses the App\AjaxHandler namespace. AJAX handlers can be defined in two ways, and are called "method" or "class" based (AJAX) handlers.

  1. A public static method in the default AJAX handler class DefaultHandler.php. This is how a method based handler is defined.
  2. It's own file and handler class. This is how a class based handler is defined.

The class of a class based handler must extend the abstract Triggerfish\REST_Ajax\AbstractAjaxHandler class and implement a public method called __getData.

More in-depth information

Actions and handlers does not need to be registered like tf_add_ajax_handler or add_action('wp_ajax_XXX'). The request is automatically mapped to a class or a method, specific to the current action. All is mapped by the action sent in the request. Automatic templating can be achieved.

Request flow:

  1. A class named like the action in StudlyCase will be searched in the following namespace, App\AjaxHandler. If such a class is found and has a public method named __getData, the flow will jump to 3. This is what is called "class based" handler below.

  2. If a class cannot be found by 1, the fallback will be searched for. The fallback is a public static method named like the action in camelCase in App\AjaxHandler\DefaultHandler. This is what is called "method based" handler below.

  3. Automatic templating. If the data from 1 or 2 is an array, a template named like the action in kebab-case will be searched forin a directory called "ajax" in the views directory.

    But if the handler is "class based", the class can define a public method named __template that return the preferred template's path. This will take precedence over, and fall back to, the template in the "ajax" directory from above.

    The data from 1 or 2 will be injected as the template will be included with the App\template function.

Actions:

  • tf/ajax/before
  • tf/ajax/before/action=XX
  • tf/ajax/after/action=XX
  • tf/ajax/after/action=XX

Filters:

  • tf/ajax/result
  • tf/ajax/result/action=XX
  • tf/ajax/template_paths
  • tf/ajax/template_paths/action=XX