bradp/wordpress-pattern-category-phpcs

PHPCS sniffs for enforcing categories in WordPress block pattern files.

1.0.0 2026-02-13 17:19 UTC

Requires

• php: >=7.4
• squizlabs/php_codesniffer: ^3.0

MIT

• Brad Parbs

• wordpress
• standards
• phpcs

README

PHPCS sniffs for enforcing categories in WordPress block pattern files.

Installation

composer require --dev bradp/wordpress-pattern-category-phpcs

Usage

Add the rule to your project's phpcs.xml or .phpcs.xml.dist:

<rule ref="PatternCategory.Patterns.PatternCategory">
    <properties>
        <property name="base_category" value="your-category" />
    </properties>
</rule>

What it checks

The sniff validates that WordPress block pattern files contain a file-level docblock with the correct metadata:

1. Missing docblock — The pattern file must have a /** ... */ docblock near the top.
2. Missing Categories — The docblock must include a Categories: line.
3. Missing base category — If base_category is configured, it must appear in the comma-separated list of categories.

Example of a valid pattern file

<?php
/**
 * Title: Hero Banner
 * Slug: my-theme/hero-banner
 * Categories: my-theme, banner
 */
?>
<!-- pattern markup -->