Download the PHP package larsgowebdev/wp-battery-cli without Composer

WP-Battery CLI Plugin

A WordPress CLI plugin that provides commands for creating and managing WP-Battery theme components. This plugin extends WP-CLI to streamline the development workflow with WP-Battery themes.

Requirements

• PHP >= 8.1
• WordPress >= 6.5 (Composer-based), Bedrock recommended
  • WP-CLI installed and configured
• WP-Battery theme framework installed

Installation

1. Install the plugin with composer:

2. Make sure the plugin is activated:

3. Verify installation:

Available Commands

Initialize WP-Battery Structure

Creates the required folder structure for a WP-Battery theme.

Usage:

This creates the following structure in your theme:

Create Block

Creates a new block with required files and structure.

Required arguments:

• --name: Identifier of the block, it will be registered to that name and the folder structure will be named after it.
• --title: Name of the block, displayed in the WP admin area

Usage:

Creates:

Create Page Template

Creates a new page template with required files.

Required arguments:

• --name: Identifier of the page, the template will be named after it.

Usage:

Creates:

Create Menu Configuration

Creates a new menu configuration file.

Required arguments:

• --name: Identifier of the menu, the configuration file will be named after it

Usage:

Creates:

Create Options Page

Creates a new ACF options page configuration.

Required arguments:

• --name: Identifier of the options page, the configuration file will be named after it

Usage:

Creates:

Create Custom Post Type

Creates a custom post type configuration file to be automatically loaded by WP-Battery.

Required arguments:

• --name: Identifier of the post type, the configuration file will be named after it
• --namespace: Plugin/Theme namespace, for translations

Usage:

Creates:

Create Custom Taxonomy

Creates a custom taxonomy configuration file to be automatically loaded by WP-Battery.

Required arguments:

• --name: Identifier of the taxonomy, the configuration file will be named after it
• --namespace: Plugin/Theme namespace, for translations
• --post-type: Which post type this taxonomy will be registered for
  • Note: Currently WP-Battery CLI only supports a single post type here. Of course, more can be added later.

Usage:

Creates:

Naming Conventions

All component names must follow these rules:

• Lowercase letters only
• Numbers allowed
• Hyphens and underscores allowed
• No spaces or special characters
• Cannot start or end with hyphen/underscore
• Cannot contain consecutive hyphens/underscores

Examples:

Renderer Functions

Both blocks and pages support custom render functions for data processing. These functions must:

• Contain the word 'render' in their name
• Accept one parameter ($context)
• Return the modified context

Example:

Safety Features

• Prevents overwriting existing components
• Validates component names before creation
• Provides helpful error messages and suggestions
• Creates .gitkeep files in empty directories
• Adds appropriate .gitignore rules

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

This project is licensed under the GPL-2.0 License.