DEV Community

Discussion on: An awesome list of WordPress-Gatsby resources.

Collapse
 
henrikwirth profile image
Henrik Wirth

By the way: The future of WordPress with Gatsby is discussed here in the following issue on GitHub.

WordPress source V4 & Theme Epic #19292

Intro

This epic is to track a new major version of gatsby-source-wordpress which is currently being worked on. This will be a ground-up rewrite using WPGraphQL instead of the REST API in order to enable better caching, previews, incremental builds, and an overall better developer experience.

How it will be done

The next major version of gatsby-source-wordpress is V4, and the release will coincide with the release of WPGraphQL V1. This project will inform some potential changes in WPGraphQL as a concrete example of a framework implementing many WordPress conventions and functionalities headlessly via WPGQL. There will also be a WPGatsby WordPress plugin that will modify the WPGQL schema when changes are Gatsby-specific, as well as add support for incremental builds and preview on the WP side.

Additionally, an opinionated theme, gatsby-theme-wordpress, will be built and it will compose a few new plugins together to implement many WordPress conventions and functionalities such as the template hierarchy, automatic routing (page creation using the WP permalink structure), ability to use the WP admin template selector, easy use of WP menus, and more.

Philosophy

We want to enable you to do what you're already doing with WordPress and more.

The intention behind the theme is to reduce friction as much as possible both for WordPress developers coming to Gatsby and for anyone else that's interested in using WP and Gatsby together for a wonderful and familiar admin experience. We want to lower the barrier of entry and make it as easy as possible for everyone to use Gatsby and React with WordPress. As a very large portion of the web is built on WordPress, our hope is that this will empower many more people to build React apps/sites and push the WordPress community and the internet as a whole forward.

The intention behind the source plugin is to create a scalable, cacheable integration with WordPress. It will support Gatsby cloud Preview and incremental builds and will generally be more efficient than current solutions and will have an improved DX.

Responsibilities

I will be leading the new source plugin and theme, and @jasonbahl will of course be leading WPGraphQL V1. The two of us will be leading the WPGatsby plugin together.

Github Project Links

Initial scope

This will likely change as things progress, but for now:

  • [ ] gatsby-source-wordpress@v4

    • [ ] Incremental builds support and aggressive cacheing
    • [ ] Preview support
    • [ ] GraphQL introspection and full data download
      • [ ] Fetch any types that are lists of nodes
      • [ ] Fetch specific types that are not lists of nodes (such as options)
    • [ ] Use schema customization to add types from WPGQL to Gatsby via introspection
    • [ ] Recursively process schema
      • [ ] Connections of the same type as one of our Gatsby nodes should be linked to Gatsby nodes instead of pulling queried data from WPGQL connections
      • [ ] Process lists of multiple types
    • [ ] Media items
      • [ ] Fetch all media posts
      • [ ] Fetch media files only when they’re queried for
      • [ ] Download and process all media files in html
    • [ ] Add request rate limiting controls
      • [ ] Make some importable defaults for “shared”, “vps”, “dedicated”, and “local”?
  • [ ] WPGatsby

    • [ ] Action monitor post type
      • [ ] a post is created for every content-related action performed in wp
      • [ ] recent actions are exposed to the WPGQL schema for cache invalidation and pulling new content in Gatsby
  • [ ] gatsby-theme-wordpress

    • [ ] gatsby-wordpress-permalink-structure
      • [ ] Get entire WordPress site structure and build pages using the path of each page or post
      • [ ] This needs to play nice with template sync and hierarchy
    • [ ] gatsby-wordpress-template-hierarchy
      • [ ] Needs to play nice with themes and shadowing gatsbyjs.org/blog/2018-11-11-intro... ← this is how it will
      • [ ] Replicate wphierarchy.com/ using folders instead of dashes for organization. For ex “archive-post.php” would become “templates/archive/post.js”
      • [ ] Only replicate a subset of the hierarchy for now (maybe parity later if needed?)
      • [ ] Fork github.com/pressupinc/wphierarchy and make it into a gatsby theme for documentation purposes
    • [ ] gatsby-wordpress-template-sync
      • [ ] Makes gql mutations sending available templates back to WP
      • [ ] Need to think about how this will work with multiple frontends (staging, production, local, etc)
    • [ ] gatsby-wordpress-menus

Not in scope now but may be implemented in the future

  • Bridge plugins
    • Yoast
    • Gravity forms
  • Ecommerce support
  • Multi-language support
Collapse
 
laxmariappan profile image
Lax Mariappan

Looking forward to WPGatsby :)