Changelog
The VMP Security changelog records every released version of the plugin: new features, bug fixes, and security updates. This article explains how to find it and how to read it.
In This Article
- Where to find the changelog
- Reading a changelog entry
- Change types
- Breaking changes and deprecations
Where to find the changelog
Two places, each suited to a different need:
- The plugin’s
readme.txt. Every release is recorded under the “Changelog” section ofreadme.txt, shipped inside the plugin folder. WordPress’ Plugins → Installed Plugins screen renders this when you click View details on the plugin row. - On the WordPress plugin directory page. The Changelog tab on the plugin’s wordpress.org page mirrors the readme content and is publicly accessible without signing in.
There is no separate “Changelog” tab inside the VMP Security admin pages.
Reading a changelog entry
Each entry has:
- A version number in semantic-versioning style (
MAJOR.MINOR.PATCH). - A release date.
- A list of changes, each tagged with a change type.
Entries are written for the operator, not the developer — the focus is on what changed for someone running the plugin, not on the implementation. Where a change is implementation-only (refactoring, code cleanup), it is grouped under “Internal” rather than spelled out.
Change types
- Added. A new feature or option that did not exist before.
- Changed. An existing feature whose behavior has been adjusted but not removed.
- Fixed. A bug fix.
- Security. A change that addresses a security issue in the plugin itself. Always worth reading, even if you do not plan to update right away.
- Deprecated. A feature or API that still works but is on a known path to removal. Continue to migrate away from these.
- Removed. Something that previously existed and is now gone. The entry will normally name a successor or migration path.
- Internal. Refactoring or behind-the-scenes work with no operator-visible effect. Listed for completeness; usually safe to skip.
Breaking changes and deprecations
We try hard to avoid breaking changes within a major version. When one is unavoidable, we follow this pattern:
- Mark the affected feature as Deprecated in a minor release. The deprecation notice is logged when the feature is used and shown in the WordPress admin.
- Wait at least one major version, usually two, before removing the deprecated feature. This gives integrators time to migrate.
- When the feature is finally removed, mark it Removed in the next major release’s changelog with a clear migration path.
If you have automated tooling that depends on the plugin’s API or behavior, subscribing to changelog updates — either by RSS or by checking the changelog before each upgrade — is the cheapest way to avoid surprise breakage.