{"id":9554,"date":"2018-04-18T09:56:11","date_gmt":"2018-04-18T13:56:11","guid":{"rendered":"https:\/\/blog.litespeedtech.com\/?p=9554"},"modified":"2018-04-18T09:56:11","modified_gmt":"2018-04-18T13:56:11","slug":"purging-litespeed-cache-via-wordpress-hooks","status":"publish","type":"post","link":"https:\/\/lswp.store\/index.php\/2018\/04\/18\/purging-litespeed-cache-via-wordpress-hooks\/","title":{"rendered":"WpW: The Purge All Hooks Setting"},"content":{"rendered":"

\"WordPress<\/a><\/p>\n

Welcome to another installment of WordPress Wednesday<\/a>!
\nToday\u2019s topic is: Purging LiteSpeed Cache via WordPress Hooks<\/strong><\/p>\n

Disclaimer<\/strong>: The information contained in this post is accurate for LSCWP v2.2.2 [release log<\/a>]. If you are using a newer version of the plugin, some details may have changed. Please refer to our wiki<\/a> for the latest!<\/em><\/p>\n

—
\nToday we\u2019re going to talk about a more advanced topic than usual. If you are unfamiliar with the concept of WordPress hooks and actions, then this may not be for you. If you want to learn more and then come back, that\u2019s great, too. Here\u2019s a really nice primer on the subject<\/a>. You might also want to brush up on LiteSpeed Cache and how purging works<\/a>.
\n—<\/p>\n

Purging LiteSpeed Cache via WordPress Hooks<\/h2>\n

LiteSpeed Cache for WordPress is configured to automatically purge everything from the cache when certain WordPress hooks are run. For example: every time you change your theme (the switch_theme<\/code> hook), or every time you create a new category or tag (the create_term<\/code> hook), a purge_all<\/code> action is triggered.<\/p>\n

By default, LiteSpeed runs a purge_all<\/code> action any time any of the following WordPress hooks occur:<\/p>\n

switch_theme\nwp_create_nav_menu\nwp_update_nav_menu\nwp_delete_nav_menu\ncreate_term\nedit_terms\ndelete_term\nadd_link\nedit_link\ndelete_link\n<\/pre>\n
For most installations, this list of hooks is sufficient. Owners of highly-customized sites, however, may have reason to make changes to the list. We recently added a new setting that will allow you to do just that.<\/p>\n
Purge All Hooks<\/h2>\n
\"Purging<\/a><\/p>\n
From the WordPress Dashboard, navigate to LiteSpeed Cache > Settings > Advanced<\/strong>. Scroll down to Purge All Hooks<\/strong>, and you will see the list of hooks that currently trigger purge_all<\/code> actions for your site, entered one per line.<\/p>\n
You are free to edit this list. Remove hooks if you don\u2019t want the cache purged, and add hooks if you want to automate more purges.<\/p>\n
Removing a Hook<\/h3>\n
Let\u2019s say you don\u2019t want to purge the cache every time you create a new category.<\/p>\n
Remove the create_term<\/code> hook from the list, and press the Save Changes<\/strong> button.<\/p>\n
(That was easy.)<\/p>\n
Adding a WordPress Hook<\/h3>\n
This one is slightly more complicated, but only because you need to know the name of the hook you want to add.<\/p>\n
For example, if you want to purge the cache any time a new comment is posted, then you need to know that the WordPress hook for posting a comment is comment_post<\/code>.<\/p>\n
Once you are aware of the name of the correct hook, you can insert it into the list on its own line.<\/p>\n
The WordPress Code Reference<\/a> provides a list of available hooks. There\u2019s a handy search function on the page, too, in case you don\u2019t want to go through the list alphabetically.<\/p>\n
Adding a Plugin Hook<\/h3>\n
Plugins can provide hooks, too, and there may be a situation where you want to hang a purge_all<\/code> onto a plugin hook. Again, you\u2019ll need to do a little research to find the name of the hook, but once you do, it\u2019s a simple matter of adding it to the Purge All Hooks<\/strong> list.<\/p>\n
Let\u2019s look at an example from our own plugin. You may have noticed that there are some tabs in the LiteSpeed Settings pages that suggest you should run a Purge All after you\u2019ve changed those settings. Well, if changing the configuration is something you do frequently, why not automate that Purge All?<\/p>\n
For example, LiteSpeed Cache > Settings > Optimize<\/strong> warns \u201cAfter changing Minify\/Combine settings, please do a Purge All action.\u201d All we need to do is find the hook that runs when you Save Changes<\/strong> on the Optimization<\/strong> page, and add that hook to the Purge All Hooks<\/strong> list.<\/p>\n
There is no hook specific to the Optimize<\/strong> page, but there is one that relates to nearly all of the ON<\/code>\/OFF<\/code> switches on any of the Settings<\/strong> tabs: update_option_litespeed-cache-conf<\/code>.<\/p>\n
Add that hook to the list, and a Purge All will occur any time you enable or disable a setting.<\/p>\n
\"Purging<\/a><\/p>\n
Finding a plugin\u2019s hooks may not be easy. You can hope that they\u2019ve provided a complete list as part of their documentation (which is rare), you can ask in their support forum (if they have one), or you can pore through their source code and try to find them (if it\u2019s open source).<\/p>\n
Here are some handy LiteSpeed plugin hooks. Most of these occur when individual settings (those not included in update_option_litespeed-cache-conf<\/code>) are changed:<\/p>\n
update_option_litespeed-cache-vary-group\nupdate_option_litespeed-cache-exclude-optimization-roles\nupdate_option_litespeed-cache-exclude-cache-roles\nupdate_option_litespeed-optm-css\nupdate_option_litespeed-optm-js-defer-excludes\nupdate_option_litespeed-media-lazy-img-excludes\nupdate_option_litespeed-media-need-pull\nupdate_option_litespeed-env-ref\nupdate_option_litespeed-cache-drop_qs\nupdate_option_litespeed-cache-cdn_mapping\nupdate_option_litespeed-cache-dns_prefetch\nupdate_option_litespeed-cache-cloudflare_status\nupdate_option_litespeed-log_ignore_filters\nupdate_option_litespeed-log_ignore_part_filters\nupdate_option_litespeed-object_global_groups\nupdate_option_litespeed-object_non_persistent_groups\nupdate_option_litespeed-crawler-as-uids\nupdate_option_litespeed-adv-purge_all_hooks\nupdate_option_litespeed-cdn-ori_dir\nupdate_option_litespeed-media-webp_attribute\n<\/pre>\n
Please be sure that you understand fully what any hook means before adding it to Purge All Hooks<\/strong>.<\/em> After all, purge_all<\/code> is a drastic step. It wipes out the entire cache. You don\u2019t want to automate that task unless the hook truly warrants it!<\/p>\n
Changing Your Mind<\/h2>\n
If you\u2019ve added some hooks, and you don\u2019t like the results, you can go back to the default configuration. Copy the list of hooks from the \u201cRecommended Value\u201d box into the Purge All Hooks<\/strong> setting and press the Save Changes<\/strong>. Everything should go back to normal.<\/p>\n
—<\/p>\n
Have some of your own ideas for future WordPress Wednesday<\/a> topics? Leave us a comment!<\/p>\n
Don\u2019t forget to meet us back here next week for the next installment. In the meantime, here are a few other things you can do:<\/p>\n