/
readme.txt
123 lines (83 loc) · 4.12 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
=== WCM Current Admin Info ===
Contributors: F J Kaiser, stephenharris
Tags: debug, globals, hooks, admin, current screen, contextual help, development, debug
Tested up to: 4.1
Stable tag: 2.0
Requires at least: 3.5
License: MIT
License URI: http://www.tldrlegal.com/license/mit-license
Developer info about the current admin screen, its globals and contextual hooks at your finger tips.
== Description ==
WCM Current Admin Info displays info about globals, contextual hooks and the current admin screen in new tabs in the »Contextual Help«-panel in the upper right corner of an admin screen.
= What is WCM? =
WeCodeMore (WCM) is your label for high quality WordPress code from renowned authors.
If you want to get updates, just follow us on…
* <a href="https://plus.google.com/b/109907580576615571040/109907580576615571040/posts">our page on Google+</a>
* <a href="https://github.com/wecodemore">our GitHub repository</a>
Based on an idea by Stephen Harris / @stephenharris
= Currently available info tabs =
* Contextual hooks - all hooks that have »context«, the `$hook_suffix` in their name.
* Set Globals: Arrays/Objects are hidden and shown on click (js).
* Current screen info: Everything that the `$current_screen` object contains and isn't private.
== Frequently Asked Questions ==
= How do I extend the plugin? =
Write a normal plugin with a plugin header.
Then write a simple class that extends the `WCM\CurrentAdminInfo\AbstractScreenData` class.
Hook that with a callback into `plugins_loaded`. There will automatically be a new tab added
to the help screen tabs that is named like your class.
Your class needs only one method:
* Named `collect()` and does nothing than collecting data to output in your help tab
* you can optionally add a second method named `markup()` if you don't want a list. It has one argument: your collected data.
Here's an example. The `Bootstrap.php` main class:
<?php
/** Plugin Name: (WCM) CAI Extension */
add_action( 'plugins_loaded', function()
{
if ( ! is_admin() )
return;
$extension = new YourVendorName\YourExtension;
$extension->setup();
} );
The actual class collecting and formatting data
<?php
namespace YourVendorName;
class YourExtension extends WCM\CurrentAdminInfo\AbstractScreenData;
{
public function collect()
{
// Your data collecting logic goes here
}
// This method is optional and formats your output
protected function markup( $set )
{
sort( $set );
// Custom formatting goes here
}
}
If you now activate your plugin, you'll find a new help tab that is named `Wcm Cai Extension` (the class name is taken to form the contextual help tab title).
= Can I use the plugin on a live site on a server? =
Well, you can do a lot, but this is not recommended. The plugin hooks into the `gettext`, which is responsible for translating each and every string. This means that it will slow down your admin user interface pretty much. This plugin was written for local software development and we highly recommend that you run it only locally.
= Can I get the same information for public screens (Themes)? =
WCM CAI is not capable of doing this. It was written to hook into the contextual help tabs, which are not present in a Theme.
== Installation ==
Extract the zip file and just drop the contents in the `~/wp-content/plugins/` directory of your WordPress installation and then activate the Plugin from Plugins page.
== Screenshots ==
1. The contextual hooks tab.
2. The available and set globals tab. Closed Arrays/Objects
3. The available and set globals tab. Showing an open Array/Object
4. The current screen tab.
== Changelog ==
= 2.0 =
* Refactored to PHP 5.3+
* Added Composer support
* PSR-4 compatible namespaces
* Updated Screenshots
* Moved core code to the new `src/` dir
* Simplified loader
* Removed static instance initializing
* Moved setup from object constructor to dedicated setup method
* Loads modules now on priority 5 instead of 20
= 1.1 =
* Performance Improvement: Avoid loading on the front end
= 1.0 =
* Initial Release version