![\"LSCWP](\"https:\/\/lswp.store\/wp-content\/uploads\/2023\/06\/lscwp-cacheable.png\")
<\/p>\n<\/p>\n
The LiteSpeed Cache plugin for WordPress includes an API that you can use to customize cache behavior. If you\u2019re a developer, the LSCWP API will help you to achieve LiteSpeed compatibility within your plugins. If you\u2019re a site owner who enjoys customizing every little aspect of your site, maybe you have some unique reason to use one of our API hooks in your child theme\u2019s Whatever your actual purpose is, today we\u2019re going to look at three LSCWP API cache hooks and show you how to use them to control the cacheability of a page:<\/p>\n Plus, we’ll look at a couple of bonus hooks that are useful for setting cache scope:<\/p>\n First, let\u2019s look at how LSCWP decides which pages to cache and which pages not to cache.<\/p>\n By default, the LSCWP considers all pages that have had the Site administrators may also set some content to be non-cacheable, so LSCWP checks the values of the settings in LiteSpeed Cache > Cache > Excludes<\/strong>, and considers a page non-cacheable if:<\/p>\n This is enough for most admins, but maybe you have a special case that you want to handle programmatically. Or maybe you have written a plugin that generates its own pages and doesn\u2019t follow the usual You use LSCWP\u2019s cache control API hooks.<\/p>\n If your plugin generates pages and does not invoke the Note that if the page fits one of the criteria specified in the the plugin\u2019s Cache > Excludes<\/strong> settings, then the page may ultimately be set as non-cacheable, despite this hook.<\/p>\n The The With all the settings and API hooks available, it can be difficult to know whether the current page is set to be cached or whether it is non-cacheable. Use the Once you set a page as cacheable, you might want to further define the scope of that cache. Do you want to store the cache object in a logged-in user\u2019s private cache, or do you want all visitors to view a publicly cached copy? By default, LSCWP caches pages publicly. Use these action hooks to explicitly define cache scope:<\/p>\nfunctions.php<\/code> file.<\/p>\n\n
litespeed_control_set_nocache<\/code><\/li>\nlitespeed_control_set_cacheable<\/code><\/li>\nlitespeed_control_force_cacheable<\/code><\/li>\n<\/ul>\n\n
litespeed_control_set_private<\/code><\/li>\nlitespeed_control_force_public<\/code><\/li>\n<\/ul>\nTo cache, or not to cache<\/h2>\n
![\"\"](\"https:\/\/lswp.store\/wp-content\/uploads\/2023\/06\/intro.jpg\")
<\/p>\nwp<\/code> action hook is run on each page of a WordPress site, after the query has been parsed and the post has been loaded, but before template functionality is executed. (There may be exceptions to this rule, but we\u2019ll talk about that later.)<\/p>\nwp<\/code> action run on them to be cacheable. Essentially, every page is cacheable. Unless it falls into one of these categories:<\/p>\n\n
POST<\/code> request<\/li>\nis_trackback()<\/code> is true<\/li>\nis_search()<\/code> is true<\/li>\n\n
wp<\/code> action hook conventions. What do you do then?<\/p>\nCache control API hooks<\/h2>\n
![\"\"](\"https:\/\/lswp.store\/wp-content\/uploads\/2023\/06\/hooks-1024x866.jpg\")
<\/p>\nMark the current page as cacheable<\/h3>\n
wp<\/code> action hook, then LSCWP may not know that the page should be cached. Use the litespeed_control_set_cacheable<\/code> action with a ‘reason’ parameter, like so:<\/p>\ndo_action(\n\t'litespeed_control_set_cacheable',\n\t'The lady doth protest too much, methinks.'\n);\n<\/pre>\n
Mark the current page as non-cacheable<\/h3>\n
litespeed_control_set_nocache<\/code> action is the opposite of the previous one. Use it in your plugins or snippets to inform LSCWP not to cache the page.<\/p>\ndo_action(\n\t'litespeed_control_set_nocache',\n\t'And flights of angels sing thee to thy rest!'\n);\n<\/pre>\n
Force the current page to be cacheable<\/h3>\n
litespeed_control_force_cacheable<\/code> action informs LSCWP to cache the page, and it will<\/em> override anything the user may enter in the Cache > Excludes<\/strong> settings.<\/p>\ndo_action(\n\t'litespeed_control_force_cacheable',\n\t'if it be not to come, it will be now'\n);\n<\/pre>\n
What have I done?<\/h2>\n
litespeed_control_cacheable<\/code> filter to get a definitive answer.<\/p>\napply_filters( 'litespeed_control_cacheable', false );\n<\/pre>\n
BONUS<\/h2>\n
do_action(\n\t'litespeed_control_set_private',\n\t'Listen to many, speak to a few.'\n);\n\ndo_action(\n\t'litespeed_control_force_public',\n\t'Brevity is the soul of wit.'\n);\n<\/pre>\n
Conclusion<\/h2>\n