README

A Wordpress wrapper to expose Carbon Fields to WpGraphQL queries.

Important

This is just the first version. There is a lot of work to be done. This packages exposes all the fields of the container, if the container type is post_meta, term_meta, user_meta, comment_meta or theme_options.

Note: This is a very experimental version, so it is probably shipped with bugs.

Usage

1. First you have to install Carbon Fields and WpGraphQL.
2. Then install this package via packagist: composer require matepaiva/wp-graphql-crb
3. Wrap every Carbon Field container that you want to expose via GraphQL with the static method WpGraphQLCrb\Container::register. For example:

  <?php

  use WpGraphQLCrb\Container as WpGraphQLCrbContainer;
  use Carbon_Fields\Container\Container;
  use Carbon_Fields\Field\Field;

  WpGraphQLCrbContainer::register(
    Container::make('term_meta', __('Custom Data', 'app'))
      ->where('term_taxonomy', '=', 'category')
      ->add_fields([
        Field::make('image', 'crb_img')
          ->set_value_type('url')
      ])
  );

1. Now the query below will work:

{
  categories {
    edges {
      node {
        id
        crb_img
      }
    }
  }
}

About Theme Options

Theme options are not part of any structure already known by Wordpress, so it has its own root. Every theme_options fields will be displayed in GraphQL as direct children of crb_ThemeOptions. Be carefull about name collision.