/handbook/developing-for-block-editor-and-site-editor/version-control-and-compatibility-in-gutenberg-block-development/
What We Do
Digital Platform MigrationsKey SolutionsManaged ServicesStaffing SolutionsIndustriesProducts
OnePress
Unify multiple brands on one governed WordPress platform.
Design & UI/UX
Gutenberg-native UX, UI, and design systems for visitors and editors.
WordPress Modernization
Modernize WordPress for better performance, architecture, and AI readiness.
WordPress as a DXP
WordPress as a composable DXP when monolithic systems no longer cut it.
Headless WordPress
Omnichannel content delivery without sacrificing marketing autonomy.
Frappe/ERPNext
Build scalable ERP and custom applications, from implementation to ongoing support.
Discovery
Strategic consultancy & project roadmap
Growth Services
On demand development & consultation
Site Maintenance
Annual maintenance. Done for you
QE Services
Testing across SDLC for assured quality
Hosting Migration
Move to a performant hosting with zero downtime
WooCommerce
Enterprise commerce delivered without lock-in
AI
Unlock real use cases and integrations
All Services
A suite of services for any need
Technology STACK
eCommerce
Scale your e-commerce with WooCommerce, integrations, and custom extensions for growth.
EasyEngine
Server management tool that makes using WordPress on Nginx easy.
Web Auditor
Performance Audit & Insights for your Website.
rtMedia
A complete media management plugin for WordPress.
Resources
About Us
CLEAR
Resources Developing for Block Editor and Site Editor Version control and compatibility Gutenberg versioning & compatibility
Topics
On this page
Use Semantic Versioning for Block Updates
Example for Semantic Versioning in Block Development
Best Practices
Maintain backward compatibility When Possible
Strategies for Maintaining Backwards Compatibility
Communicate Breaking Changes
Strategies for Communicating Breaking Changes:
Summary of Best Practices for Gutenberg Block Development
Last updated on Apr 1, 2026
Version Control and Compatibility in Gutenberg Block Development
In Gutenberg block development, version control, and compatibility are essential practices to ensure the stability, maintainability, and growth of your custom blocks. Below is an in-depth explanation of the topics you mentioned, including how to manage semantic versioning, backward compatibility, and communicating breaking changes effectively.
Use Semantic Versioning for Block Updates
Semantic Versioning (SemVer) is a versioning scheme that conveys the nature of changes in your software. It helps developers and users understand the impact of an update on their projects. In Gutenberg block development, semantic versioning is crucial when releasing new versions of a block, especially when your blocks are used in live websites or by other developers.
Semantic versioning follows the format:
MAJOR.MINOR.PATCH
- MAJOR version (
1.x.x) is incremented when there are incompatible changes, i.e., breaking changes.
- MINOR version (
x.1.x) is incremented when you add functionality in a backward-compatible manner.
- PATCH version (
x.x.1) is incremented when you make backward-compatible bug fixes.
Example for Semantic Versioning in Block Development
- 1.0.0: Initial release of a custom block.
- 1.1.0: You added a new setting or inspector control to the block, but it doesn’t break existing functionality.
- 1.1.1: You fixed a minor bug in how the block handles its attributes but didn’t alter its features.
- 2.0.0: You made a significant change to the block’s attributes, which causes existing content to break unless migrated.
Best Practices
- Use MAJOR versions when you make changes to a block’s structure or attributes that can’t be automatically migrated. For example, renaming block attributes or changing the block’s rendering logic.
- Use MINOR versions for non-breaking features like adding new controls or blocks.
- Use PATCH versions for bug fixes that don’t affect the block’s compatibility with existing content.
Maintain backward compatibility When Possible
Backward compatibility means ensuring that existing instances of a block continue to function properly even after the block is updated. In WordPress, where blocks are often used on thousands of pages, this is crucial to avoid breaking content across sites. Here’s how you can maintain compatibility in your Gutenberg block development:
Strategies for Maintaining Backwards Compatibility
1. Preserve Existing Attributes:
When you add new features or attributes to a block, ensure that the existing attributes are preserved. Don’t remove or rename attributes unless necessary. For instance, if you want to change how a block stores its color settings, you could introduce a new attribute for the updated logic while still allowing the old attribute to work.
attributes: {
oldColor: {
type: 'string',
},
newColor: {
type: 'string',
},
}
2. Migrate Old Block Versions:
If you need to change how block attributes are structured, use a block deprecation or migration process. You can register deprecated versions of a block so that older versions still render correctly, while newer content uses the updated block.
const deprecatedBlock = {
attributes: {
oldColor: { type: 'string' },
},
save( { attributes } ) {
return <p style={{ color: attributes.oldColor }}>Deprecated block version</p>;
},
};
registerBlockType( 'my-plugin/block', {
deprecated: [ deprecatedBlock ],
attributes: {
newColor: { type: 'string' },
},
save( { attributes } ) {
return <p style={{ color: attributes.newColor }}>New block version</p>;
},
});
3. Use Transformations:
Use block transforms to allow content created with old blocks to be automatically converted to new blocks. For example, if you want to replace a paragraph block containing code with a preformatted block, you can create a transformation.
transforms: {
from: [
{
type: 'block',
blocks: [ 'core/paragraph' ],
transform: ( { content } ) => {
return createBlock( 'core/preformatted', { content } );
},
},
],
}
4. Check for Feature Support:
Check if the user’s theme supports specific features (like wide alignment) before applying them. This ensures that the block remains compatible with themes that don’t offer these features.
supports: {
align: [ 'wide', 'full' ],
}
Communicate Breaking Changes
Breaking changes are unavoidable at times, but they should be communicated to other developers and users who rely on your blocks. Failure to communicate breaking changes can lead to significant disruptions in how the block content is displayed or edited.
Strategies for Communicating Breaking Changes:
1. Changelog Documentation:
- Always maintain a clear and thorough changelog. The changelog should explain the changes in each version and note any breaking changes, along with instructions on how users can update or migrate their content.
- Format your changelog with headers like
Added,Changed,Deprecated, andRemoved.
Example:
[2.0.0] - 2024-01-15
Added
- Support for new block alignment options.
Changed
- Updated block attributes for color settings (old `textColor` now stored as `fontColor`).
Deprecated
- The old `textColor` attribute is deprecated but still supported for backward compatibility.
Removed
- Removed support for the `shadow` attribute. Please use `boxShadow` instead.
2. Version Announcements:
When releasing a new major version with breaking changes, announce the update via appropriate channels (GitHub releases, WordPress.org, email newsletters) with detailed information on what’s changed and why. If possible, provide migration guides for developers to update their blocks.
3. Use __experimental Prefix for Experimental Features:
If you’re introducing experimental features that may change, prefix them with __experimental. This signals to developers that these features are not finalized and may break or be removed in future releases.
Example:
attributes: {
__experimentalNewFeature: {
type: 'boolean',
},
}
4. Deprecate Gradually:
Instead of removing features or attributes abruptly, first, mark them as deprecated and continue to support them for a few versions before fully removing them. Deprecation allows users to transition smoothly to the new approach.
Example:
deprecated: [
{
attributes: {
oldAttribute: { type: 'string' },
},
save( { attributes } ) {
return <p>{ attributes.oldAttribute }</p>;
},
},
],
Summary of Best Practices for Gutenberg Block Development
- Semantic Versioning: Use `MAJOR.MINOR.PATCH` for managing block versions. Use major versions for breaking changes, minor for new features, and patches for bug fixes.
- Backward Compatibility: Maintain compatibility with older versions of your block by preserving attributes, using deprecated blocks, and creating transformations when necessary.
- Communicating Changes: Document changes in your changelog, announce breaking changes, and use deprecations before removing features.
By following these best practices, you ensure that your Gutenberg blocks are stable, maintainable, and easy to update, all while keeping your users informed of important changes.
Version control and compatibility
PREVIOUS
Credits
Shreya Agarwal
Author
Shreya Agarwal
Author
Shreya Agarwal is a Growth Engineer at rtCamp, she brings active, hands-on WordPress development credentials to everything she writes and reviews. A WordPress Core Contributor with merged pull requ…
Good Work. Good People.
Industry partnerships
Compliance certifications
United States India
© rtCamp Inc. since 2009. All rights reserved.
Terms of Service · Privacy Policy · Trust Center
Company
Solutions
Subscribe to Campfire for fresh insights and stories from people behind rtCamp
Δ
Email(Required)
Submit
United States India
© rtCamp Inc. since 2009. All rights reserved.
Terms of Service · Privacy Policy · Trust Center
Cookie Consent
We value your privacy
We use cookies to give you the best possible experience. By clicking “Accept,” you consent to our use of cookies to improve site functionality, analyze usage, and personalize content and communications. Your privacy matters to us, and we are committed to handling your data responsibly and transparently. Please check our Privacy Policy for more details.
Manage PreferencesDon’t AllowAllow All
Why do we use cookies?
×
By clicking "Accept" or "Decline All" at the bottom, you consent to the use of cookies and other tools as described in our Cookie Policy in accordance with your settings and accept our Terms of Service.
Toggle EssentialEssential
Essential cookies enable basic functions and are necessary for the proper function of the website.
Name
Description
Duration
Geolocation Config
This cookie is used to store the consent settings based on the visitor's location.
30 days
Cookie Preferences
This cookie is used to store the user's cookie consent preferences.
30 days
Toggle CloudFlareCloudFlare
CloudFlare provides web performance and security solutions, enhancing site speed and protecting against threats.
Service URL: developers.cloudflare.com (opens in a new window)
Name
Description
Duration
cf_clearance
Whether a CAPTCHA or Javascript challenge has been solved.
session
Toggle CommentsComments
These cookies are needed for adding comments on this website.
Name
Description
Duration
comment_author
Used to track the user across multiple sessions.
Session
comment_author_email
Used to track the user across multiple sessions.
Session
comment_author_url
Used to track the user across multiple sessions.
Session
Toggle GodamGodam
GoDAM" is primarily a specialized WordPress plugin and media management service designed to enhance video hosting, marketing, and asset management directly within the WordPress dashboard.
Service URL: godam.io (opens in a new window)
Name
Description
Duration
user_image
Temporarily stores the path to the user's avatar or profile picture for quick rendering in the website header.
session
user_id
Stores the numerical ID of the logged-in user to maintain session continuity and basic site operations.
session
full_name
Stores the logged-in user's display name to personalize the site interface without needing database queries.
session
system_user
First-party cookie used to store basic application state identifying the current system user role.
session
sid
A generic session ID cookie used to maintain user state and functionality as the visitor navigates through the site.
session
Toggle Google reCAPTCHAGoogle reCAPTCHA
Google reCAPTCHA helps protect websites from spam and abuse by verifying user interactions through challenges.
Name
Description
Duration
_GRECAPTCHA
Google reCAPTCHA sets a necessary cookie (_GRECAPTCHA) when executed for the purpose of providing its risk analysis.
179 days
Toggle Google Tag ManagerGoogle Tag Manager
Google Tag Manager simplifies the management of marketing tags on your website without code changes.
Name
Description
Duration
cookiePreferences
Registers cookie preferences of a user
2 years
td
Registers statistical data on users' behaviour on the website. Used for internal analytics by the website operator.
session
Toggle StatisticsStatistics
Statistics cookies collect information anonymously. This information helps us understand how visitors use our website.
Toggle Factors AIFactors AI
Factors.ai is a B2B account intelligence and marketing analytics platform that helps Go-To-Market (GTM) teams identify anonymous website visitors, track buyer journeys, and measure the ROI of marketing campaigns.
Service URL: www.factors.ai (opens in a new window)
Name
Description
Duration
_fuid
It is sent to capture session details and track user behavior across your website to provide behavioral data and intent signals.
1 Year
Toggle Google AnalyticsGoogle Analytics
Google Analytics is a powerful tool that tracks and analyzes website traffic for informed marketing decisions.
Service URL: policies.google.com (opens in a new window)
Name
Description
Duration
FPGSID
Stores a session or user identifier to track how visitors interact with a website. This helps Google Analytics measure website performance, user engagement, and usage patterns.
Session
FPLC
Used by Google Analytics to link visitor interactions and sessions across multiple related domains.
20 hours
FPID
A server-side Google Analytics cookie used as an alternative user identifier when third-party cookies are restricted.
2 years
_ga
ID used to identify users
2 years
_ga_
ID used to identify users
2 years
Toggle Jetpack StatsJetpack Stats
Jetpack's built-in visitor analytics. It records page views, referring sites, search terms, and outbound link clicks, and also carries the shared visitor-tracking library used by Jetpack Instant Search and WooCommerce Analytics.
Service URL: automattic.com (opens in a new window)
Name
Description
Duration
tk_aip
Stores a list of anonymous visitor IDs so they can be merged into one identity once a visitor is recognized.
Up to 5 years
tk_tc
Used once per page load to work out which cookie domain the Tracks library should use, then removed as soon as it's read back.
Session (deleted immediately after use)
tk_qs
Queues analytics events for Jetpack's Tracks library so none are lost if the page closes before they can be sent.
30 minutes
tk_ai
Stores a randomly-generated anonymous visitor ID so Jetpack's Tracks analytics library can link tracking events to the same visitor.
Session in wp-admin; up to 5 years on the frontend
Toggle Microsoft ClarityMicrosoft Clarity
Clarity is a web analytics service that tracks and reports website traffic.
Service URL: clarity.microsoft.com (opens in a new window)
Name
Description
Duration
CLID
Identifies the first-time Clarity saw this user on any site using Clarity.
12 months
ANONCHK
Indicates whether MUID is transferred to ANID, a cookie used for advertising. Clarity doesn't use ANID and so this is always set to 0.
Session
_clck
Persists the Clarity User ID and preferences, unique to that site is attributed to the same user ID.
12 months
_clsk
Connects multiple page views by a user into a single Clarity session recording.
12 months
Toggle Parse.lyParse.ly
Parse.ly is a content analytics platform that helps publishers optimize audience engagement and content performance.
Name
Description
Duration
_parsely_session
JSON document storing information identifying a browsing session according to Parsely’s proprietary definition
30 minutes
_parsely_visitor
JSON document uniquely identifying a browser and counting its sessions
13 months
cookies.js_dtest
This cookie determines whether the browser accepts cookies.
session
Toggle MarketingMarketing
Marketing cookies are used to follow visitors to websites. The intention is to show ads that are relevant and engaging to the individual user.
Toggle Bing / MicrosoftBing / Microsoft
Bing, powered by Microsoft, is a search engine providing web, image, video, and map search capabilities.
Name
Description
Duration
MR
Used to collect information for analytics purposes.
6 months
ANONCHK
Used to store session ID for a users session to ensure that clicks from adverts on the Bing search engine are verified for reporting purposes and for personalisation
10 minutes
SM
Used by Microsoft in synchronizing the MUID across multiple Microsoft domains to track users for advertising.
session
MUID
Identifies unique web browsers visiting Microsoft sites. These cookies are used for advertising, site analytics, and other operational purposes.
1 year
Toggle DoubleClick/Google MarketingDoubleClick/Google Marketing
A comprehensive digital advertising platform for managing campaigns, optimizing performance, and analyzing audience data.
Name
Description
Duration
IDE
This cookie is used for targeting, analyzing and optimisation of ad campaigns in DoubleClick/Google Marketing Suite
2 years
ar_debug
Store and track conversions
Persistent
Toggle LinkedInLinkedIn
LinkedIn is a professional networking platform for job seekers, employers, and industry connections.
Name
Description
Duration
bscookie
Used by LinkedIn to track the use of embedded services.
1 year
AnalyticsSyncHistory
Used to store information about the time a sync with the lms_analytics cookie took place for users in the Designated Countries
30 days
bcookie
Used by LinkedIn to track the use of embedded services.
1 year
li_sugr
Used to make a probabilistic match of a user's identity outside the Designated Countries
90 days
lidc
Used by the social networking service, LinkedIn, for tracking the use of embedded services.
1 day
UserMatchHistory
Used by LinkedIn Ads to synchronize and match user IDs across different ad networks and data providers.
30 days
Toggle LinkedIn InsightLinkedIn Insight
LinkedIn Insight is a web analytics service that tracks and reports website traffic.
Service URL: www.linkedin.com (opens in a new window)
Name
Description
Duration
li_sugr
Used to make a probabilistic match of a user's identity.
90 days
lidc
Used for routing and session management.
24 hours
Toggle LiveIntentLiveIntent
LiveIntent provides a platform for email advertising and identity-driven marketing solutions.
Name
Description
Duration
_lc2_fpi_js
Companion cookie to _lc2_fpi used by JavaScript to facilitate cross-domain ad tracking and user identification.
1 year
_lc2_fpi
First-party tracking cookie usually associated with LiveRamp to identify users across devices for targeted advertising.
1 Year
_li_ss
Sets a unique ID for the visitor, that allows third party advertisers to target the visitor with relevant advertisement. This pairing service is provided by third party advertisement hubs, which facilitates real-time bidding for advertisers.
1 month
lidid
Collects data on visitors' behaviour and interaction - This is used to make advertisement on the website more relevant. The cookie also allows the website to detect any referrals from other websites.
2 years
Toggle Cookie PolicyCookie Policy
You can find more information in our Privacy Policy.
Allow AllDecline All
Accept