PHPackages                             mjkhajeh/changelog - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. mjkhajeh/changelog

ActiveLibrary[Utility & Helpers](/categories/utility)

mjkhajeh/changelog
==================

A lightweight WordPress admin changelog viewer for plugins and themes.

v1.0.0.1(today)02↑2900%MITPHPPHP >=7.4

Since Jun 10Pushed todayCompare

[ Source](https://github.com/mjkhajeh/changelog)[ Packagist](https://packagist.org/packages/mjkhajeh/changelog)[ RSS](/packages/mjkhajeh-changelog/feed)WikiDiscussions main Synced today

READMEChangelogDependenciesVersions (3)Used By (0)

MJ Changelog
============

[](#mj-changelog)

A lightweight WordPress admin changelog viewer for plugins and themes.

`MJ\Changelog\AbstractChangelog` lets you add a dedicated changelog page to the WordPress admin area and show update notices after a product version changes. Changelog entries are stored as simple JSON files, so releases can be documented without creating custom database tables.

Features
--------

[](#features)

- Adds a WordPress admin submenu page for product changelogs.
- Reads changelog data from versioned JSON files.
- Displays versions in a sidebar and changelog items in the main panel.
- Shows an admin update notice for new versions.
- Supports custom labels through WordPress translation functions.
- Includes ready-to-use CSS and JavaScript assets.
- Works with plugins, themes, and other WordPress modules.

Requirements
------------

[](#requirements)

- PHP 7.4 or higher.
- WordPress with admin access.
- jQuery, provided by WordPress admin by default.

Installation
------------

[](#installation)

### Composer

[](#composer)

After the package is published on Packagist, install it with Composer:

```
composer require mj/changelog
```

Then load Composer's autoloader in your plugin or theme:

```
require_once __DIR__ . '/vendor/autoload.php';
```

Replace `mj/changelog` with the final package name used on Packagist.

### Manual Installation

[](#manual-installation)

You can also copy these files into your plugin or theme:

```
AbstractChangelog.php
assets/css/changelog.min.css
assets/js/changelog.js

```

Then include the abstract class manually:

```
require_once __DIR__ . '/path/to/AbstractChangelog.php';
```

Basic Usage
-----------

[](#basic-usage)

Create a class that extends `MJ\Changelog\AbstractChangelog`, configure the static properties, return translated labels from `i18n()`, and call `init()`.

```