Heads Up! Originally, I wanted to include both how to identify anonymous functions in WordPress and how to unhook them; however, the more I began writing about the topic, the longer the article became.
So I’ve split the content into two articles: This one outlines how to identify anonymous functions registered with hooks. A future article will detail how to de-register said functions.
Previously, I explain how to identify and register anonymous functions in WordPress. As I wrote in the introduction:
As I started writing, it became obvious it’s helpful to understand what PHP does behind-the-scenes when anonymous functions are registered.
So during the first article, I spend time explaining both how anonymous functions are registered – which is clear enough – and how anonymous functions are managed internally by PHP.
If you haven’t read the article, I urge you to do so. But if you’re opting out, the short of it is this:
- You register an anonymous function with an associated WordPress hook,
- PHP generates an ID via hashing for the anonymous function so that it can be managed internally.
It sound easy enough, but problems arise if you want to programmatically identify those anonymous functions. PHP keeps track of them and the functions fire as they are intended but what happens if you, as a developer, want to access those functions to deregister them?
Identify Anonymous Functions
Before looking how, or if, it’s even possible to deregister anonymous functions, it’s important to know how to identify anonymous functions programmatically. That is, if we know we’re working in an environment where anonymous functions have been registered, how do we actually find them?
Again, since these functions are registered with WordPress hooks and since these functions have an ID internally generated by PHP, there’s code we can write to help us understand where these functions are registered.
In the following bit, I’ll show exactly how to do this. This won’t necessarily explain what the code is going nor will it explain who registered the code, but it’ll give us some insight as to what anonymous functions are registered with which hooks.
And that’s a good starting place.
Finding Anonymous Functions
Before using any other specific tools, I’m going to use the following:
- the IDE of my choice, Visual Studio Code,
- a local installation of WordPress,
- whatever theme the installation is using (which, at the time of this writing, is twentytwenty),
- and the
functions.phpof said theme.
It’s not pretty, this isn’t the usual set of tools with which I’d recommend using, but it’s a starting point that’s going to demonstrate the point. In other words, this is a quick and dirty approach to get started.
Further, we’ll be writing anonymous functions in the theme’s functions.php to make it easier to have parity with the content of the article.
With all of that in place, I’ll open functions.php and then add the following code:
add_action('wp_head', 'listRegisteredFunctions', PHP_INT_MAX);
/**
* Lists all the registered functions.
*
* @return void
*/
function listRegisteredFunctions() {
global $wp_filter;
echo <<<HTML
<div style="background:white; font-size:14px;">
<pre>
HTML;
print_r($wp_filter);
echo <<<HTML
</pre>
</div>
HTML;
}This uses the global $wp_filter object which holds information on all of the referenced actions and filters with WordPress. Note also that I’m setting this up to fire in the wp_head hook and that I’m using PHP_INT_MAX to make sure it has the highest priority (so it fires as late as possible).
Note: I do not recommend nor even suggest using
PHP_INT_MAXin a production environment because it makes it incredibly difficult to add anything after that registered hook. This is just for demonstration purposes.
If you run this and then refresh the homepage of your installation, you’re going to see a lot of information. Some of it will make sense, some of it may not. Regardless, it’s going to be a lot of data. And as interesting as it is, there’s not much we can do with it.
To help simplify what it renders, let’s look at something that’s registered with just one of the hooks. Specifically, let’s look and see what’s registered with the wp_enqueue_scripts hook. This hook is one that most anyone who has worked with theme or plugin development has used and something that’s going to have a number of associated callbacks within the context of a theme.
Note, I’m going to use a similar function as used above. I will, however, be changing the actual code in the function. Additionally, note that I have some guard clauses defined for early return so that if nothing is registered with the hook or if there are no callbacks, the function won’t run.
The code looks like this:
add_action('wp_head', 'listRegisteredFunctions', PHP_INT_MAX);
/**
* Lists all the registered functions.
*
* @return void
*/
function listRegisteredFunctions() {
global $wp_filter;
if (!isset($wp_filter['wp_enqueue_scripts'])) {
return;
}
// Get all functions/callbacks hooked to wp_enqueue_scripts
$callbacks = $wp_filter['wp_enqueue_scripts']->callbacks;
if (empty($callbacks)) {
return;
}
// ...
}It’s not going to render anything yet, though, because I don’t have the code for actually rendering the callbacks and functions associated with the hook. To do that, we can iterate through the callbacks and get each function and its associated priority.
To render that, we need to add:
echo '<pre>';
foreach ($callbacks as $priority => $functions) {
foreach ($functions as $function) {
print_r([$function, $function['function']]);
echo '<br />';
}
}
echo '</pre>';The two important things to take away from the above code are:
- I’m adding the
functionand the$function['function']to an array that’s dumped byprint_r. $function['function']contains a reference to the callback function.
In the outer foreach loop, note that $functions is the associative array representing the callbacks hooked to the wp_enqueue_scripts. In the inner loop, $function has information about the callback and $function['function'] is the actual callback itself.
In the environment I’m using to test this code, I’m running the twentytwenty theme and I’ve added the above code to functions.php. If you’re following along with the same – even if it’s a different theme – you’ll likely see something like this written out to the screen:
Array
(
[0] => Array
(
[function] => twentytwenty_register_scripts
[accepted_args] => 1
)
[1] => twentytwenty_register_scripts
)I’ve opted to use this as an example because it’s prefixed with twentytwenty_ meaning it’s likely going to be found within the theme. And when I search for this function in the theme within my IDE, I found the following:
/**
* Register and Enqueue Scripts.
*
* @since Twenty Twenty 1.0
*/
function twentytwenty_register_scripts() {
// Code remove to keep the code succinct.
}
add_action( 'wp_enqueue_scripts', 'twentytwenty_register_scripts' );The important thing to note here is that we see the function twentytwenty_register_scripts is, in fact, registered with the wp_enqueue_scripts hook.
The purpose of looking at this is to see that we’re successfully able to find code that’s registered with our hook of choice. The next challenge, though, is finding anonymous functions that are registered with the same hook.
You can argue that it’d be more helpful to go ahead and find all anonymous functions registered with this hook but let’s first create out own so we can get an idea as to how this looks.
When doing this, you’ll see how complex, though not impossible, managing anonymous functions can be.
Creating Our Own Anonymous Function
First, comment out the code that’s listing all of the functions registered with the wp_enqueue_scripts hook.
Next, let’s add our own anonymous functions to functions.php. This will render a message at the top of the page and it will allow us to use previously written code to track track this anonymous function.
add_action('wp_enqueue_scripts', function () {
echo <<<HTML
<div style="border:1px outset gray; padding: 1em;background:#ccc;position:fixed;top:0;left:0;z-index:99; width: 100%;">
This is a a sample anonymous function.
</div>
HTML;
}, 0, 10);When you refresh the page you’re on, you should see something like this:
The next step will be to run the previously written code and attempt to locate this function.
Now let’s reintroduce the code responsible for printing all of the functions registered with the hook. Assuming you’ve done everything correct, you’ll notice a new piece of data rendered on the page.
Specifically, it’ll read like this:
Array
(
[0] => Array
(
[function] => Closure Object
(
)
[accepted_args] => 10
)
[1] => Closure Object
(
)
)Assuming there are no other anonymous functions in your code, then this is the function we just wrote and the one we’re looking to manage.
So this raises the following two questions:
- How can we relate an anonymous function to a specific hook?
- How can we de-register this function?
Since we know that PHP generates an internal ID for closures and since we have an anonymous function currently hooked to the wp_enqueue_scripts hook, let’s see what we can do.
Relating Anonymous Functions to Specific Hooks
First, let’s update the code in functions.php so that it dumps all of the information for the closure. I’ll show the code first then explain what it’s doing:
add_action('wp_enqueue_scripts', function () {
$backtrace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 2);
echo '<pre>';
var_dump($backtrace[1]['object']);
echo '</pre>';
// The original code is here...
});Note this part is going to require a bit of functionality offered by PHP. Some of you who have worked with PHP for years may be familiar with this; some of you may not. And if not, that’s okay! I’ll explain it then share a bit more about it.
In the function, I’m grabbing information from one of the built-in PHP functions called debug_backtrace and then I’m using the DEBUG_BACKTRACE_PROVIDE_OBJECT constant to help.
This is a breakdown of each argument and the function to which they are passed:
debug_backtrace()is a function in PHP that returns a backtrace, which is an array of associative arrays containing function call information. It provides a snapshot of the call stack at the point where it is called, showing the hierarchy of function calls leading up to that point.DEBUG_BACKTRACE_PROVIDE_OBJECTis a constant flag that can be used as an option when callingdebug_backtrace(). When this flag is set, each frame in the backtrace will contain an entry named ‘object’ representing the current object instance.- The
2is an optional parameter specifying the number of stack frames to return in the backtrace. In this case, it limits the backtrace to two frames. - And, for what it’s worth, a “frame” refers to a specific level or entry in the call stack (which is, essentially, the order in which functions are called).
This is what a call to this function actually does:
- The first frame is the frame where
debug_backtrace()is called (that is, the anonymous function itself). - The second frame is the frame where the function that called
debug_backtrace()resides. - By limiting the frames to two, you get information about the current function (anonymous function in this case) and its caller.
As I mentioned at the start of this section, using functionality like this is something that comes with having worked with PHP for several years. I don’t remember exactly when I learned it myself. Regardless, that’s an advantage of articles like this, I guess (read: I hope) – it exposes you to new things of which you may not have otherwise been aware.
And yes, de-registering hooks in WordPress is challenging but it’s through these type of facilities that we should be able to do so. When you view this code in your browser, you should see something like the following located in the data you’ve printed to your browser:
["00000000000002e50000000000000000"]=>
array(2) {
["function"]=>
object(Closure)#741 (0) {
}
["accepted_args"]=>
int(1)
}Recall from the previous article that PHP does two things when registering callbacks:
- Generates an ID for the closure. To generate a unique identifier for this closure, WordPress uses the
spl_object_hash()function.- Associates the ID with the callback. The generated closure ID is then associated with the callback function, allowing WordPress to track and manage callbacks even when they are anonymous functions.
And since this is an anonymous function, the ID we see in the print out above is the ID PHP generated when registering the function.
Before We Deregister The Function…
As I stated throughout this article: I wanted to include all of the information in the previous article and this article to explain exactly what PHP is doing, how to locate registered closures, and how to deregister them, but the amount of time it takes to explain how to do all of the above takes longer than I anticipated.
As such, I’m going to pause here. There’s plenty of material to review in terms of the PHP internals as well as work that can be done to inspect your own anonymous functions.
In the next article, I’ll walk through a process – regardless of how manual it is – for how to deregister the functions.
Until then, incorporate some of the code here and also see what other anonymous functions have been registered throughout your codebase.
