Skip to content

An experimental plugin to preview and insert block patterns in WordPress.

License

Notifications You must be signed in to change notification settings

wpengine/block-pattern-explorer

Repository files navigation

Block Pattern Explorer

License

Block Pattern Explorer

The Block Pattern Explorer is an experimental WordPress plugin based heavily on the work currently being done in Gutenberg.

The purpose of this project is to isolate the pattern explorer into a standalone plugin that WordPress users/developers can interact with immediately, provide feedback on, and begin implementing into their own websites. Ideally, this initiative will also help inform the direction of core development.

Once the pattern explorer is fully integrated into WordPress proper, this project will be sunsetted in favor of the core offering. Below is a list of current pull requests that are related to the Block Pattern Explorer in Gutenberg.

Requirements

  • WordPress 5.8+
  • Gutenberg plugin (Not required if using WordPress 5.9+)
  • PHP 7.1+

Development

  1. Set up a local WordPress development environment, we recommend using Local.
  2. Clone / download this repository into the wp-content/plugins folder.
  3. Navigate to the wp-content/plugins/block-pattern-explorer folder in the command line.
  4. Run npm install to install the plugin's dependencies within a /node_modules/ folder.
  5. Run composer install to install the additional WordPress composer tools within a /vendor/ folder.
  6. Run npm run start to compile and watch source files for changes while developing.

Refer to package.json and composer.json for additional commands.