-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
94 lines (62 loc) · 3.29 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
=== WP Since ===
Contributors: pbiron
Tags: wp_cli
Requires at least: 4.0
Tested up to: 4.9.7
Stable tag: 0.2
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Z6D97FA595WSU
List changes in a WP version.
== Description ==
[WP_CLI](https://make.wordpress.org/cli/handbook/) version of [https://developer.wordpress.org/reference/since/<version>](https://developer.wordpress.org/reference/since/4.7.0).
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.<br />
Default: the current version.<br />
[--change\_type=<change\_type>]: type of change to list changes for. One of (any | introduced | modified | deprecated ).<br />
Default: any.<br />
[--post\_type=<type>]: post\_type to list changes for. One of (any | class | method | function | hook).<br />
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
1. Activate the plugin through the 'Plugins' menu in WordPress
1. install via [GitHub Updater](https://github.com/afragen/github-updater)
1. Go to Settings > GitHub Updater in the WordPress admin
1. Click on the "Install Plugin" tab
1. Enter the URL for this repo in the "Plugin URI" field
1. Click "Install Plugin"
1. Activate this plugin
Regardless of the method used to install this plugin, you must then:
1. Activate the phpdoc-parser plugin
1. 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`.
1. 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](https://meta.trac.wordpress.org/ticket/2847)
(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 ===
* Initial commit