https://github.com/MarcoPal/wp-custom-endpoints

WP Custom Endpoints, a blazing fast way to add custom endpoints to your Wordpress REST API, inspired by Laravel routing.
https://github.com/MarcoPal/wp-custom-endpoints

Last synced: 2 months ago
JSON representation

WP Custom Endpoints, a blazing fast way to add custom endpoints to your Wordpress REST API, inspired by Laravel routing.

• Host: GitHub
• URL: https://github.com/MarcoPal/wp-custom-endpoints
• Owner: MarcoPal
• License: mit
• Created: 2018-09-01T22:03:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-28T10:34:50.000Z (about 6 years ago)
• Last Synced: 2024-08-02T05:22:48.514Z (6 months ago)
• Language: PHP
• Homepage:
• Size: 11.7 KB
• Stars: 28
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - wp-custom-endpoints - WP Custom Endpoints, a blazing fast way to add custom endpoints to your Wordpress REST API, inspired by Laravel routing. (PHP)

README

        
# WP Custom Endpoints

A plugin to add custom endpoints to your WordPress REST API

1. Edit route.php to add your custom endpoints.

2. Add your controllers to manage the routes

3. (optional) Edit config.php to setup your API namespace and version.

You'll find all your defined routes in the main JSON at

yourdomain.com/wp-json

### Example

File route.php

```

Route::get('posts', 'PostsController@getAllPosts');

Route::get('posts/{id?}', 'PostsController@getPostById');

Route::get('posts/{category}/{id}', 'PostsController@getPostById');

```

Your controller:

```

class PostsController extends WP_Custom_Endpoints

{

    public static function getAllPosts()

    {

        $posts = get_posts(['posts_per_page' => 5]);

        return array_map(function ($post) {

            return self::post_schema($post);

        }, $posts);

    }

    

    

    public static function getPostById($request)

        {

            if (!empty($request['category'])) {

                // Filter all post by category

            }

    

            if (empty($request['id']))

                return self::getAllPosts([]);

    

            $post = get_post($request['id']);

    

            return self::post_schema($post);

        }

}

```

 

 

By default you have 3 methods that you can extend in your controller:

```

public function get_permission_callback();

```

If this function returns true, the response will be proccessed

If it returns false, a default error message will be returned

and the request will not proceed with processing

 

 

```

public function get_validate_callback($param, $request, $key)

```

This function should return true if the value is valid, and false if not.

 

 

```

public function get_sanitize_callback($param, $request, $key)

```

Used to sanitize the value of the argument before passing it to the main callback.

 

 

 

 

 

 

 

 

TODO:

Add a 3rd parameter to the routes declaration to define custom callback methods