-
Notifications
You must be signed in to change notification settings - Fork 0
/
plugin.php
199 lines (177 loc) · 5.34 KB
/
plugin.php
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<?php
/**
* Plugin Name: Callback Info
* Plugin URI: https://github.com/tommcfarlin/tm-callback-info
* Description: Render contextual information about every function registered with all WordPress hooks.
* Requires at least: 6.5
* Requires PHP: 7.4.33
* Author: Tom McFarlin
* Author URI: https://tommcfarlin.com
* License: GPLv3
* License URI: https://www.gnu.org/licenses/gpl-3.0.html
* Version: 1.0.0
* Text Domain: tm-callback-info
*
* @package TmCallbackInfo
* @version 1.0.0
* @since 1.0.0
* @link https://github.com/tommcfarlin/tm-callback-info
* @license GPL-3.0-or-later
*/
namespace TmCallbackInfo;
use Closure;
use ReflectionFunction;
use ReflectionMethod;
use ReflectionException;
defined( 'WPINC' ) || die;
// Pass `use-sample-anonymous-function=true` to the query string to render a sample closure.
if ( 'true' === filter_input( INPUT_GET, 'use-sample-anonymous-function', FILTER_SANITIZE_STRING ) ) {
add_action(
'wp_enqueue_scripts',
function () {
echo <<<HTML
<div style="border:1px outset gray; padding: 1em;background:#ccc;position:fixed;bottom:0;left:0;z-index:99; width: 100%;">
This is a a sample anonymous function.
</div>
HTML;
},
0,
10
);
}
add_action( 'admin_bar_menu', __NAMESPACE__ . '\\add_admin_bar_menu', 999 );
/**
* Adds a menu item to the WordPress admin bar.
*
* This function is responsible for adding a menu item to the WordPress admin bar.
* It takes the `$wp_admin_bar` object as a parameter and modifies it to include the new menu item.
*
* @param WP_Admin_Bar $wp_admin_bar The WordPress admin bar object.
*/
function add_admin_bar_menu( $wp_admin_bar ) {
$wp_admin_bar->add_menu(
array(
'id' => 'callback-info',
'title' => __( 'Callback Info', 'tm-callback-info' ),
'href' => add_query_arg( 'show-callback-info', 'true' ),
)
);
}
add_action( 'wp_head', __NAMESPACE__ . '\\list_registered_functions', 1000 );
/**
* Lists all the registered functions.
*
* @return void
*/
function list_registered_functions() {
global $wp_filter;
foreach ( $wp_filter as $hook_name => $hook_object ) {
echo '<pre>';
echo esc_html( "Hook: $hook_name\n" );
foreach ( $hook_object->callbacks as $priority => $callbacks ) {
foreach ( $callbacks as $callback ) {
if ( is_array( $callback['function'] ) ) {
echo ( is_object( $callback['function'][0] ) ) ?
esc_html( get_object_method_information( $callback ) ) :
esc_html( get_static_method_information( $callback ) );
} else {
echo ( $callback['function'] instanceof Closure ) ?
esc_html( get_anonymous_function_information( $callback ) ) :
esc_html( get_function_information( $callback ) );
}
}
}
echo '</pre>';
}
echo esc_html( $output );
}
/**
* Retrieves information about a given object method.
*
* @param Callable $callback The callback function or method.
*
* @return string $output The filename of the function, the start line, and the end line.
*/
function get_object_method_information( $callback ) {
try {
$reflection = new ReflectionMethod(
$callback['function'][0],
$callback['function'][1]
);
} catch ( ReflectionException $e ) {
return "\n\t" . $e->getMessage() . "\n";
}
$output = <<<METHOD_INFO
\n\tObject Method\n
\tClass: {$reflection->class}
\tMethod: {$reflection->name}
\tFilename: {$reflection->getFileName()}
\tStart line: {$reflection->getStartLine()}
\tEnd line: {$reflection->getEndLine()}
METHOD_INFO;
return $output;
}
/**
* Retrieves information about a static method callback.
*
* @param Callable $callback The static method callback.
*
* @return string $output The filename of the function, the start line, and the end line.
*/
function get_static_method_information( $callback ) {
try {
$reflection = new ReflectionMethod(
$callback['function'][0],
$callback['function'][1]
);
} catch ( ReflectionException $e ) {
return "\n\t" . $e->getMessage() . "\n";
}
$output = <<<METHOD_INFO
\n\tStatic Method\n
\tClass: {$reflection->class}
\tMethod: {$reflection->name}
\tFilename: {$reflection->getFileName()}
\tStart line: {$reflection->getStartLine()}
\tEnd line: {$reflection->getEndLine()}
METHOD_INFO;
return $output;
}
/**
* Renders information about an anonymous function.
*
* @param Callable $callback The anonymous function for which to render information.
*
* @return string $output The filename of the function, the start line, and the end line.
*/
function get_anonymous_function_information( $callback ) {
$reflection = new ReflectionFunction( $callback['function'] );
$output = <<<FUNCTION_INFO
\n\tAnonymous Function\n
\tFilename: {$reflection->getFileName()}
\tStart line: {$reflection->getStartLine()}
\tEnd line: {$reflection->getEndLine()}
FUNCTION_INFO;
return $output;
}
/**
* Retrieves information about a given function.
*
* @param Callable $callback The callback function.
*
* @return string $output The filename of the function, the start line, and the end line.
*/
function get_function_information( $callback ) {
try {
$reflection = new ReflectionFunction( $callback['function'] );
} catch ( ReflectionException $e ) {
return "\n\t" . $e->getMessage() . "\n";
}
$output = <<<FUNCTION_INFO
\n\tFunction\n
\tFilename: {$reflection->getFileName()}
\tStart line: {$reflection->getStartLine()}
\tEnd line: {$reflection->getEndLine()}
FUNCTION_INFO;
return $output;
}