dynamic-node-source-wordpress

0.4.2 • Public • Published

@gridsome/source-wordpress

WordPress source for Gridsome. This package is under development and API might change before v1 is released.

This is a customised unmaintained version of the original source-wordpress package and it may be out of date! Use at own discretion.

It adds additional settings and allows you to create references to Nodes of custom fields and custom post types.

Install

  • yarn add @gridsome/source-wordpress
  • npm install @gridsome/source-wordpress

Usage

module.exports = {
  plugins: [
    {
      use: '@gridsome/source-wordpress',
      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

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 );

Package Sidebar

Install

npm i dynamic-node-source-wordpress

Weekly Downloads

1

Version

0.4.2

License

none

Unpacked Size

14.9 kB

Total Files

4

Last publish

Collaborators

  • primozb