Skip to content

Wordpress API

Resources

Auth Plugins

Using JWT-Auth

  • Added to composer.json
    • Under require: "wpackagist-plugin/jwt-authentication-for-wp-rest-api": "~1"
  • Added JWT constant to wp-config.php - define('JWT_AUTH_SECRET_KEY','');
  • Access - local server - http://paseo.demo/wp-json/jwt-auth/v1/token Pass in username and password via form post.

Notes

  • pass ?_embed as part of the url to get some content embedded. http://paseo.demo/wp-json/wp/v2/posts?_embed;

Tools/packages used

  • Timber - Templating engine. Not really necessary but think can be used to customize the admin site.
  • Vuejs - Front-end framework I’m using for custom site.

Issues

  • Learning this API is much harder than it should be.
  • Biggest issue I’m running into is using the local client.
  • Figuring out how to use the remote endpoints seems so much simpler.
  • Documentation is very spotty.
  • Hard to fine relevant or up-to-date resources.
  • Don’t seem to be many books around (that are up to date).
  • Decided I’m just going to use React. Not worth the extra hassle trying to figure out the Wordpress way

Admin notes

Admin and ajax

Creating admin settings page

Enabling your plugin for wordpress

  • Resources
    • wp-api - add as dependency for a script when you enqueue.
  • Setup
    • Create new folder Settings under Admin
    • Create new classes
      • Rest
        • Manages the Rest request and response
      • Settings
        • Manages the creation and management of the form, menu and database.
    • Rest Class 
      <?php
/**
 * Created by IntelliJ IDEA.
 * User: themartins
 * Date: 2017/10/15
 * Time: 23:21
 */

namespace Paseo\Admin\Settings;


class Rest
{
    /**
     * @return bool
     */
    public static function permissions() {
        return current_user_can(Settings::$permissions);
    }

    /**
     * @return array
     */
    public static function get_settings() {
        return Settings::get_settings();
    }

    /**
     * @param \WP_REST_Request $request
     * @return \WP_REST_Response
     */
    public static function update_settings( \WP_REST_Request $request ) {
        $settings = array();
        foreach( Settings::$defaults as $setting => $value ){
            $result = $request->get_param($setting);
            if($result) {
                $settings[$setting] = $result;
            }
        }
        Settings::save_settings($settings);
        $updated_settings = self::get_settings();
        return rest_ensure_response( $updated_settings )->set_status(201);
    }

    /**
     * @param \WP_REST_Request $request
     * @return \WP_REST_Response
     */
    public static function check_settings(\WP_REST_Request $request ) {
        $settings = self::get_settings();
        return \rest_ensure_response($settings);
    }

}

Authenticating with JWT Authentication for WP REST API

  • JWT Authentication for WP Rest Api
  • Using Postman
    • post request
      • Url: http://paseo.demo/wp-json/jwt-auth/v1/token
      • Body Params
        • username
        • password
      • Response: 
        {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9qd3QuZGV2IiwiaWF0IjoxNDM4NTcxMDUwLCJuYmYiOjE0Mzg1NzEwNTAsImV4cCI6MTQzOTE3NTg1MCwiZGF0YSI6eyJ1c2VyIjp7ImlkIjoiMSJ9fX0.YNe6AyWW4B7ZwfFE5wJ0O6qQ8QFcYizimDmBy6hCH_8",
    "user_display_name": "admin",
    "user_email": "admin@localhost.dev",
    "user_nicename": "admin"
}
  • Sending a request
    • Create header
      • key: Authorization
      • Value: “token” value
    • Will authenticate when necessary.

Use timber as the templating engine

  • composer require timber/timber
  • Set location
    • user Timber\Timber; Allow to use Timber
    • Timber::$location = ‘file path to template folder’; Ex: Timber::$location = ‘/Users/johan/wp/plugin/site/admin’;
    • Timber::render(‘mytemplate.twig’); Ex: Will return false if not completed.

Issues with using Rest API

  • Limits access to customizing the site
    • Current tools for modifying templates won’t work.
    • Front-end modification can be limited.
Last update: April 13, 2020 15:50:46