WordPress multi-block plugin scaffold with CPT, taxonomies, SCF fields, and block bindings

[Copilot]

---

name: "Pull Request"
about: "General changes, refactors, and maintenance"
title: "PR: WordPress multi-block plugin scaffold with CPT, taxonomies, SCF fields, and block bindings"
labels: ["status:needs-review"]

General Pull Request

This repository enforces changelog, release, and label automation for all PRs and issues.
See the organisation-wide Automation Governance & Release Strategy for contributor rules.

Linked issues

Closes #1

Changelog

Added

• Complete multi-block WordPress plugin scaffold per spec.
• Four Gutenberg blocks: card, collection, slider, featured in src/blocks/:
  • card: Single post display with image, title, subtitle, excerpt, meta.
  • collection: Grid/list/slider layouts with query controls, pagination, taxonomy filtering.
  • slider: Carousel with autoplay, dots, arrows, touch/swipe, keyboard nav.
  • featured: Featured posts with grid, featured-first, hero layouts.
• Custom Post Type and Taxonomy registration (inc/class-post-types.php, inc/class-taxonomies.php).
• Secure Custom Fields (SCF) integration, including repeaters and flexible fields (inc/class-fields.php, inc/class-repeater-fields.php).
• Block Bindings API integration for custom fields (WP 6.5+, inc/class-block-bindings.php).
• Patterns, templates, and template parts scaffolded for core block layouts (patterns/, templates/, parts/).
• Shared React components for block editor UI (src/components/): Slider, PostSelector, TaxonomyFilter, FieldDisplay, RepeaterField, Gallery, QueryControls.
• Custom React hooks for editor state (src/hooks/): usePostType, useTaxonomies, useFields, useRepeater, useSlider, useCollection.
• PHPUnit unit tests, Jest component tests, Playwright E2E and accessibility tests (tests/).
• Uninstall script for complete cleanup (uninstall.php).
• All templates and source files use Mustache {{variables}} for scaffold instantiation.
• Support for Secure Custom Fields plugin and WP 6.5+.

Changed

• N/A (Initial scaffold commit).

Fixed

• N/A (Initial scaffold commit).

Removed

• N/A (Initial scaffold commit).

---

Risk Assessment

Risk Level: Medium

Potential Impact:

• As this is an initial scaffold, risk is mainly around correct registration/loading of blocks, CPTs, taxonomies, and fields in new plugin environments.
• Bugs could affect block editor UI, site display, data handling (esp. with custom fields/repeaters), and activation/uninstall flows.
• SCF and Block Bindings integration (WP 6.5+) introduce new integration surfaces—misconfiguration could break custom field/block data flows.

Mitigation Steps:

• Full test suite: unit, integration, E2E, and a11y automated coverage.
• WP 6.5+ version checks, with graceful deactivation if requirements not met.
• Modular design with separation of concerns.
• Uninstall script thoroughly tested in dev and staging.
• All code is scaffolded using Mustache variables, designed for robust instantiation and regeneration.

---

How to Test

Prerequisites

• WordPress 6.5+ environment (PHP 8.0+)
• Secure Custom Fields plugin installed and active
• Enable block editor for custom post type(s) as registered in inc/class-post-types.php
• Activate this plugin

Test Steps

1. Block Registration:

   • Add each block (card, collection, slider, featured) in the post/page editor.
   • Confirm block UI loads, block attributes are editable, and previews update live.

2. Custom Post Types & Taxonomies:

   • Create a new custom post in the CPT, apply custom taxonomy terms.
   • Verify query, filter, and display features in the editor and frontend.

3. SCF Field Integration:

   • Edit post to add/edit Secure Custom Fields, including repeaters.
   • Check that field data appears in corresponding blocks via Block Bindings.

4. Block Bindings API:

   • Test Block Bindings with sample code:

     <!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"{{namespace}}/fields","args":{"key":"{{slug}}_subtitle"}}}}} -->
     <p></p>
     <!-- /wp:paragraph -->

   • Ensure bound data renders in both editor and frontend.

5. Patterns & Templates:

   • Apply pre-defined patterns and block templates to new posts/pages.
   • Confirm parts, layouts, and rendered HTML match expectations.

6. Uninstall:

   • Uninstall the plugin; verify all registered CPTs, taxonomies, options, and metadata are cleaned up.

Expected Results

• All blocks function with full controls and data.
• CPTs/taxonomies registered and discoverable; admin UI works as expected.
• SCF fields are mapped to blocks. Data renders using Block Bindings.
• Patterns and template parts render in content and reflect customizations.
• No PHP/JS errors in logs or console. All automated tests pass.
• Uninstallation thoroughly cleans up data.

Edge Cases to Verify

• Empty state (no posts, no terms, blocks with missing data)
• Maximum data (hundreds of posts/terms/fields for performance)
• Error handling (missing SCF plugin, missing fields, invalid input)
• Mobile/responsive block controls and frontend layouts
• Accessibility: Keyboard navigation, ARIA roles, screen reader text in blocks and meta
• Browser compatibility: Chrome, Firefox, Safari (recent versions)
• WordPress downgrade (behavior if <6.5 environment)

---

Checklist (Global DoD / PR)

• All AC met and demonstrated
• Tests added/updated (unit/E2E as appropriate)
• A11y considerations addressed where relevant
• Docs/readme/changelog updated (if user-facing)
• Security/perf impact reviewed where relevant
• Code/design reviews approved
• CI green; linked issues closed; release notes prepared (if shipping)
• Risk assessment completed above
• Testing instructions provided above

---

References

• Contribution Guidelines
• Branching Strategy
• Automation Governance
• PR Labels
• Saved Replies
• Project Meta
• Labeler Config
• Labels
• Issue Types

---

Plugin Details / Spec

Complete multi-block WordPress plugin scaffold per spec. Includes 4 Gutenberg blocks, custom post type/taxonomy, SCF integration with repeaters, Block Bindings API (WP 6.5+), patterns/templates/parts, and full test suite. All files use Mustache {{variables}} for scaffold instantiation.

Blocks (src/blocks/)

• card - Single post display with image, title, subtitle, excerpt, meta
• collection - Grid/list/slider layouts with query controls, pagination, taxonomy filtering
• slider - Carousel with autoplay, dots, arrows, touch/swipe, keyboard nav
• featured - Featured posts with grid, featured-first, hero layouts

PHP Classes (inc/)

• class-post-types.php / class-taxonomies.php - CPT and taxonomy registration
• class-fields.php / class-repeater-fields.php - SCF field groups including repeaters and flexible content
• class-block-bindings.php - WP 6.5+ Block Bindings source for {{namespace}}/fields
• class-block-templates.php / class-patterns.php - Template and pattern registration

Shared React Components (src/components/)

• Slider, PostSelector, TaxonomyFilter, FieldDisplay, RepeaterField, Gallery, QueryControls

Custom Hooks (src/hooks/)

• usePostType, useTaxonomies, useFields, useRepeater, useSlider, useCollection

Infrastructure

• patterns/ - 7 PHP pattern files (archive, card, single, grid, slider, featured, meta)
• templates/ - Block templates for single/archive views
• parts/ - Template parts (header, meta, sidebar)
• tests/ - PHPUnit, Jest, Playwright E2E tests
• uninstall.php - Complete cleanup on removal

Block Bindings Example

<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"{{namespace}}/fields","args":{"key":"{{slug}}_subtitle"}}}}} -->
<p></p>
<!-- /wp:paragraph -->

Plugin Dependencies (WP 6.5+)

* Requires Plugins:  secure-custom-fields

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR introduces a comprehensive multi-block WordPress plugin scaffold designed for WP 6.5+ with extensive Gutenberg block support, custom post types, taxonomies, SCF field integration, Block Bindings API, and a complete test suite. The scaffold uses Mustache variables ({{variables}}) throughout for instantiation flexibility.

Key Features:

• 4 Gutenberg blocks (card, collection, slider, featured) with server-side rendering
• Custom post type and taxonomy registration
• SCF integration with repeaters and flexible content fields
• Block Bindings API for dynamic field display
• Comprehensive pattern and template system
• Shared React components and custom hooks
• Full test coverage (PHPUnit, Jest, Playwright E2E)

Reviewed changes

Copilot reviewed 107 out of 111 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
{{slug}}.php	Main plugin file with class autoloading, SCF dependency checks, and block registration
inc/class-*.php	PHP classes for post types, taxonomies, fields, repeater fields, block bindings, templates, and patterns
src/blocks/*/	Four block implementations (card, collection, slider, featured) with edit/save/render components
src/components/*/	Shared React components (Slider, PostSelector, TaxonomyFilter, Gallery, etc.)
src/hooks/	Custom hooks (usePostType, useTaxonomies, useFields, useRepeater, useSlider, useCollection)
templates/, patterns/, parts/	Block templates, patterns, and template parts for single/archive views
tests/	Comprehensive test suite (PHPUnit, Jest, Playwright) with bootstrap and setup files
webpack.config.cjs, package.json, composer.json	Build configuration and dependencies
Configuration files	PHPUnit, PHPStan, PHPCS, wp-env configuration

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Unused variable categoryTab.

[Copilot]

Unused variable blockItem.