WordPress Blocks Plugin

Appearance

Upgrading ​

This guide covers breaking changes between versions of the block plugin. If you are upgrading from a version prior to 1.x, you will need to follow the instructions below.

Upgrading from 0.x to 1.x ​

Changes to the block class ​

As part of the upgrade to 1.x of the block plugin, the base block class now includes the Trait_Has_Modifier_Classes trait. This trait is used to add modifier classes to the block.

This change breaks existing blocks due to the requirement of a new default-wrapper.php template for blocks. In order to upgrade, you will need to add the following function declaration to any existing block classes created prior to 1.x:

php
/**
 * {@inheritdoc}
 */
protected function use_default_wrapper_template(): bool {
    return false;
}

This ensures that the block will not use the default wrapper template.

Rector ruleset ​

We have created a Rector ruleset to help you upgrade your blocks. This can be used to automatically make your blocks compatible with the new version.

Installation ​

You can install this ruleset by running the following command:

bash
composer require --dev creode/wordpress-blocks-rector

Usage ​

Once done you need to run the following command to upgrade your blocks, take specific note of the {theme-name} placeholder which should be replaced with the name of your WordPress theme:

bash
vendor/bin/rector process wp-content/themes/{theme-name} --config=vendor/creode/wordpress-blocks-rector/config/blocks-1-0.php

The rector project can be found here: https://github.com/creode/wordpress-blocks-rector.

This will automatically make your blocks compatible with the new version.

Uninstallation ​

After running the command, you can uninstall the ruleset by running the following command:

bash
composer remove --dev creode/wordpress-blocks-rector