https://github.com/verygoodplugins/edd-changelog-badges
Easy Digital Downloads changelog shortcode with badges
https://github.com/verygoodplugins/edd-changelog-badges
Last synced: 4 months ago
JSON representation
Easy Digital Downloads changelog shortcode with badges
- Host: GitHub
- URL: https://github.com/verygoodplugins/edd-changelog-badges
- Owner: verygoodplugins
- Created: 2025-02-13T09:48:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-03T10:20:36.000Z (12 months ago)
- Last Synced: 2025-06-03T21:28:15.728Z (12 months ago)
- Language: PHP
- Size: 12.7 KB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# EDD Changelog Badges
A WordPress plugin that adds a beautiful changelog display shortcode for Easy Digital Downloads products.
## Features
- Adds `[edd_changelog]` shortcode to display product changelogs
- Automatically adds visual badges for New, Improved, Fixed, and Dev changes
- Styled layout with clear visual hierarchy
- Compatible with EDD Software Licensing changelog field
## Installation
1. Upload the `edd-changelog` folder to your `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Use the shortcode `[edd_changelog id="123"]` in your posts/pages where 123 is your EDD product ID
## Usage
Basic usage: `[edd_changelog id="123"]`
The plugin will automatically style changelog entries based on these prefixes:
- Added: Shows a green "New" badge
- Improved: Shows a blue "Improved" badge
- Fix: Shows an orange "Fixed" badge
- Developer: Shows a gray "Dev" badge
## Customization
The plugin uses the `edd_changelog_badge_configs` filter to allow for custom badge configurations.
Example:
```php
add_filter( 'edd_changelog_badge_configs', function( $configs ) {
$configs['added']['emoji'] = '🚀';
$configs['improved']['emoji'] = '🔄';
$configs['fix']['emoji'] = '🐛';
$configs['developer']['emoji'] = '👨💻';
$configs['custom'] = array(
'prefix' => 'Custom',
'badge_text' => 'Custom',
'emoji' => '🔧',
'class' => 'custom',
'ltrim' => false,
'color' => '#333333',
);
return $configs;
} );
```
Each badge config accepts these parameters:
- `prefix`: Text to match at the start of changelog items
- `badge_text`: Text displayed on the badge
- `emoji`: Emoji shown before badge text
- `class`: CSS class for styling the badge
- `ltrim`: Text to remove from the start of matched items (optional)
## Changelog
= 1.2.0 - Mar 1, 2025 =
* Added security badge
* Added color as a parameter to the badge configs
* Improved - Updated plugin slug to `edd-changelog-badges` to avoid conflicts with the [EDD Changelog plugin](https://wordpress.org/plugins/edd-changelog/)
* Improved - Badge output is properly escaped
* Improved - Default badge colors are updated for AA color contrast reqirements
= 1.1.0 - Feb 13, 2025 =
* Added `edd_changelog_badge_configs` filter to allow for custom badge configurations
= 1.0.0 - Feb 13, 2025 =
* Initial release