- Block Showcase: Powerful development tool (admin-only) to discover, preview, and inspect all registered blocks with their attributes in an organized, interactive format.
- Dominant Color Images: Automatic calculation and storage of dominant colors for uploaded images, used as placeholders while images load.
- Image Prioritizer: Automatically prioritizes above-the-fold images with fetchpriority="high" for improved page load performance.
- WebP Uploads: Automatically generates WebP versions of uploaded JPEG and PNG images for better compression and faster loading.
- ESLint 9 Migration: Upgraded to ESLint 9 with flat config format for modern JavaScript linting.
- PHP Path Auto-Detection: Automatic PHP binary detection for cross-platform compatibility (Mac, Linux, CI/CD).
- CI/CD Extension Support: Automatic PHP extension handling for local development and CI environments.
- Package Updates: Updated npm and dependencies to latest compatible versions.
- Dependency Cleanup: Removed unused npm packages for cleaner dependency tree.
- RSS Block Fix: Improved handling of RSS blocks with missing or invalid feed URLs.
Table of Contents
- WDS BT
- Overview
- Requirements
- Getting Started
- Development
- Font Management
- Creating Blocks
- Block Showcase
- Dominant Color Images
- Image Prioritizer
- WebP Uploads
- Customizations
- Stylelint Configuration
- PHP Linting Configuration
- JavaScript Linting Configuration
- Dynamic Block Pattern Categories
- Accessibility, Code Quality, and Security Checks
- Strict Lefthook Integration
- Cross-Platform Compatibility
- Contributing and Support
- Acknowledgements
WDS BT is a foundational WordPress block theme designed for maximum flexibility and customization. It integrates seamlessly with the native WordPress block editor, providing an intuitive and adaptable user experience. WDS BT is specifically developed as a foundational rather than parent theme, giving developers a clean and versatile base for advanced customizations.
| Feature | Description |
|---|---|
| Native Block Support | Built for native WordPress blocks and site editor integration. |
| Responsive Design | Ensures optimal display and functionality across devices. |
| Foundation Theme | Flexible base theme optimized for extensive customization. |
| Automated Code Quality | Modern linting configurations with PHP 8.3 compatibility, ESLint 9 flat config, WordPress coding standards, and automated quality checks. |
| Cross-Platform PHP Support | Automatic PHP binary detection and extension handling for Mac, Linux, and CI/CD environments. |
| Third-party Block Style Overrides | Conditionally enqueue and override third-party block styles for efficient asset delivery. |
| Accessibility Compliance | Built-in WCAG 2.2 compliance with automated Pa11y checks. |
| Enhanced Webpack Configuration | Refined Webpack setup for improved dependency resolution and optimized asset management. |
| Block Creation Script Enhancements | Options for static, dynamic, or interactive blocks; automatically includes view.js for rendering. |
| Block Showcase | Development tool to discover, preview, and inspect all registered blocks with their attributes. |
| Dominant Color Images | Automatic dominant color calculation for images, used as background placeholders during image loading. |
| Image Prioritizer | Automatically prioritizes above-the-fold images with fetchpriority="high" for faster page loads. |
| WebP Uploads | Automatically generates WebP versions of uploaded images for better compression and performance. |
| LeftHook Integration | Required for pre-commit hooks and automated code quality checks. |
- WordPress 6.4+
- PHP 8.2+ (fully tested with PHP 8.3)
- NPM (v10+)
- Node (v20+)
- Composer 2+
- License: GPLv3
- Clone this repository to your WordPress theme directory (
wp-content/themes/). - Activate WDS BT from your WordPress admin panel under Appearance > Themes.
- Run
npm run setupto install dependencies and perform an initial build.
Theme Structure
βββ πwds-bt
βββ πassets
βββ πfonts
βββ πimages
βββ πicons
βββ index.js
βββ πjs
βββ πblock-filters
βββ buttons.js
βββ index.js
βββ πblock-variations
βββ index.js
βββ editor.js
βββ πglobal
βββ header.js
βββ index.js
βββ table.js
βββ index.js
βββ πtemplates
βββ index.js
βββ πscss
βββ _index.scss
βββ πabstracts
βββ _index.scss
βββ mobile-only-mixins.scss
βββ responsive-mixins.scss
βββ utility.scss
βββ πbase
βββ _index.scss
βββ forms.scss
βββ global.scss
βββ pagination.scss
βββ πblocks
βββ πcore
βββ πthird-party
βββ editor.scss
βββ πpatterns
βββ _index.scss
βββ πtemplate-parts
βββ _index.scss
βββ footer.scss
βββ header.scss
βββ πtemplates
βββ _index.scss
βββ 404.scss
βββ archive.scss
βββ search.scss
βββ πinc
βββ πblock-template
βββ πblock
βββ edit.js.mustache
βββ editor.scss.mustache
βββ index.js.mustache
βββ render.php.mustache
βββ style.scss.mustache
βββ view.js.mustache
βββ index.js
βββ πplugin
βββ .editorconfig.mustache
βββ .eslintrc.mustache
βββ .gitignore.mustache
βββ $slug.php.mustache
βββ readme.txt.mustache
βββ README.md
βββ πfunctions
βββ back-to-top.php
βββ custom-logo-svg.php
βββ security.php
βββ πhooks
βββ enqueue-block-stylesheet.php
βββ enqueue-third-party-block-stylesheet.php
βββ register-block-categories.php
βββ register-block-filters.php
βββ register-block-pattern-categories.php
βββ register-block-patterns.php
βββ register-block-styles.php
βββ register-block-variations.php
βββ restrict-block-patterns.php
βββ πsetup
βββ scripts.php
βββ setup.php
βββ style-script-version.php
βββ πpa11y-ci-report
βββ πparts
βββ comments.html
βββ footer.html
βββ header.html
βββ post-meta.html
βββ πpatterns
βββ comments.php
βββ footer-default.php
βββ header-default.php
βββ post-hero.php
βββ primary-category.php
βββ πstyles
βββ dark.json
βββ πtemplates
βββ 404.html
βββ archive.html
βββ index.html
βββ page-blank.html
βββ page-no-title.html
βββ page.html
βββ search.html
βββ single.html
βββ .editorconfig
βββ .env
βββ eslint.config.cjs
βββ .gitignore
βββ .markdownlintignore
βββ .nvmrc
βββ .prettierignore
βββ .prettierrc.js
βββ .stylelintignore
βββ .stylelintrc.json
βββ a11y.cjs
βββ babel.config.json
βββ composer.json
βββ composer.lock
βββ CONTRIBUTING.md
βββ functions.php
βββ lefthook.yml
βββ LICENSE.md
βββ package-lock.json
βββ package.json
βββ phpcs.xml.dist
βββ postcss.config.js
βββ README.md
βββ readme.txt
βββ screenshot.png
βββ style.css
βββ theme.json
βββ updateVersion.js
βββ webpack.config.js
Setup
From the command line, change directories to your new theme directory:
cd /wp-content/themes/your-themeThe command below will remove node_modules, vendor, build, package-lock.json, and composer.lock files. Install theme dependencies and trigger an initial build.
Note: You will need to have Composer 2 and NPM 10+ installed first. The setup script automatically detects PHP paths and handles extension flags for your environment.
npm run setupFrom the command line, type any of the following to perform an action:
| Command | Description | |
|---|---|---|
| π | npm run a11y |
Run accessibility tests (Pa11y-CI). |
| π οΈ | npm run build |
Build the theme assets. |
| π¨ | npm run create-block |
Scaffold a new block with various configurations. |
| π | npm run format |
Format all code files (JS, SCSS, PHP). |
| π¨ | npm run format:css |
Format SCSS files. |
| π | npm run format:js |
Format JavaScript files. |
| π | npm run format:php |
Format PHP files. |
| π€ | npm run fonts |
Process fonts and update theme.json. |
| π | npm run fonts:detect |
Detect and list all available fonts. |
| π§ | npm run fonts:generate |
Generate theme.json with detected fonts. |
| π | npm run lint |
Run all linting scripts. |
| π¨ | npm run lint:css |
Lint CSS files. |
| π | npm run lint:js |
Lint JavaScript files. |
| π | npm run lint:php |
Lint PHP files. |
| π | npm run packages-update |
Update dependencies defined in package.json. |
| π οΈ | npm run setup |
Reset, install dependencies, and build the theme. |
npm run start |
Start the development server. | |
| π | npm run version-update |
Update the theme version based on environment variable. |
WDS BT includes an automated font management system that organizes fonts by purpose and automatically generates the necessary files for optimal font loading and WordPress integration.
Font Organization
Fonts are organized by their purpose/role for easy swapping and management:
assets/fonts/
βββ headline/
β βββ Inter.woff2
β βββ Poppins-Bold.woff2
βββ body/
β βββ Oxygen-Regular.woff2
β βββ OpenSans-Regular.woff2
βββ mono/
βββ RobotoMono-Regular.woff2
Benefits:
- Easy font swapping: Just replace files in each folder
- Clear purpose: Each folder has a specific role
- Standardized slugs: Automatically generates
headline,body,monoslugs in theme.json - Consistent paths: CSS custom properties always use the same slugs
How it works:
- Place fonts in the appropriate purpose folder (
headline/,body/,mono/) - The processor detects the purpose from the folder name
- Maps to standardized slugs in theme.json
- Generates correct CSS custom properties:
var(--wp--preset--font-family--headline),var(--wp--preset--font-family--body),var(--wp--preset--font-family--mono)
To change fonts:
- Headlines: Replace files in
headline/folder - Body text: Replace files in
body/folder - Code/mono: Replace files in
mono/folder
Font Tools
The main font processing tool that:
- Scans
assets/fonts/for font files - Copies fonts to
build/fonts/maintaining folder structure - Generates preload links in
inc/setup/font-preload.php - Updates
theme.jsonwith detected font families
Usage:
npm run fonts
# or
php tools/font-processor.phpLists all available fonts in your theme for debugging and inspection.
Usage:
npm run fonts:detect
# or
php tools/font-detection.phpOutput:
- Lists all fonts found in
assets/fonts/andbuild/fonts/ - Shows font family, weight, and style information
- Helps identify what fonts are available
Advanced font processing with optimization and subsetting capabilities.
Usage:
npm run fonts:generate
# or
php tools/font-generator.phpFeatures:
- Font subsetting for smaller file sizes
- Multiple format generation (WOFF2, WOFF)
- CSS generation with @font-face declarations
- Preload link generation
Font Workflow
-
Organize by purpose: Place font files in the appropriate folder:
assets/fonts/headline/for heading fontsassets/fonts/body/for body text fontsassets/fonts/mono/for monospace/code fonts
-
Run the font processor:
npm run fonts
-
Verify the results:
- Check
build/fonts/for copied fonts - Check
inc/setup/font-preload.phpfor preload links - Check
theme.jsonfor font family definitions
- Check
Fonts are automatically available as CSS custom properties:
.heading {
font-family: var(--wp--preset--font-family--headline);
}
.body-text {
font-family: var(--wp--preset--font-family--body);
}
.code {
font-family: var(--wp--preset--font-family--mono);
}The system automatically detects font properties from filenames:
- Family detection: From folder name or filename patterns
- Weight detection: From filename patterns (e.g.,
-300,-bold,-700) - Style detection: From filename patterns (e.g.,
-italic,-oblique)
Supported patterns:
- Weights:
100,200,300,400,500,600,700,800,900 - Styles:
normal,italic,oblique - Families:
Inter,Oxygen,Roboto Mono,Open Sans,Lato,Poppins, etc.
Font Debugging
When WP_DEBUG is enabled, font detection debug information is displayed in the WordPress admin on the WDSBT Settings page.
To enable debug:
- Set
WP_DEBUG = truein yourwp-config.php - Visit the WDSBT Settings page in WordPress admin
- Look for the "Font Detection Debug" notice
Debug information includes:
- Number of fonts found in build and assets directories
- List of detected font families with variant counts
- Individual font variant details (weight, style, file path)
Fonts not appearing in theme.json:
- Check that fonts are in the correct folders (
headline/,body/,mono/) - Verify font file extensions are supported (
.woff2,.woff,.ttf,.otf) - Run
npm run fonts:detectto see what fonts are detected - Check for any error messages in the font processor output
Preload links not working:
- Ensure
inc/setup/font-preload.phpexists and is properly generated - Check that the file is being included in your theme
- Verify the font paths in the preload links are correct
CSS custom properties not available:
- Check that
theme.jsoncontains the font family definitions - Verify the font slugs are correct (
headline,body,mono) - Ensure WordPress is generating the CSS custom properties
The theme includes an automated version update system that ensures consistency across all files that reference the theme version.
How to Update the Theme Version
Method 1: Using the .env file (Recommended)
-
Update the
.envfile with the new version:echo "VERSION=1.4.0" > .env
-
Run the version update script:
npm run version-update
Method 2: Using environment variable directly
VERSION=1.4.0 npm run version-updateMethod 3: Using dotenv-cli (if installed globally)
npx dotenv -e .env -- npm run version-updateWhat Gets Updated
The version update script automatically updates the version in:
style.css(theme header)package.json(NPM package version)composer.json(Composer package version)README.md(documentation version)
# 1. Set the new version in .env file
echo "VERSION=1.4.0" > .env
# 2. Run the version update script
npm run version-update
# 3. Verify the changes
git diff
# 4. Commit the version bump
git add .
git commit -m "WDSBT-XXX - bump version to 1.4.0"
# 5. Tag the release (optional)
git tag -a v1.4.0 -m "Release version 1.4.0"
git push origin v1.4.0Release Types and Workflows
Patch Release (Bug Fixes) For small bug fixes and minor updates (e.g., 1.4.0 β 1.4.1):
# 1. Create a patch branch
git checkout -b patch/1.4.1
# 2. Make your bug fixes
# ... make changes ...
# 3. Update version to patch
echo "VERSION=1.4.1" > .env
npm run version-update
# 4. Commit changes
git add .
git commit -m "WDSBT-XXX - fix [specific issue]"
# 5. Commit version bump
git add .
git commit -m "WDSBT-XXX - bump version to 1.4.1"
# 6. Create pull request
git push origin patch/1.4.1
# ... create PR and merge ...
# 7. Tag the release
git checkout main
git pull origin main
git tag -a v1.4.1 -m "Patch release 1.4.1 - [brief description]"
git push origin v1.4.1Minor Release (New Features) For new features and enhancements (e.g., 1.4.0 β 1.5.0):
# 1. Create a feature branch
git checkout -b feature/1.5.0
# 2. Add new features
# ... implement features ...
# 3. Update version to minor
echo "VERSION=1.5.0" > .env
npm run version-update
# 4. Update CHANGELOG.md (if maintained)
# ... document new features ...
# 5. Commit changes
git add .
git commit -m "WDSBT-XXX - add [new feature]"
# 6. Commit version bump
git add .
git commit -m "WDSBT-XXX - bump version to 1.5.0"
# 7. Create pull request and tag release
# ... same as patch workflow ...Major Release (Breaking Changes) For major updates with breaking changes (e.g., 1.4.0 β 2.0.0):
# 1. Create a major release branch
git checkout -b release/2.0.0
# 2. Implement breaking changes
# ... make breaking changes ...
# 3. Update version to major
echo "VERSION=2.0.0" > .env
npm run version-update
# 4. Update documentation for breaking changes
# ... update README, CHANGELOG, etc. ...
# 5. Test thoroughly
npm run build
npm run lint
npm run a11y
# 6. Commit changes
git add .
git commit -m "WDSBT-XXX - breaking: [description of breaking changes]"
# 7. Commit version bump
git add .
git commit -m "WDSBT-XXX - bump version to 2.0.0"
# 8. Create pull request and tag release
# ... same as patch workflow ...Automated Patch Workflow
For quick patches, you can use a streamlined workflow:
# Quick patch workflow
git checkout -b hotfix/1.4.1
# ... make quick fix ...
echo "VERSION=1.4.1" > .env && npm run version-update
git add . && git commit -m "WDSBT-XXX - hotfix: [issue description]"
git push origin hotfix/1.4.1
# ... create PR, merge, tag ...Pre-release Versions
For beta, alpha, or release candidate versions:
# Beta release
echo "VERSION=1.4.0-beta.1" > .env
npm run version-update
# Alpha release
echo "VERSION=1.4.0-alpha.1" > .env
npm run version-update
# Release candidate
echo "VERSION=1.4.0-rc.1" > .env
npm run version-updateTroubleshooting
Version not updating in all files:
- Check that the
.envfile exists and contains theVERSIONvariable - Ensure the version format is correct (e.g.,
1.4.0, notv1.4.0) - Run
npm run version-updatewith verbose output to see any errors
Permission errors:
- Ensure you have write permissions to all theme files
- Check that no files are locked by other processes
Script not found:
- Verify that
updateVersion.jsexists in the theme root - Ensure Node.js is installed and accessible
- Run
npm installto ensure all dependencies are installed
Version Update Process Details
The version update script (updateVersion.js) reads the VERSION environment variable from the .env file and updates all version references across the project. This ensures consistency across all files that reference the theme version.
How it works:
- Reads the
VERSIONenvironment variable - Scans specific files for version patterns
- Updates version references while preserving formatting
- Provides feedback on what was updated
Supported version formats:
- Semantic versioning:
1.4.0,2.0.0,1.4.0-beta.1 - WordPress version format:
1.4.0
Files processed:
style.css- WordPress theme headerpackage.json- NPM package metadatacomposer.json- Composer package metadataREADME.md- Documentation version references
- Run the Block Creation Script Navigate to your project root in the terminal and run the following command to create a new block:
npm run create-blockFollow the prompts to configure your new block. The script will scaffold a new block structure inside assets/blocks/.
- Build your block After editing and configuring your block, build your project to compile assets using webpack:
npm run buildThis will process JavaScript, SCSS, optimize images, and generate necessary files for each custom block in the ./blocks directory.
Registering Block Styles
-
Open the
inc/hooks/register-block-styles.phpfile in your theme directory. -
Add a new block style entry with the following mandatory properties:
-
Name: The identifier used to compute a CSS class for the style.
-
Label: A human-readable label for the style.
Example:
'block_name' => array(
'name' => __( 'label', 'wdsbt' ),
),Overriding/Customizing Core Block Styles
-
Navigate to the
assets/scss/blocks/coredirectory within your theme. -
Create an SCSS file with the exact filename as the block name you want to customize. This file will house your custom styles for that specific block.
-
Files within the
assets/scss/blocks/core/directory are automatically enqueued, simplifying the integration of your custom styles into the WordPress block editor. Do not import these files into the mainindex.scss -
After adding your custom SCSS file, run the following command to compile and apply your changes:
npm run buildOverriding/Customizing Third Party Block Styles
-
Place Your Override SCSS Files: Add your thirdβparty override SCSS files in
assets/scss/blocks/third-party/.- Naming Convention: Name each file using the block's slug (the part after the namespace). For example, to override the
wdsbt/testblock, name the filetest.scss.
- Naming Convention: Name each file using the block's slug (the part after the namespace). For example, to override the
-
Third-Party Block Styles: Files within the
assets/scss/blocks/third-party/directory are automatically enqueued. Do not import these files into your mainindex.scss. -
Compile Your Changes: After adding or updating your custom SCSS file, run the following command to compile and apply your changes:
npm run buildCreating Block Variations
-
In the
assets/js/block-variationsdirectory within your theme, create a new JavaScript file. This file will contain the definition of your block variation. -
Import the newly created file into the
assets/js/block-variations/index.jsfile. This step ensures that your variation is included in the build process. -
Use the
wp.blocks.registerBlockVariation()function to officially register your block variation. This function takes the name of the original block and an object defining the variation.
Example:
// In your variations JavaScript file
wp.blocks.registerBlockVariation('core/paragraph', {
name: 'custom-variation',
title: __('Custom Variation', 'wdsbt'),
attributes: { /* Define your custom attributes here */ },
// Add more variation settings as needed
});Original Block Name: Provide the name of the original block for which you are creating the variation. Variation Object: Define the properties of your block variation, including the name, title, attributes, and any additional settings.
NOTE: To find the correct block name, open the block editor, launch the browser console and type
wp.blocks.getBlockTypes(). You will see the complete list of block names (from core or third-party).
Unregister Blocks and Variations
This functionality allows you to unregister and disable specific core Gutenberg blocks, styles, and variations that are not needed on your WordPress website. By removing these unused blocks and variations, you can streamline the Gutenberg editor and improve the overall performance of your site.
The script in assets/js/editor.js loops through a list of unused blocks and variations, unregistering them from the Gutenberg editor. Additionally, it keeps only the specified embed variations for the core/embed block.
Example
// List of Gutenberg blocks to unregister
const unusedBlocks = [
'core/file',
'core/latest-comments',
'core/rss',
// Add more unused blocks as needed
];
// List of Gutenberg block variations to unregister
const unregisterBlockVariations = [
// Example:
// {
// blockName: 'core/group',
// blockVariationName: 'group-stack',
// },
];
// Keep only the necessary embed variations
const keepEmbeds = [
'twitter',
'wordpress',
'spotify',
// Add more necessary embed variations as needed.
];Responsive Mixins
This SCSS file assets/scss/abstracts/responsive-mixins.scss provides mixins for creating responsive media queries with both minimum and maximum width conditions. The file promotes modular and maintainable styling by allowing the easy application of responsive styles based on screen width.
To use the responsive mixin, include it in your SCSS code and customize it according to your project's breakpoints. Here's an example:
// Usage examples
.my-element {
width: 100%;
// Apply styles when the screen width is 600px or more
@include responsive-mixins.responsive-min(600px) {
/* Your responsive styles for min-width: 600px */
}
// Apply styles when the screen width is up to 600px
@include responsive-mixins.responsive-max(600px) {
/* Your responsive styles for max-width: 600px */
}
// Apply styles when the screen width is between 600px and 1200px
@include responsive-mixins.responsive-range(600px, 1200px) {
/* Your responsive styles for a range of widths */
}
}Mobile Only Mixins
This SCSS file assets/scss/abstracts/_mobile-only-mixins.scss contains a mixin called mobile-only designed to visually hide elements for accessibility (a11y) while making them visible on mobile devices.
Include the mobile-only mixin in your SCSS file where you want to hide elements on desktop but make them visible on mobile:
// Example usage:
.my-element {
@include mobile-only-mixins.mobile-only;
}This theme uses a modern stylelint.config.js configuration that extends the WordPress Stylelint Config with additional custom rules to maintain code consistency and enforce best practices.
The configuration extends the base WordPress stylelint ruleset, ensuring that all SCSS follows the WordPress coding standards while incorporating additional theme-specific preferences and PHP 8.3 compatibility.
To check your SCSS files for linting errors, run:
npm run lint:cssCustom Rules
-
declaration-no-important: trueProhibits the use of!importantto maintain specificity control. -
no-descending-specificity: nullAllows selectors with descending specificity to prevent conflicts with deeply nested components. -
selector-class-pattern: nullDisables restrictions on class naming conventions to support custom project structures. -
at-rule-no-unknownAllows SCSS directives and WordPress-specific at-rules:apply,layer,variants,responsive,screenuse,include,each,if,else,for,whilefunction,return,mixin,content,extendwarn,error,debug
-
declaration-property-unit-allowed-listRestricts certain CSS properties to specific units:font-size:em,remline-height: No units (unitless for better scaling)border: Onlypxallowedmargin:em,rempadding:em,rem
-
no-invalid-double-slash-comments: nullAllows SCSS-style double-slash comments (//). -
comment-no-empty: nullAllows empty comments for documentation purposes.
This theme uses PHP_CodeSniffer with WordPress coding standards and PHP 8.3 compatibility checks.
- PHP Version: Fully tested with PHP 8.2+ and PHP 8.3
- WordPress Standards: Follows WordPress-Extra and WordPress-Docs coding standards
- Compatibility: Uses PHPCompatibilityWP for version-specific checks
To check your PHP files for coding standard violations, run:
npm run lint:phpNote: PHP path and extension flags are automatically detected based on your environment. The linting scripts use the scripts/get-php.sh and scripts/get-php-flags.sh helpers to ensure compatibility across different development environments (Local by Flywheel, Homebrew, CI/CD).
PHP Configuration
- Configuration File:
phpcs.xml.dist - Test Version: PHP 8.2-8.3 compatibility
- Standards: WordPress-Extra, WordPress-Docs
- Auto-Detection: PHP binary path and extension flags are automatically detected
- Local development: Uses
-nflag to suppress extension warnings - CI/CD environments: Automatically enables required extensions (
tokenizer,xmlwriter,simplexml)
- Local development: Uses
- Custom Rules:
- Allows array short syntax
- Allows short prefixes for theme-specific functions
- Excludes deprecated sniffs for compatibility
- Theme-specific prefix validation:
WebDevStudios\wdsbt,wds,wdsbt - Text domain validation:
wdsbt
This theme uses ESLint with WordPress coding standards for JavaScript files.
- Configuration: Uses ESLint 9 flat config format (
eslint.config.cjs) - Standards: WordPress ESLint plugin with recommended rules (via compatibility layer)
- Version: ESLint 9.x with
@eslint/eslintrcfor WordPress config compatibility
To check your JavaScript files for coding standard violations, run:
npm run lint:jsNote: This theme uses ESLint 9 with flat config format (eslint.config.cjs). The WordPress ESLint plugin configuration is loaded via the @eslint/eslintrc compatibility layer. Some WordPress rules incompatible with ESLint 9 are automatically disabled.
JavaScript Configuration
- Configuration File:
eslint.config.cjs(ESLint 9 flat config) - Standards: WordPress ESLint plugin recommended rules (via
@eslint/eslintrccompatibility layer) - Special Handling: Webpack configuration files use Node.js environment
- Compatibility: Optimized for WordPress block editor development
- Note: Some WordPress ESLint rules incompatible with ESLint 9 are automatically disabled
The Block Showcase is a powerful development tool that automatically discovers and displays all registered blocks (core WordPress blocks, custom theme blocks, and third-party plugin blocks) in an organized, interactive format. This feature is perfect for developers who want to see all available blocks, their attributes, and preview how they render.
- Automatic Block Discovery: Uses WordPress's
WP_Block_Type_Registryto find all registered blocks - Organized by Category: Blocks are grouped by their WordPress block categories (Text, Media, Design, Widgets, Theme, Embeds, etc.)
- Block Previews: Each block is rendered with example content so you can see how it looks
- Attribute Information: View all block attributes, their types, default values, and available options
- Interactive Accordions: Collapsible sections for easy navigation through block categories
- Security: Only accessible to administrators (
manage_optionscapability)
-
Create a New Page:
- Go to Pages > Add New in your WordPress admin
- Give it a title (e.g., "Block Showcase")
-
Select the Block Showcase Template:
- In the page editor, look for the Page Attributes panel (or Template in the sidebar)
- Select "Block Showcase" from the template dropdown
- Note: This template option is only visible to administrators
-
Publish the Page:
- Click Publish to make the page live
- The page will automatically display all registered blocks using the
[wdsbt_block_showcase]shortcode
The showcase automatically organizes blocks into sections:
-
Core Blocks: All WordPress core blocks, organized by category:
- Text (Paragraph, Heading, List, Quote, Code, etc.)
- Media (Image, Gallery, Audio, Video, etc.)
- Design (Columns, Group, Cover, Separator, Spacer, etc.)
- Widgets (Archives, Calendar, Categories, Latest Posts, etc.)
- Theme (Site Logo, Site Title, Site Tagline, etc.)
- Embeds (YouTube, Twitter, etc.)
- Other Core Blocks (any blocks that don't fit the above categories)
-
WDS BT Custom Blocks: All blocks registered with the
wdsbtnamespace -
Third Party Blocks: Blocks from other plugins, organized by their namespace
For each block, the showcase displays:
- Block Name: The human-readable display name
- Block Identifier: The fully qualified block name (e.g.,
core/paragraph) - Attributes: Expandable details showing:
- Attribute name
- Data type (string, number, boolean, array, object, etc.)
- Default value (if applicable)
- Available options (if the attribute uses an enum)
- Live Preview: The block rendered with example content
The showcase uses intelligent content generation:
- Block Examples: If a block has an
exampleproperty defined, it uses that - Default Content: For core blocks, predefined example content is used
- Default Attributes: For blocks with default attribute values, those are used to generate the preview
- Fallback: If no example or defaults exist, a minimal block markup is generated
- Template Restriction: The Block Showcase template is only available to users with
manage_optionscapability (administrators) - Shortcode Protection: The
[wdsbt_block_showcase]shortcode returns empty content for non-administrators - 404 for Non-Admins: If a non-administrator tries to access a page using the Block Showcase template, they'll see a 404 error
The showcase styling can be customized via the theme's SCSS files:
- Main Stylesheet:
assets/scss/templates/block-showcase.scss - CSS Classes:
.wdsbt-block-showcase- Main container.wdsbt-showcase-section-heading- Section headings (Core Blocks, WDS BT Blocks, etc.).wdsbt-showcase-category- Category containers.wdsbt-showcase-block-card- Individual block cards.wdsbt-showcase-block-title- Block name heading.wdsbt-showcase-block-name- Block identifier code.wdsbt-showcase-block-attributes- Attributes container.wdsbt-showcase-block-preview- Block preview area
- Streaming Block Parser: Uses WordPress 6.9+ streaming block parser for efficient block processing
- WP_Block_Processor: Leverages the efficient
WP_Block_Processorclass for block rendering - KSES Filtering: All block output is properly sanitized using WordPress's KSES system
- Data URI Support: Allows data URIs for images in block previews (temporarily enabled during rendering)
Block not showing in showcase:
- Some blocks (like
core/legacy-widgetandcore/freeform) are intentionally skipped - Blocks that require specific context or configuration may not render properly
- Check that the block is properly registered in WordPress
Template not appearing in dropdown:
- Ensure you're logged in as an administrator
- The template is hidden from non-admin users for security
Shortcode not rendering:
- Verify you have administrator privileges
- Check that the shortcode is placed in an HTML block:
[wdsbt_block_showcase]
WDS BT automatically calculates and stores the dominant color for uploaded images, then uses it as a background placeholder while images load. This improves perceived performance by showing a color-coordinated placeholder instead of a blank space.
- Automatic Color Calculation: When an image is uploaded to the media library, the theme calculates its dominant color using Imagick (if available) or the GD library.
- Color Storage: The dominant color is stored as post meta (
_dominant_color) for each image attachment. - Placeholder Display: When images are displayed, the dominant color is used as a background color, visible until the image fully loads.
- Smooth Transitions: CSS and JavaScript handle smooth fade-in effects when images finish loading.
- Works with all standard WordPress image formats (JPEG, PNG, GIF, WebP)
- Automatically processes images uploaded through the media library
- Compatible with both attachment images and block editor image blocks (
core/imageandcore/cover)
- File Location:
inc/performance/dominant-color-images.php - Color Calculation: Uses Imagick (preferred) or GD library fallback
- Storage: Post meta key
_dominant_color(hex color format, e.g.,#ff0000) - Integration: Works with
wp_get_attachment_image()and block editor image rendering - Performance: Color calculation happens asynchronously during image upload
The dominant color is automatically applied to images. To customize the placeholder behavior, you can:
- Modify CSS: The feature adds a
has-dominant-colorclass to images, which you can style in your theme's SCSS files - JavaScript Events: Images with dominant colors have a
data-dominant-colorattribute for custom JavaScript interactions - Disable for Specific Images: Filter
wp_get_attachment_image_attributesto exclude specific images
- PHP GD extension or Imagick extension (for color calculation)
- WordPress 6.4+ (for block editor support)
Note: Inspired by the WordPress Performance plugin.
WDS BT automatically prioritizes above-the-fold images by adding fetchpriority="high" to the first few images on a page. This signals browsers to load these critical images sooner, improving perceived performance and Largest Contentful Paint (LCP) metrics.
- Image Detection: On singular pages, the theme identifies the first few images (featured image plus up to 3 images from content).
- Priority Assignment: Adds
fetchpriority="high"attribute to these above-the-fold images. - Lazy Loading Removal: Automatically removes
loading="lazy"from prioritized images since they should load immediately. - Compatibility: Works alongside the existing LCP image optimization without conflicts.
- Featured images (post thumbnails)
- Images in content blocks (
core/imageandcore/cover) - Works with both attachment images and block editor image blocks
- File Location:
inc/performance/image-prioritizer.php - Priority Limit: Prioritizes up to 3 images per page (featured image + 2 content images)
- Page Types: Only active on singular pages (posts, pages, custom post types)
- Integration: Works with
wp_get_attachment_image()and block editor image rendering - Compatibility: Checks for existing
fetchpriorityto avoid conflicts with LCP optimization
- LCP Optimization: Focuses on the single Largest Contentful Paint image
- Image Prioritizer: Prioritizes multiple above-the-fold images for broader performance improvement
- Both work together: The LCP image will be prioritized by both systems, ensuring optimal loading
The prioritization happens automatically. To customize:
- Change Priority Limit: Modify the
$limitparameter inget_above_fold_image_ids()function - Exclude Specific Images: Filter
wp_get_attachment_image_attributesto exclude images - Disable for Specific Pages: Use conditional checks in the filter functions
Note: Inspired by the WordPress Performance plugin.
WDS BT automatically generates WebP versions of uploaded JPEG and PNG images. WebP format provides superior compression compared to JPEG and PNG, resulting in smaller file sizes and faster page loads while maintaining image quality.
- Automatic Conversion: When JPEG or PNG images are uploaded, the theme automatically generates WebP versions.
- Multiple Sizes: WebP versions are created for all registered image sizes (thumbnail, medium, large, etc.).
- Storage: WebP files are stored alongside original images with
.webpextension. - Metadata: WebP file paths and URLs are stored in attachment metadata for easy access.
- Input: JPEG and PNG images
- Output: WebP format (85% quality by default)
- Image Sizes: All WordPress registered image sizes (thumbnail, medium, large, full, and custom sizes)
- File Location:
inc/performance/webp-uploads.php - Conversion Method: Uses Imagick (preferred) or GD library fallback
- Quality Setting: 85% compression quality (balance between file size and quality)
- Storage: WebP files stored in same directory as originals with
.webpextension - Metadata Keys:
_webp_file(file path) and_webp_url(URL)
- PHP Extensions: Imagick with WebP support OR GD library with
imagewebp()function - Server Support: WebP format must be supported by your PHP installation
- WordPress: WordPress 6.4+ recommended
The theme provides helper functions to access WebP versions:
// Get WebP URL for an attachment.
$webp_url = \WebDevStudios\wdsbt\get_webp_url( $attachment_id );
// Get WebP file path for an attachment.
$webp_file = \WebDevStudios\wdsbt\get_webp_file( $attachment_id );
// Check if browser supports WebP.
$supports_webp = \WebDevStudios\wdsbt\browser_supports_webp();- Modern browsers (Chrome, Firefox, Edge, Safari 14+) support WebP natively
- The theme adds
data-webpattribute to images for JavaScript-based fallback handling - Original images are always preserved for compatibility
- Quality Setting: Modify the quality parameter (85) in
generate_webp()function - File Naming: WebP files use the same name as originals with
.webpextension - Size Generation: WebP versions are automatically generated for all image sizes
The theme automatically generates WebP versions for existing images in the following scenarios:
- Automatic Regeneration: When image thumbnails are regenerated (e.g., using the "Regenerate Thumbnails" plugin), WebP versions are automatically created
Method 1: WordPress Admin (Easiest)
- Go to Tools > WDSBT Settings in your WordPress admin
- Click the "Regenerate WebP for All Images" button
- Confirm the action
- Wait for the process to complete (may take several minutes for large media libraries)
Method 2: WP-CLI (Recommended for Large Sites)
# Regenerate WebP for all images
wp webp regenerate --all
# Regenerate WebP for a specific attachment
wp webp regenerate --attachment-id=123Method 3: PHP Function (For Developers)
// Regenerate WebP for a specific attachment
\WebDevStudios\wdsbt\regenerate_webp_for_attachment( $attachment_id );
// Bulk regeneration for all images
$attachments = get_posts( array(
'post_type' => 'attachment',
'post_mime_type' => array( 'image/jpeg', 'image/png' ),
'posts_per_page' => -1,
'fields' => 'ids',
) );
foreach ( $attachments as $attachment_id ) {
\WebDevStudios\wdsbt\regenerate_webp_for_attachment( $attachment_id );
}Note: Inspired by the WordPress Performance plugin.
This theme automatically registers block pattern categories based on subfolders in the patterns/ directory. To add a new pattern category:
- Create a new subfolder inside
patterns/(e.g.,patterns/cards/). - Place your pattern PHP files in that subfolder.
- In each pattern file, set the
Categoriesheader to the folder name (e.g.,Categories: cards).
The category will be registered automatically and available in the block editor. No manual code changes are needed to add new pattern categories.
WDS BT integrates automated workflow actions to maintain high standards of code security, quality, and accessibility. Accessibility checks are built into the development process, ensuring that websites developed with WDS BT comply with WCAG 2.2 standards. This proactive approach reflects WDS BT's commitment to inclusivity and usability for all users.
Accessibility Test (npm run a11y)
-
Purpose: To ensure compliance with Web Content Accessibility Guidelines (WCAG).
-
Running the A11y Test Script:
- Accessibility tests utilize
pa11y-ci, which can be run using:
npm run a11y
- Accessibility tests utilize
-
How It Works:
- URL Prompt: The script prompts you for a site URL. Leaving it blank defaults to https://wdsbt.local.
- Sitemap Detection: It checks for a sitemap at
[URL]/wp-sitemap.xml. - Running Tests:
- If a sitemap is found,
pa11y-ciruns on each sub-sitemap. - If no sitemap is found,
pa11y-ciruns on the main page.
- If a sitemap is found,
Example Output:
$ npm run a11y Please enter the URL to test for accessibility (leave blank to use your local: https://wdsbt.local): > https://example.com Sitemap found at https://example.com/wp-sitemap.xml. Running pa11y-ci on the sitemap... [output from pa11y-ci]
If no sitemap is found:
$ npm run a11y Please enter the URL to test for accessibility (leave blank to use your local: https://wdsbt.local): > https://example.com No sitemap found at https://example.com/wp-sitemap.xml. Running pa11y-ci on the main page... [output from pa11y-ci]
-
Reporting: Any accessibility violations are displayed in the console for immediate review.
Security Check (security.yml)
- Purpose: Detect vulnerabilities in dependencies.
- Implementation: Uses
symfonycorp/security-checker-action@v5for security scans. - Concurrency: Ensures only one check runs per branch at a time, canceling previous runs.
- Execution Conditions:
- Runs unless:
- It is a scheduled event (
schedule), and - The repository owner is "webdevstudios."
- It is a scheduled event (
- Runs unless:
Code Quality Check (assertions.yml)
- Purpose: Enforce adherence to WordPress coding standards.
- Configuration: Quality checks run based on
assertions.yml. - Requirement: All detected violations must be fixed before commits are accepted.
- Report Visibility: Reports appear in the command-line interface (CLI) during checks.
WDS-BT enforces strict Lefthook integration with pre-commit, pre-receive, pre-push, and push hooks. These ensure that all automated quality checks (linting, formatting, security, accessibility) are executed before commits and pushes.
- Pre-Commit Hook: Runs quality checks before allowing a commit.
- Pre-Receive Hook: Ensures compliance before WDS-BT accepts the push.
- Pre-Push Hook: Runs additional validations before pushing changes to remote.
- Push Hook: Enforces project-wide integrity checks before finalizing a push.
Bypassing Lefthook (--no-verify) is strictly prohibited, ensuring that all enforced checks are properly executed.
Integration Process with LeftHook
- Commit Changes: Modify code as needed.
- Automated Checks on Commit: LeftHook triggers accessibility and code quality checks automatically.
- Review Reports: Examine any violations or issues reported.
- Fix Issues: Resolve identified problems before proceeding.
- Recommit: Once issues are fixed, recommit changes.
- Passing Commit: Commits must pass all checks before acceptance.
- Create a Pull Request (PR): When creating a PR, checks run on the PR branch.
- Review PR Checks: Ensure all checks pass before merging.
This project uses rimraf in npm scripts instead of rm -rf to ensure compatibility across Windows, macOS, and Linux. All contributors can use the provided npm scripts without needing Git Bash or WSL on Windows.
If you add new scripts that need to remove files or directories, please use rimraf instead of rm -rf.
The project automatically detects the PHP binary path for cross-platform compatibility (Mac, Linux, CI/CD). The detection scripts (scripts/get-php.sh and scripts/get-php.js) check common paths:
/opt/homebrew/bin/php(Homebrew on Apple Silicon Mac)/usr/local/bin/php(Homebrew on Intel Mac / Linux)/usr/bin/php(Standard Linux path)php(Fallback to PATH)
For CI/CD environments (like Buddy or GitHub Actions): You can set the PHP_BIN environment variable to override auto-detection:
export PHP_BIN=/usr/bin/phpThe project automatically handles PHP extensions based on the environment:
- Local Development: Uses
-nflag to suppress extension warnings (useful for Local by Flywheel environments with mismatched extensions) - CI/CD Environments: Automatically enables required extensions (
tokenizer,xmlwriter,simplexml) for PHPCS and other tools
The scripts/get-php-flags.sh script detects the environment and applies the appropriate flags. This ensures builds work correctly across different environments without manual configuration.
Your contributions and support tickets are welcome. Please see our contributing guidelines before submitting a pull request.
WDS BT is free software, and is released under the terms of the GNU General Public License version 2 or any later version. See LICENSE.md for complete license.
The WDS-BT theme was initially inspired by the Powder theme. We acknowledge and thank the creators of Powder for their work.
