WordPress Create Block Theme

https://github.com/wordpress/create-block-theme
Admin
A WordPress plugin that allows users to create and export block themes directly from the WordPress...
Tokens:4,081
Snippets:7
Trust Score:9
License:GPL-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Clone and Setup Create Block Theme Repository

Source: https://github.com/wordpress/create-block-theme/blob/trunk/CONTRIBUTING.md

Steps to clone the Create Block Theme repository from GitHub and set up the upstream remote for contributing. Requires Git and a GitHub account.

```bash
git clone https://github.com/YOUR_GITHUB_USERNAME/create-block-theme.git
cd create-block-theme
git remote add upstream https://github.com/WordPress/create-block-theme.git
```

--------------------------------

### Install Plugin Dependencies

Source: https://github.com/wordpress/create-block-theme/blob/trunk/CONTRIBUTING.md

Installs project dependencies using npm for JavaScript packages and Composer for PHP packages. These commands are typically run in a bash shell.

```bash
npm install
composer install
```

--------------------------------

### Build the Plugin

Source: https://github.com/wordpress/create-block-theme/blob/trunk/CONTRIBUTING.md

Compiles and builds the Create Block Theme plugin assets using npm scripts. This command is executed in a bash environment.

```bash
npm run build
```

--------------------------------

### Update Release Branch with Cherry-Picks

Source: https://github.com/wordpress/create-block-theme/blob/trunk/CONTRIBUTING.md

Keeps the Release PR branch current by incorporating specific commits from the main development branch ('trunk'). This is done using the `git cherry-pick` command.

```bash
git cherry-pick [commit-hash]
```

--------------------------------

### Initiate Release Workflow

Source: https://github.com/wordpress/create-block-theme/blob/trunk/CONTRIBUTING.md

Triggers the automated release process for Create Block Theme via GitHub Actions. Users select the release type (major, minor, patch) from the Actions tab.

```APIDOC
GitHub Actions Workflow: Create new release PR

URL: https://github.com/WordPress/create-block-theme/actions/workflows/release-new-version.yml

Description: Initiates the creation of a new Release Pull Request. This PR includes an automated version bump and proposed changes to the Change Log.

Parameters:
  - release_type: (Required) Type of release. Options: major, minor, patch.

Output:
  - Creates a new Release PR (e.g., #592) with automated versioning and changelog updates.
  - Creates a release branch named 'release/[creation-date]/[release-type]-release'.
```

--------------------------------

### Run Linter Commands

Source: https://github.com/wordpress/create-block-theme/blob/trunk/CONTRIBUTING.md

Executes various linter commands to check and fix code quality for CSS, JavaScript, and PHP according to WordPress coding standards. These commands are run via npm scripts in a bash shell.

```bash
npm run lint:css
npm run lint:css:fix
npm run lint:js
npm run lint:js:fix
npm run lint:php
npm run lint:php:fix
```

--------------------------------

### Create Block Theme Plugin Actions

Source: https://github.com/wordpress/create-block-theme/blob/trunk/readme.txt

Actions available within the Create Block Theme plugin's interface for managing themes and styles. These actions allow users to save changes, export themes, edit metadata, inspect theme JSON, create new themes or variations, and clone/create child themes.

```APIDOC
Theme Management Actions:

Save Changes:
  - Description: Saves any recent changes made in the WordPress Editor to the currently active theme.
  - Usage: Accessible via the Create Block Theme menu in the Editor.

Save Fonts:
  - Description: Saves all active fonts from the WordPress Font Library to the currently active theme. Deactivates fonts in the system and removes them from the theme if they are no longer active.
  - Usage: Select 'Save Changes To Theme' then 'Save Fonts' from the Create Block Theme menu.

Export Zip:
  - Description: Exports the currently active theme, including all changes and assets, as a zip file.
  - Usage: Select 'Export Zip' from the Create Block Theme menu.

Edit Theme Metadata:
  - Description: Allows editing of the theme's metadata, which is used in the style.css file.
  - Usage: Select 'Edit Theme Metadata' from the Create Block Theme menu.

Inspect Theme JSON:
  - Description: Displays the contents of the active theme's theme.json file for inspection.
  - Usage: Select 'Inspect Theme JSON' from the Create Block Theme menu.

Create Blank Theme:
  - Description: Creates a new, blank WordPress theme. Requires a theme name and optionally accepts additional metadata.
  - Parameters:
    - themeName: (string) The name for the new theme.
    - metadata: (object, optional) Additional metadata for the theme.
  - Usage: Select 'Create Blank Theme', provide details, and click 'Create Blank Theme'.

Create Theme Variation:
  - Description: Creates a new style variation based on the currently active theme. Requires a name for the variation.
  - Parameters:
    - variationName: (string) The name for the new style variation.
  - Usage: Select 'Create Theme Variation', provide a name, and click 'Create Theme Variation'.

Clone Theme:
  - Description: Creates a new theme that is a clone (copy) of the currently active theme, including all current changes.
  - Usage: Click 'Create Theme' then 'Clone Theme' from the Create Block Theme menu.

Create Child Theme:
  - Description: Creates a new child theme with the currently active theme as its parent, incorporating current changes.
  - Usage: Click 'Create Theme' then 'Create Child Theme' from the Create Block Theme menu.

Note: Many of these options were previously available under Appearance > Create Block Theme.
```
Tokens:
Raw