-
Notifications
You must be signed in to change notification settings - Fork 2
docs: Next.js WP Theme rendered blocks #115
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 12 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
a496e09
Adds WP plugin example for the stylesheet exposure.
whoami-pwd 4d3c0a5
Provides CLI command.
whoami-pwd 9951d2c
Updates readme.
whoami-pwd c6d504e
Reverts pnpm-lock.yaml changes.
whoami-pwd e62df79
Updates JS example.
whoami-pwd 671d3ba
Moves the plugin to the example folder.
whoami-pwd ac1d7b4
Merge branch 'main' into example-wp-theme-rendered-blocks
whoami-pwd 72324e6
Fixes lock typo.
whoami-pwd 7b73aa3
Moves plugin to the separate example folder.
whoami-pwd add904e
Restores original versions of the example.
whoami-pwd b40ab65
Provides example files.
whoami-pwd 0760b8e
Resets files
whoami-pwd 7b62e79
Provides the wp-env configuration.
whoami-pwd 644ceba
Provides the wp-env configuration.
whoami-pwd 71abfa9
Updates the README.md.
whoami-pwd c07baf2
Apply suggestions from code review
ahuseyn e54bb4d
fix: pnpm to npm
ahuseyn 3310fc5
fix: fetchWpGlobalStyles cjs to esm
ahuseyn e2bc7ee
docs: minor fixes
ahuseyn File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
/.pnp | ||
.pnp.* | ||
.yarn/* | ||
!.yarn/patches | ||
!.yarn/plugins | ||
!.yarn/releases | ||
!.yarn/versions | ||
|
||
# testing | ||
/coverage | ||
|
||
# next.js | ||
/.next/ | ||
/out/ | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
*.pem | ||
|
||
# debug | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
.pnpm-debug.log* | ||
|
||
# env files (can opt-in for committing if needed) | ||
.env* | ||
|
||
# vercel | ||
.vercel | ||
|
||
# typescript | ||
*.tsbuildinfo | ||
next-env.d.ts |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
lts/* |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
# Example: WordPress Global Styles in Next.js | ||
|
||
This example demonstrates how to **fetch and apply WordPress Global Styles** in a Next.js project using the `globalStylesheet` GraphQL field. These styles reflect your active theme’s typography, spacing, colors, and layout rules — ensuring that your frontend matches the WordPress editor and theme design. | ||
|
||
This pattern is especially helpful for users migrating from **Faust.js**, where similar global styles were automatically applied using utilities like `getGlobalStyles`. | ||
|
||
--- | ||
|
||
## How it works | ||
|
||
- A script (`scripts/fetchWpGlobalStyles.js`) queries your WordPress site's GraphQL API for global styles. | ||
- The styles are saved to `styles/hwp-global-styles.css`. | ||
- The file is imported directly in your app and bundled at build time. | ||
|
||
This ensures that all block-rendered content in your app inherits the same styling as it would inside the WordPress editor. | ||
|
||
--- | ||
|
||
## Example usage | ||
|
||
In `scripts/fetchWpGlobalStyles.js`, you define the fetch: | ||
|
||
```js | ||
fetchWpGlobalStyles( | ||
'https://your-wp-site.com/graphql', // WordPress GraphQL endpoint | ||
'styles/hwp-global-styles.css', // Output path | ||
['variables', 'presets', 'styles', 'base-layout-styles'] // Style types to include | ||
); | ||
``` | ||
|
||
In your `pages/_app.js`, you include the styles: | ||
|
||
```javascript | ||
import '@wordpress/base-styles'; // WordPress foundational styles | ||
import '@/styles/hwp-global-styles.css'; // Theme styles fetched from WP | ||
import '@/styles/globals.css'; // Optional custom app styles | ||
``` | ||
|
||
## Project structure | ||
|
||
``` | ||
/ | ||
├── hwp-global-stylesheet/* # WordPress Plugin. | ||
├── pages/ | ||
│ ├── _app.js # Includes global styles. | ||
│ └── index.js # Basic page. | ||
├── styles/ | ||
│ ├── hwp-global-styles.css # Output of the fetch script. | ||
│ └── globals.css # Your optional global app styles. | ||
├── package.json # Project dependencies and scripts. | ||
``` | ||
|
||
## Installation and Setup | ||
|
||
### Prerequisites | ||
|
||
1. Node.js 18.18 or later | ||
2. npm or another package manager | ||
3. WPGraphql | ||
4. HWP Global Stylesheet Plugin | ||
|
||
ahuseyn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
### Clone the repository | ||
|
||
```bash | ||
git clone https://github.com/wpengine/hwptoolkit.git | ||
cd examples/next/render-blocks-pages-router | ||
ahuseyn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
### Install dependencies | ||
|
||
```bash | ||
npm install | ||
ahuseyn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
### Start the development server | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
http://localhost:3000/ should render the blocks as shown below. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
import { FlatCompat } from "@eslint/eslintrc"; | ||
import js from "@eslint/js"; | ||
import { dirname } from "path"; | ||
import { fileURLToPath } from "url"; | ||
|
||
const __filename = fileURLToPath(import.meta.url); | ||
const __dirname = dirname(__filename); | ||
|
||
const compat = new FlatCompat({ | ||
baseDirectory: __dirname, | ||
recommendedConfig: js.configs.recommended, | ||
}); | ||
|
||
const eslintConfig = [ | ||
...compat.config({ | ||
extends: ["eslint:recommended", "next/core-web-vitals"], | ||
}), | ||
]; | ||
|
||
export default eslintConfig; |
Binary file not shown.
127 changes: 127 additions & 0 deletions
127
examples/next/wp-theme-rendered-blocks/hwp-global-stylesheet/hwp-global-stylesheet.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
<?php | ||
/** | ||
* Plugin Name: HWP Global Stylesheet | ||
* Description: Exposes WordPress global stylesheets through WPGraphQL | ||
* Version: 1.0.0 | ||
* Author: WP Engine | ||
* Text Domain: hwp-global-stylesheet | ||
* Domain Path: /languages | ||
* | ||
* @package WPGlobalStylesheet | ||
*/ | ||
|
||
// Exit if accessed directly. | ||
if ( ! defined( 'ABSPATH' ) ) { | ||
exit; | ||
} | ||
|
||
/** | ||
* Class WP_Global_Stylesheet | ||
*/ | ||
class WP_Global_Stylesheet { | ||
|
||
/** | ||
* Instance of this class. | ||
* | ||
* @var WP_Global_Stylesheet | ||
*/ | ||
private static $instance = null; | ||
|
||
/** | ||
* Get an instance of this class. | ||
* | ||
* @return WP_Global_Stylesheet | ||
*/ | ||
public static function get_instance() { | ||
if ( null === self::$instance ) { | ||
self::$instance = new self(); | ||
} | ||
return self::$instance; | ||
} | ||
|
||
/** | ||
* Initialize the plugin. | ||
*/ | ||
private function __construct() { | ||
// Check if WPGraphQL is active | ||
if ( class_exists( 'WPGraphQL' ) ) { | ||
add_action( 'graphql_register_types', [ $this, 'register_global_stylesheet_field' ] ); | ||
return; | ||
} | ||
|
||
// Add admin notice if WPGraphQL is not active | ||
add_action( 'admin_notices', [ $this, 'wpgraphql_missing_notice' ] ); | ||
} | ||
|
||
/** | ||
* Admin notice for missing WPGraphQL dependency. | ||
*/ | ||
public function wpgraphql_missing_notice() { | ||
if ( current_user_can( 'activate_plugins' ) ) { | ||
?> | ||
<div class="notice notice-error"> | ||
<p><?php esc_html_e( 'WP Global Stylesheet requires WPGraphQL plugin to be installed and activated.', 'hwp-global-stylesheet' ); ?></p> | ||
</div> | ||
<?php | ||
} | ||
} | ||
|
||
/** | ||
* Registers a field on the RootQuery called "globalStylesheet" which | ||
* returns the stylesheet resulting of merging core, theme, and user data. | ||
* | ||
* @return void | ||
*/ | ||
public function register_global_stylesheet_field() { | ||
register_graphql_enum_type( | ||
'GlobalStylesheetTypesEnum', | ||
[ | ||
'description' => __( 'Types of styles to load', 'hwp-global-stylesheet' ), | ||
'values' => [ | ||
'VARIABLES' => [ | ||
'value' => 'variables', | ||
], | ||
'PRESETS' => [ | ||
'value' => 'presets', | ||
], | ||
'STYLES' => [ | ||
'value' => 'styles', | ||
], | ||
'BASE_LAYOUT_STYLES' => [ | ||
'value' => 'base-layout-styles', | ||
], | ||
], | ||
] | ||
); | ||
|
||
register_graphql_field( | ||
'RootQuery', | ||
'globalStylesheet', | ||
[ | ||
'type' => 'String', | ||
'args' => [ | ||
'types' => [ | ||
'type' => [ 'list_of' => 'GlobalStylesheetTypesEnum' ], | ||
'description' => __( 'Types of styles to load.', 'hwp-global-stylesheet' ), | ||
], | ||
], | ||
'description' => __( 'Returns the stylesheet resulting of merging core, theme, and user data.', 'hwp-global-stylesheet' ), | ||
'resolve' => function( $root, $args, $context, $info ) { | ||
$types = $args['types'] ?? null; | ||
|
||
// Check if wp_get_global_stylesheet function exists (WordPress 5.9+) | ||
if ( function_exists( 'wp_get_global_stylesheet' ) ) { | ||
return wp_get_global_stylesheet( $types ); | ||
} else { | ||
return '/* wp_get_global_stylesheet function is not available. Your WordPress version might be too old. */'; | ||
} | ||
}, | ||
] | ||
); | ||
} | ||
} | ||
|
||
// Initialize the plugin | ||
add_action( 'plugins_loaded', function() { | ||
WP_Global_Stylesheet::get_instance(); | ||
}); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"compilerOptions": { | ||
"paths": { | ||
"@/*": ["./src/*"] | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/** @type {import('next').NextConfig} */ | ||
const nextConfig = { | ||
reactStrictMode: true, | ||
}; | ||
|
||
export default nextConfig; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.