duncanjbrown/plain-route

Define arbitrary endpoints in WordPress

Purpose

This library provides a simple interface for WordPress's fiddly rewrite rules API., _(*1)

It's useful for creating arbitrary endpoints with callbacks. For example, a webhook receiver for a payment gateway., _(*2)

Usage

Creating an endpoint is accomplished by newing one up. You should do this on init., _(*3)

add_action( 'init', function() {
  new Plain_Route( 'stripe(/)?', [
    'rewrite' => 'p=123',
    'pre_get_posts' => function( $query ) {
    if( $query->is_main_query() ) {
      $query->set('stripe', true);
    }
  }]);
});

In the above example, pre_get_posts could be replaced with wp_title or wp. Or you could add them alongside., _(*4)

You can also render any template with the special template callback., _(*5)

Creating an endpoint that renders a specific template:, _(*6)

add_action( 'init', function() {
    new Plain_Route( 'my-special-template(/)?', [
        'template' => 'my-special-template.php'
    ]);
});

Credit

This class is a much-simplified variation of HM_Rewrite by humanmade., _(*7)