source-wordpress-flex

Forked source-wordpress plugin to support flexible contents with fragments

Install

• yarn add gridsome-wordpress-flex
• npm i gridsome-wordpress-flex

Usage

module.exports = {
  plugins: [
    {
      use: "gridsome-wordpress-flex",
      options: {
        baseUrl: "WEBSITE_URL", // required
        apiBase: "wp-json",
        typeName: "WordPress",
        perPage: 100,
        concurrent: 10,
      },
    },
  ],
  templates: {
    WordPressPost: "/:year/:month/:day/:slug",
  },
};

Use with Advanced Custom Fields

Install the ACF to REST API plugin to make ACF fields available in the GraphQL schema.

Tips

Aside components

With gridsome-wordpress-flex you can add FlexContent fields, but also, it handle an aside_components object if you need to put something aside your flex-content component. Name your field "aside_components" and give it a flex-content type.

Exclude unnecessary data from ACF fields

Gridsome needs the Return format set to Post Object for Post Object relations in order to resolve references automatically. But Gridsome only need the post_type and id to set up a working GraphQL reference. Use the filter below to exclude all other fields.

add_filter( 'acf/format_value', function ( $value ) {
  if ( $value instanceof WP_Post ) {
    return [
      'post_type' => $value->post_type,
      'id'        => $value->ID,
    ];
  }

  return $value;
}, 100 );

Use Custom REST Endpoints

To use REST endpoints from plugins or defined in your theme add a customEndpoints array to source-wordpress options.

  use: 'gridsome-wordpress-flex',
  options: {
    ... // other source-wordpress options
    customEndpoints: [
      {
        typeName: "WPMenu",
        route: 'myApi/v1/menus',
      }
    ]
  }

If you are trying to query posts, you will need to add the normalize: true option to make sure the data is properly added:

customEndpoints: [
  {
    typeName: "Posts",
    route: "/wp/v2/posts",
    normalize: true,
  },
];

Create Collections based on REST Endpoints

customEndpoints allow you to neatly create separate Collections by querying different REST endpoints.

customEndpoints: [
  {
    typeName: "Collection1",
    route: "/wp/v2/posts?categories=<category_id>",
    normalize: true,
  },
  {
    typeName: "Collection2",
    route: "/wp/v2/posts?tags=<tag_id>",
    normalize: true,
  },
];