Reyes Martínez

Mario Santos

orballo

Pablo Postigo

davidarenas

luisherranz

frontity

<p>This plugin adds all the tags in the head section of a website to WordPress REST API responses.</p>
<p>It is perfect if you are using WordPress for a headless set-up and would like to add the <strong>meta tags</strong> generated by your <strong>WordPress SEO plugin</strong> (like Yoast SEO or All-in-One SEO Pack) to the WordPress REST API output.</p>
<h4>Requirements</h4>
<p>This package depends on the <a href="https://www.php.net/manual/en/book.dom.php" rel="nofollow ugc">PHP DOM library</a>. Most PHP environments have it by default so you don’t have to worry about that.</p>
<blockquote>
<p>In case you get some errors regarding this dependency make sure you have this library installed (you can take a look at this <a href="https://github.com/frontity/wp-plugins/issues/35" rel="nofollow ugc">thread</a> in the code repository).</p>
</blockquote>
<h4>Compatibility</h4>
<p>This plugin is compatible and works out of the box with some of the most popular WordPress SEO plugins. These are the ones that we tested:</p>
<ul>
<li><strong><a href="https://wordpress.org/plugins/wordpress-seo/" rel="ugc">Yoast SEO</a> – (up to 13.5)</strong></li>
<li><strong><a href="https://wordpress.org/plugins/all-in-one-seo-pack/" rel="ugc">All in One SEO Pack</a> – (up to 3.4.2)</strong></li>
<li><strong><a href="https://github.com/alleyinteractive/wp-seo" rel="nofollow ugc">WP SEO</a> –</strong></li>
</ul>
<p>Are you using a different SEO plugin and want to know if it’s compatible? Feel free to ask in our <a href="https://community.frontity.org/?utm_source=plugin-repository&utm_medium=readme&utm_campaign=rest-api-head-tags-plugin" rel="nofollow ugc">community forum</a>. If you tested any other plugin, please let us know as well so we can update the list.</p>
<h3>How to use this plugin</h3>
<h4>Entities with head tags</h4>
<p>The plugin has been developed to include the head_tags field to the REST API response of most of the WordPress core entities:</p>
<ul>
<li>Posts, pages, attachments and custom post types.</li>
<li>Post types: for archive pages.</li>
<li>Categories, tags and custom taxonomies.</li>
<li>Authors.</li>
</ul>
<h4>In a Frontity project</h4>
<p>If you are using <a href="https://frontity.org?utm_source=plugin-repository&utm_medium=readme&utm_campaign=rest-api-head-tags-plugin" rel="nofollow ugc">Frontity</a>, you just have to install the <a href="https://docs.frontity.org/api-reference-1/frontity-head-tags?utm_source=plugin-repository&utm_medium=readme&utm_campaign=rest-api-head-tags-plugin" rel="nofollow ugc">@frontity/head-tags package</a> and <strong>it will work automatically</strong>.</p>
<h4> In a different project</h4>
<p>You need to understand better how it works and <strong>add the data manually</strong>.</p>
<p><strong><em>How to fetch the head_tags field manually</em></strong></p>
<p>You have to get each entity from its respective REST API endpoint. For example: for fetching the posts, you should go to <code>/wp-json/wp/v2/posts&id=123</code> endpoint; for fetching the categories, you have to go to <code>wp-json/wp/v2/categories&id=123</code>, and for custom post types or custom taxonomies, it would be a different url in each case.</p>
<p>In the case of the homepage, it’s less intuitive and you should go to <code>/wp-json/wp/v2/types/post</code>. As previously said, each entity has a different endpoint so if you aren’t familiar with this, you should check out the <a href="https://developer.wordpress.org/rest-api/reference/" rel="nofollow ugc">WordPress REST API reference</a> for more information.</p>
<p>Inside each endpoint, it will be a new field named <em>head_tags</em>, which will be an array of objects representing the tags that WordPress would normally include inside the html head element. These objects have the properties <code>tag</code>, <code>attributes</code> and <code>content</code>.</p>
<p>For example for these HTML tags:</p>
<pre><code><title>Hello wordl! - My Site</title>
<meta name="robots" content="max-snippet:-1, max-image-preview:large, max-video-preview:-1">
<link rel="canonical" href="<https://test.frontity.org/>" />
</code></pre>
<p>This would be the content of the head_tags field:</p>
<pre><code>"head_tags": [
  {
    "tag": "title",
    "content": "Hello world! - My Site"
  },
  {
    "tag": "meta",
    "attributes": {
      "name": "robots",
      "content": "max-snippet:-1, max-image-preview:large, max-video-preview:-1"
    }
  },
  {
    "tag": "link",
    "attributes": {
      "rel": "canonical",
      "href": "<https://test.frontity.org/>"
    }
  }
]
</code></pre>
<h3>Settings</h3>
<p>The settings of this plugin are really simple.</p>
<h4>Purge cache</h4>
<p>In order to not affect the performance of your site, the head_tags field is cached for all your responses. Each time you update a post/page/cpt or a taxonomy, the cache for that entity will be purged automatically. In case you make global changes (i.e. your permalinks or your global Yoast settings) use the Purge button to clean the whole cache.</p>
<h4> Enable output</h4>
<p>By default, the head_tags field is included in the common endpoint of each entity. You can configure it so it doesn’t appear by default and to be shown when you include the head_tags=true query.</p>
<p>For example, with the output disabled, https://test.frontity.org/wp-json/wp/v2/posts won’t show the head_tags field unless you have the query <code>?head_tags=true</code> at the end.</p>
<h4>Skip cache</h4>
<p>In case you want to skip the cache, you can do so by adding to the query the  parameter <code>skip_cache</code>.</p>
<p>There are some cache plugins for the REST API which also use the same parameter. In case you want to ignore the cache for the REST API call but not for the head tags, you can use <code>skip_cache&head_tags_skip_cache=false</code>.</p>
<h3>Problems and Questions</h3>
<p>If you have any trouble with the REST API – Head Tags, you can check out <a href="https://docs.frontity.org/frontity-plugins/rest-api-head-tags?utm_source=plugin-repository&utm_medium=readme&utm_campaign=rest-api-head-tags-plugin" rel="nofollow ugc">our docs</a> or join our <a href="https://community.frontity.org/?utm_source=plugin-repository&utm_medium=readme&utm_campaign=rest-api-head-tags-plugin" rel="nofollow ugc">community forum</a> and let us know. We’ll be happy to help!</p>
<p>Bug reports for REST API – Head Tags plugin are welcomed in <a href="https://github.com/frontity/wp-plugins" rel="nofollow ugc">our repository</a> on GitHub. Before opening an issue, please be sure to review the <a href="https://github.com/frontity/frontity/blob/dev/CONTRIBUTING.md" rel="nofollow ugc">contributing guidelines</a>.</p>
<h3>More Information</h3>
<ul>
<li><a href="https://docs.frontity.org/#what-is-frontity?utm_source=plugin-repository&utm_medium=readme&utm_campaign=rest-api-head-tags-plugin" rel="nofollow ugc">About Frontity Framework</a></li>
<li><a href="https://blog.frontity.org/seo-for-headless-wordpress-themes/?utm_source=plugin-repository&utm_medium=readme&utm_campaign=rest-api-head-tags-plugin" rel="nofollow ugc">Guide on SEO for Headless WordPress Themes</a></li>
<li>Follow Frontity on <a href="https://twitter.com/frontity" rel="nofollow ugc">Twitter</a> and <a href="https://github.com/frontity/frontity" rel="nofollow ugc">GitHub</a></li>
<li>Get help on the <a href="https://community.frontity.org/?utm_source=plugin-repository&utm_medium=readme&utm_campaign=rest-api-head-tags-plugin" rel="nofollow ugc">Frontity Community Forum</a></li>
</ul>


REST API – Head Tags

I have just used this in my local at moment, but planning to launch website soon with this plugin

frontity is future of wordpress, would like to learn more and create custom plugin and theme in frontity 

Kudos to team

This is future of Wordpress

Adds all the meta tags of the head section to WordPress REST API responses, including the ones generated by SEO plugins like Yoast or All in One SEO.

ChazUK

<p>Returns Yoast post or page metadata in a normal post or page request. Stores the metadata in the yoast_meta field of the returned data.</p>


WP API Yoast SEO

Returns Yoast post or page metadata in a normal post or page request.

REST API – Head Tags vs WP API Yoast SEO