WP GraphQL Meta

Adds meta data registered via register_meta() to the GraphQL output.

by Robert O'Rourke · github.com/roborourke/wp-graphql-meta

★ 21stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/roborourke/wp-graphql-meta/archive/refs/heads/master.zip

No built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.

Readme github.com/roborourke/wp-graphql-meta ↗

This plugin is an add-on for the awesome WP GraphQL

It builds on top of both WP GraphQL and the REST API. Any meta data you register using register_meta() will be available to retrieve in your results. You get your data in the REST API and GraphQL at the same time.

Installing

Make sure that WP GraphQL is installed and activated first.
Upload this repo (or git clone) to your plugins folder and activate it.

Usage

Your theme or other plugins may use meta data to add custom functionality. That data or functionality can be beneficial / required for a front end or other app that consumes your API.

register_meta( 'post', 'custom-key', array(
    'type' => 'string', // number, boolean, integer or a type from WPGraphQL\Types
    'description' => 'My custom field',
    'single' => true,   // Whether to make this require a list or not.
    'show_in_rest' => true, // Required to make this field public.
) );

NOTE: If you use WPGraphQL\Types instance the built in REST API will ignore the field.