https://github.com/travis-r6s/gridsome-source-wordpress

Forked version, with updated dependencies.
https://github.com/travis-r6s/gridsome-source-wordpress

Last synced: 26 days ago
JSON representation

Forked version, with updated dependencies.

• Host: GitHub
• URL: https://github.com/travis-r6s/gridsome-source-wordpress
• Owner: travis-r6s
• Created: 2021-02-24T16:35:26.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-10-19T16:04:20.000Z (over 3 years ago)
• Last Synced: 2024-10-10T14:46:55.214Z (4 months ago)
• Language: TypeScript
• Size: 202 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @travisreynolds/gridsome-source-wordpress

> WordPress source for Gridsome. This package is under development and

API might change before v1 is released.

## Install

- `yarn add @travisreynolds/gridsome-source-wordpress`

- `npm install @travisreynolds/gridsome-source-wordpress`

## Usage

```js

module.exports = {

  plugins: [

    {

      use: '@travisreynolds/gridsome-source-wordpress',

      options: {

        baseUrl: '', // required

        apiBase: 'wp-json',

        typeName: 'WordPress',

        images: true

      }

    }

  ],

  templates: {

    WordPressPost: '/:year/:month/:day/:slug'

  }

}

```

## Options

| Option | Explanation | Default |

|-|-|-|

| `baseUrl` | The base URL of your WordPress instance. This is required, and must include the protocol used. |  |

| `apiBase` | The API base for your WordPress instance - this may change if you are using wordpress.com for example. | `wp-json` |

| `typeName` | The base name used to prefix all created types. | `WordPress` |

| `hostingWPCOM` | Change this to `true` if your site is hosted on wordpress.com, and set `baseUrl` to your site name (e.g. `staticsitegeneration.wordpress.com`) | `false` |

| `perPage` | The amount of items that will be fetched per API call - minimum of 1, and maximum of 100. | `100` |

| `concurrent` | The amount of API calls that will run at once. | `8` |

| `images` | Whether to download images locally to be used with `g-image`. This can also be an object, with options to keep the original file path/name, cache images, and change the download folder. | `{ original: true, folder: '.images/wordpress', cache: true }` |

| `content` | Whether to transform content fields of posts, to update any internal links, and download any images in the post content. It can also be an object, with the option to set the fields to transform, or disable one of the two operations. | `{ links: ['content'], images: true }` |

## Use with Advanced Custom Fields

Install the [ACF to REST API](https://github.com/airesvsg/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.

```php

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.

```js

  use: '@gridsome/source-wordpress',

  options: {

    ... // other source-wordpress options

    customEndpoints: [

      {

        typeName: "Menu",

        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:

```js

  customEndpoints: [

    {

      typeName: "Posts",

      route: "/wp/v2/posts",

      normalize: true

    }

  ]

```

## Create Collections based on REST Endpoints

`customEndpoints` allow you to neatly create separate [Collections](https://gridsome.org/docs/collections/#collections) by querying different REST endpoints.

```js

  customEndpoints: [

    {

      typeName: "Collection1",

      route: "/wp/v2/posts?categories=",

      normalize: true

    },

    {

      typeName: "Collection2",

      route: "/wp/v2/posts?tags=",

      normalize: true

    }

  ]

```