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.

Jason Bahl

<p>WPGraphQL for Advanced Custom Fields is a free, open-source WordPress plugin that adds ACF Fields and Field Groups to the WPGraphQL Schema.</p>
<h4>Create ACF Field Groups</h4>
<p>Create ACF Field Groups and Fields using the ACF User Interface, register them with PHP, or leverage ACF local JSON. Each field group and the fields within it can be configured to “Show in GraphQL.”</p>
<h4>Query your fields with GraphQL</h4>
<p>Once your field groups and fields are configured to “Show in GraphQL,” they become available in the GraphQL Schema for querying.</p>
<h4>Supported Field Types</h4>
<p>WPGraphQL for ACF provides support for most built-in field types of ACF (free & PRO) and extends support to most field types from ACF Extended (free & PRO).</p>
<h3>Updating</h3>
<p>If you are updating from WPGraphQL for ACF v0.6.* or older, check out the <a href="https://acf.wpgraphql.com/upgrade-guide" rel="nofollow ugc">Upgrade Guide</a></p>
<p>For non-major version updates, automatic updates usually should work smoothly, but we still recommend you back up your site and test on a staging site.</p>
<p>Before updating WPGraphQL for ACF, review the release notes on <a href="https://github.com/wp-graphql/wpgraphql-acf/releases" rel="nofollow ugc">GitHub</a>.</p>
<p>We follow Semantic Versioning (Semver) for meaningful releases:</p>
<ul>
<li><em>MAJOR</em> version for incompatible API changes,</li>
<li><em>MINOR</em> version for backwards-compatible functionality additions,</li>
<li><em>PATCH</em> version for backwards-compatible bug fixes.</li>
</ul>
<p>Learn more about Semver at <a href="https://semver.org" rel="nofollow ugc">semver.org</a>.</p>
<h3>Support</h3>
<ul>
<li><a href="https://github.com/wp-graphql/wp-graphql/discussions" rel="nofollow ugc">General Help Requests</a>: For general questions and help requests, create a new topic in Github Discussions</li>
<li><a href="https://join.slack.com/t/wp-graphql/shared_invite/zt-3vloo60z-PpJV2PFIwEathWDOxCTTLA" rel="nofollow ugc">Slack Community</a>: The WPGraphQL Slack is a great place to communicate in real-time. Ask questions, discuss features, get to know other folks using WPGraphQL.</li>
<li><a href="https://github.com/wp-graphql/wp-graphql/issues/new?assignees=&labels=&projects=&template=bug_report.yml" rel="nofollow ugc">Bug Reports</a>: Report a bug in WPGraphQL</li>
<li><a href="https://github.com/wp-graphql/wp-graphql/issues/new?assignees=&labels=&projects=&template=feature_request.yml" rel="nofollow ugc">Feature Requests</a>: Suggest an idea, feature, or enhancement for WPGraphQL.</li>
<li><a href="https://github.com/wp-graphql/wp-graphql/security/advisories/new" rel="nofollow ugc">Report a Security Vulnerability</a>: Report a security vulnerability.</li>
</ul>
<h3>FAQs</h3>
<p><strong>Does this work with ACF Extended?</strong></p>
<p>Yes! WPGraphQL for ACF allows you to query for (most) fields created with ACF Extended.</p>
<p><strong>Can I filter and sort queries by ACF Fields using WPGraphQL for ACF?</strong></p>
<p>At this time WPGraphQL for ACF does not support filtering or sorting queries by ACF Fields. “Meta Queries” are often very expensive to execute, so we currently do not support filtering by ACF fields out of the box, but are exploring options for supporting it without the performance penalty.</p>
<p><strong>I think I found a bug, where do I report it?</strong></p>
<p>If you think you found a bug, please open an issue on <a href="https://github.com/wp-graphql/wpgraphql-acf" rel="nofollow ugc">GitHub</a>. The more details you provide in the issue, and the more clear your steps to reproduce are, the higher chances we will be able to help.</p>
<p><strong>Can I use ACF Free or Pro with WPGraphQL for ACF?</strong></p>
<p>Yes! WPGraphQL for ACF works great with ACF Free and Pro. The Pro version of ACF has some additional features, such as Flexible Content Fields, Repeater Fields and Options Pages that are supported by WPGraphQL for ACF.</p>
<p><strong>Do I have to use Faust.js to use WPGraphQL for ACF?</strong></p>
<p>No! While <a href="https://www.wpgraphql.com" rel="nofollow ugc">wpgraphql.com</a> and <a href="https://acf.wpgraphql.com" rel="nofollow ugc">acf.wpgraphql.com</a> are built using <a href="https://faustjs.org/" rel="nofollow ugc">Faust.js</a> and Next.js, you can use WPGraphQL for ACF with any GraphQL client, including Apollo, Relay, Urql, etc.</p>
<p><strong>I have an ACF Extension that adds a new field type, will it work with WPGraphQL for ACF?</strong></p>
<p>WPGraphQL for ACF supports the field types that come with ACF (Free and PRO) as well as the field types in ACF Extended (Free and PRO). Support for additional field types can be added by using the “register_graphql_acf_field_type” API.</p>
<p><strong>Do I need WPGraphQL and ACF to be active to use this?</strong></p>
<p>This plugin is a “bridge” plugin that brings functionality of ACF to WPGraphQL. Both WPGraphQL and ACF need to be installed and active in your WordPress installation for this plugin to work.</p>
<p><strong>How much does WPGraphQL for ACF cost?</strong></p>
<p>WPGraphQL for ACF is a FREE open-source plugin. The development is sponsored by <a href="https://wpengine.com/atlas" rel="nofollow ugc">WP Engine Atlas</a>.</p>
<p><strong>Does WPGraphQL for ACF support GraphQL Mutations?</strong></p>
<p>GraphQL Mutations are not yet supported. We are working on adding support for Mutations in the future. We are waiting for the GraphQL “@oneOf” directive to be merged into the GraphQL spec before we add support for Mutations.</p>
<p><strong>Does this work with Field Groups registered in PHP or JSON?</strong></p>
<p>Yes! You can register ACF Field Groups and Fields using the Admin UI, PHP or JSON. WPGraphQL for ACF will detect the Field Groups and Fields and add them to the GraphQL Schema. If using PHP or JSON, you will need to set the “show_in_graphql” setting to “true” to expose the Field Group and Fields to the GraphQL Schema. There might be other settings that need attention at the field group or field level that might impact the schema or field resolution.</p>
<h3>Privacy Policy</h3>
<p>WPGraphQL for Advanced Custom Fields uses <a href="https://appsero.com" rel="nofollow ugc">Appsero</a> SDK to collect telemetry data upon user confirmation, helping us troubleshoot problems and improve the product.</p>
<p>The Appsero SDK <strong>doesn’t collect data by default</strong> and only starts gathering basic telemetry data when a user allows it via the admin notice. No data is collected without user consent.</p>
<p>Learn more about how <a href="https://appsero.com/privacy-policy/" rel="nofollow ugc">Appsero collects and uses data</a>.</p>


WPGraphQL for ACF

WPGraphQL for ACF seamlessly integrates Advanced Custom Fields with WPGraphQL.

Headless Converter vs WPGraphQL for ACF