WP_ajax about controller

[abelthomas]

You can define the wp_ajax_ actions within the __construct() method of a controller. The trick is to define the callback method as a static function, instead of public.

Here's an example:

// `app/controllers/FrontPage.php`

class FrontPage extends Controller {
  /**
   * Constructor
   */
  public function __construct() {
    // handle ajax requests
    add_action( 'wp_ajax_do_something', [$this, 'do_something'] );
    add_action( 'wp_ajax_nopriv_do_something', [$this, 'do_something'] );
  }

  /**
   * AJAX request callback
   *
   */
  public static function do_something() {
    // code code beep boop
    $response = "I'm heading off to the land of javascript.";
    echo $response;
    die();
  }
}

If the callback were defined as a normal public function, the die() statement would break the page, since all public functions are automatically exposed to the respective view. Defining the function as static circumvents this, while still allowing the function to run.

NOTE: you can't call a private or protected method from within a publicly instantiated class, so that's why we must use the static visibility.

[mtx-z]

Found one way to do it:

In function.php (or related file executed for each request)

add_action( 'wp_ajax_nopriv_action_name', [ \App\MyController::class, 'methodController' ] );
add_action( 'wp_ajax_action_name', [ \App\MyController::class, 'methodController' ] );

Works to use a Controller method for a wp_ajax action. add_action cannot be placed into Controller constructor as it's not instanciated on ajax call.

[marcelo2605]

Thanks for the help @mtx-z. Just one question: the method must be static or could be public?

[mtx-z]

I haven't putted it in a method. It's directly in the function.php file. I guess you could put it in a method hooked on the "init" filter maybe.
So no static/public here as we're not in a Sober Controller.

EDIT: Ah you're talking about the called method from the Controller. Well I don't know if I have tested it. If you do so, please report here !

[marcelo2605]

@mtx-z I believe it is only possible use static functions because public functions is running when the page is load (I'm using Sage starter theme).

[mtx-z]

Tested, and it works with public methods.

using

add_action( 'wp_ajax_nopriv_action_name', [ \App\MyController::class, 'methodController' ] );
add_action( 'wp_ajax_action_name', [ \App\MyController::class, 'methodController' ] );

I'm able to ajax call

namespace App;
use Sober\Controller\Controller;

class MyController extends Controller {

    public function methodController() {
        ...
    }
}

The action callback will itself instantiate the controller, and call the matching method from this instance (I guess).