Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 3.39 KB

README.md

File metadata and controls

93 lines (61 loc) · 3.39 KB
Raw

WP Since

List changes in a WP version.

Description

WP_CLI version of https://developer.wordpress.org/reference/since/<version>.

Must be run on a local install, and will not run against the live DevHub.

Options

$ wp since [<version>] [--change_type=<change_type>] [--post_type=<type>]

    [<version>]: the version to list changes for.
        Default: the current version.
    [--change_type=<change_type>]: type of change to list changes for. One of (any | introduced | modified | deprecated).
        Default: any.
    [--post_type=<type>]: post_type to list changes for. One of (any | class | method | function | hook).
        Default: any.

Examples

List all changes in current version

$ wp since

List all changes in version x.y.z

$ wp since x.y.z

List changes introduced in version x.y.z

$ wp since x.y.z --change_type=introduced

List changes modified in current version

$ wp since --change_type=modified

List all changes to hooks in version x.y.z

$ wp since x.y.z --post_type=hook

List all deprecated functions in version x.y.z

$ wp since x.y.z --change_type=deprecated --post_type=function

Installation

You can install this plugin by one of two methods:

  1. install via the zip file
    1. Unzip the zip file into the /wp-content/plugins/ directory
    2. Activate the plugin through the 'Plugins' menu in WordPress
  2. install via GitHub Updater
    1. Go to Settings > GitHub Updater in the WordPress admin
    2. Click on the "Install Plugin" tab
    3. Enter the URL for this repo in the "Plugin URI" field
    4. Click "Install Plugin"
    5. Activate this plugin

Regardless of the method used to install this plugin, you must then:

  1. Activate the phpdoc-parser plugin
  2. slurp up the current WP sources via: $ wp parser create
    • If you've already slurped the sources before activating this plugin for the 1st time, then the first time you run $ wp since it will do a 1-time augmentation of the the data generated by $ wp parser create.
  3. Once the sources are slurped, you can then deactive phpdoc-parser if you want.

Minimum Requirements

  • Whatever the requirements to run the wporg-developer theme and phpdoc-parser plugin are (I'm not sure what they are, I've tested with various 4.8 releases/PHP 5.4 and 4,9.[6|7]/PHP 5.6.36.
  • The wporg-developer theme (with the patch in the meta.trac ticket at allow filtering of @since tax archive by the type of change (or it's equivalent) applied) must be active.

Changelog

0.2

  • Added 'Deprecated' change_type
  • General code cleanup

0.1.1

  • Added check that wporg-developer, or child theme thereof, is active

0.1.0

  • Initial commit

Ideas?

Please let me know by creating a new issue and describe your idea.
Pull Requests are welcome!

Buy me a beer

If you like this plugin, please support it's continued development by buying me a beer.