Atte Liimatainen

<p>Converts frontend to JSON response when request is done with certain conditions.</p>
<h3>Inspiration</h3>
<p>After creating a bunch of headless WordPress + Web app stacks, I wanted to find a standard and a all-round solution for fetching per page information for web applications inside WordPress. Built-in rest api works fine in basic cases, but it doesn’t support querying by path. Usually this meant that for each project developers would create a custom rest endpoint which would return expected content using content type and slug parameters.</p>
<p>WordPress has few built-in functions to retrieve content by path, <a href="https://developer.wordpress.org/reference/functions/url_to_postid/" rel="nofollow ugc">url_to_postid</a> and <a href="https://developer.wordpress.org/reference/functions/get_page_by_path/" rel="nofollow ugc">get_page_by_path</a>, but they don’t seem to work with multilanguage plugins, taxonomy or archive pages, which means that WP doesn’t have a reliable way to fetch content this way through rest api.</p>
<p>This plugin converts frontend to JSON which seems after above solution the best way to do things, with added layer of security through application passwords (WordPress v5.6 feature) and a filter, which let’s developers alter outgoing data.</p>
<h3>How to start using the plugin</h3>
<ul>
<li>Install and activate this plugin in your environment</li>
<li>Create application password for a user with administrator role</li>
</ul>
<p>After above steps have been made, make a request to a page with added <a href="https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side" rel="nofollow ugc">Authorization header</a>. See data fetching examples at the end of this documentation for more help</p>
<h3>Modifying the output</h3>
<p>Plugin outputs current page’s Post object or null. This can be modified using <code>headless-converter-modify-data</code>-filter. You can either modify passed in post object or do your own logic like in the example below.</p>
<pre><code>/**
 * Modifies Headless Converter plugin's output.
 * 
 * @param WPPost|null $post - Current template's post object 
 */
function modify_headless_converter_output($post) {
  if(is_404()) {
    return "this block renders 404 page content";
  } else if(is_page()) {
    return "this block renders page post types content";
  } else if (is_singular('post')) {
    return "this block renders single post content";
  } else if(is_home()) {
    return "this block renders post archive";
  } else {
    return $post;
  }
}

add_filter('headless-converter-modify-data', 'modify_headless_converter_output');
</code></pre>
<h3>Data fetching examples</h3>
<h4>Fetch</h4>
<pre><code>const username = "admin"
const password = "1111 1111 1111 1111 1111"
const url = "http://localhost:3000/?page_id=2"
const opts = {
  headers: {
     'Authorization': 'Basic ' + btoa(username + ":" + password) 
  }, 
}
fetch(url, opts).then(r => r.json()).then(console.log)
</code></pre>
<h4>Axios</h4>
<pre><code>const axios = require("axios")

const username = "admin"
const password = "1111 1111 1111 1111 1111"
const url = "http://localhost:3000/?page_id=2"
const opts = {
  auth: {
    username,
    password
  }
}

axios(url, opts).then(r => r.data).then(console.log)
</code></pre>


Headless Converter

Converts frontend to JSON response when request is done with certain conditions.

danielauener

<p>This plugin adds a couple of extensions to the WordPress Rest API, which are aimed to make the use of WordPress as headless CMS easier.<br />
It is originally coded for <a href="https://github.com/northosts/wuxt" rel="nofollow ugc">WUXT</a>, a dockerized development environment for headless WordPress combined with NuxtJs. However, it can be used by every other application, which needs a powerful headless WordPress back-end.</p>
<h3>WordPress API Extensions</h3>
<ul>
<li><strong>Frontpage endpoint</strong>: There is no obvious way to get the WordPress front-page via the Rest API. To read the settings, you have to be authorized, which makes things unnecessary complicated. The new endpoint returns the front-page object if it is set, the ten newest posts otherwise.</li>
<li><strong>Menu endpoint</strong>: Right now, there is no way I know of, for getting menus from the API. This endpoint returns an entire menu as nested array. Default location is “main”, but you can request other locations.</li>
<li><strong>Slug endpoint</strong>: If you are building a front-end app on top of WordPress, you have to think about how to structure your urls. WordPress has two default post-types (posts & pages) and in the urls is not distinguished which type you are requesting, so http://wp-site.expl/something might lead to a page or a post, dependent on the type of the object with the slug something. If you want to mirror that behaviour in your app, you have to do two requests for each url, one searching pages, one searching posts. To make that one request, use the slug end-point.</li>
<li><strong>Taxonomy filter AND extension</strong>: When filtering taxonomies with an Rest API request, all queries are OR-queries. That means you can get posts which are either in category A or B. Our adjustment lets you switch all tax_queries to an AND-relation, so that you can select posts which are both in category A and B.</li>
<li><strong>Geo query</strong>: If your application has to get posts by geographical proximity, you can use a geo query.</li>
<li><strong>WordPress SEO meta fields</strong>: They are included automatically in the <code>meta</code> object if the Yoast WordPress SEO plugin is activated.</li>
<li><strong>Advanced custom fields</strong> are included automatically in the <code>meta</code> object if the plugin is activated.</li>
</ul>
<h3>Endpoints and parameters</h3>
<p><strong>Frontpage</strong></p>
<ul>
<li><code>GET</code> <code>/wp-json/wuxt/v1/front-page</code></li>
<li><code>GET</code> <code>/wp-json/wuxt/v1/front-page?_embed</code></li>
</ul>
<p><strong>Menu</strong></p>
<ul>
<li><code>GET</code> <code>/wp-json/wuxt/v1/menu</code></li>
<li><code>GET</code> <code>/wp-json/wuxt/v1/menu?location=<location></code></li>
</ul>
<p><strong>Slug</strong></p>
<ul>
<li><code>GET</code> <code>/wp-json/wuxt/v1/slug/<post-or-page-slug></code></li>
<li><code>GET</code> <code>/wp-json/wuxt/v1/slug/<post-or-page-slug>?_embed</code></li>
</ul>
<p><strong>Taxonomy filter AND extension</strong></p>
<ul>
<li><code>GET</code> <code>/wp-json/wp/v2/posts/?categories=1,2&and=true</code></li>
</ul>
<p><strong>GEO query</strong></p>
<ul>
<li><code>GET</code> <code>/wp-json/wp/v2/posts/?coordinates=<lat>,<lng>&distance=<distance><km|m></code></li>
<li><code>GET</code> <code>/wp-json/wp/v2/posts/?coordinates=<lat_meta_field>:<lat>,<lng_meta_field>:<lng>&distance=<distance><km|m></code></li>
<li><code>GET</code> <code>/wp-json/wp/v2/posts/?coordinates=52.585,13.373&distance=10</code></li>
<li><code>GET</code> <code>/wp-json/wp/v2/posts/?coordinates=lat_mkey:52.585,lng_mkey:13.373&distance=10</code></li>
<li><code>GET</code> <code>/wp-json/wp/v2/posts/?coordinates=52.585,13.373&distance=10m</code></li>
</ul>
<h3>Links</h3>
<ul>
<li><a href="https://www.danielauener.com/wordpress-rest-api-extensions-for-going-headless-wp/" rel="nofollow ugc">More detailed end-point description</a></li>
<li><a href="https://github.com/northosts/wuxt" rel="nofollow ugc">WUXT</a></li>
<li><a href="https://www.danielauener.com/nuxt-js-wordpress-wuxt/" rel="nofollow ugc">WUXT release blog post</a></li>
<li><a href="https://nuxtjs.org/" rel="nofollow ugc">NuxtJs</a></li>
</ul>
<h3>Credits</h3>
<ul>
<li>Michael Cox <a href="https://gist.github.com/michaeland/191ce08d22fed74da05a" rel="nofollow ugc">Menu Class for returning a menu as array</a></li>
</ul>


WUXT Headless WordPress API Extensions

Extensions for the Rest API to provide endpoints that support a more convenient use of headless WordPress as back-end CMS.

Headless Converter vs WUXT Headless WordPress API Extensions