LSCache for WordPress API¶

Any WordPress plugin that populates front-end content that can be publicly cached should work with LSCache. If your plugin needs to purge or vary cached pages, or opt your plugin’s content out of caching, use the hooks below rather than calling LSCWP classes directly. The hook layer works whether or not LSCWP is active, so you do not need to gate your code with class_exists() checks.

Most hooks are registered in src/api.cls.php under init(). A few hooks, as noted in their entries, are defined in the classes they belong to.

Background¶

How LSCache tags pages¶

LSCache tags every cacheable response before storing it. In the simplest case, a post’s page is tagged with its post ID, and a later edit_post, save_post, deleted_post, trashed_post, or delete_attachment event tells the server to purge everything tagged with that ID.

If your plugin has other events that should invalidate a page, you can:

• Add tags to pages as they render with litespeed_tag_add or litespeed_tag_add_post.
• Purge pages by those tags later with litespeed_purge.

Because a page can carry many tags and a tag can span many pages, the same tag system lets you purge one item, a group, or everything at once.

What counts as non-cacheable¶

LSCWP does not cache a response if it is an admin page, a POST request, is_trackback(), is_search(), has no active theme, or has a URI, query string, category, tag, cookie, user agent, or role on one of the Do Not Cache lists. If your plugin produces private or transient output in situations LSCWP does not know about, mark the response with litespeed_control_set_nocache or litespeed_control_set_private.

Hook reference¶

Init¶

Lifecycle hooks fire as LSCWP boots. They are registered in src/api.cls.php and fired from src/core.cls.php.

litespeed_init¶

do_action( 'litespeed_init' );

This hook has no parameters.

Fires once LSCWP has completed initialization. Use this instead of WordPress’s init when your code needs the LSCWP API to be ready.

add_action( 'litespeed_init', function () {
    // LSCWP is ready. It is safe to call litespeed_* hooks here.
} );

litespeed_initing¶

do_action( 'litespeed_initing' );

This hook has no parameters.

Fires while LSCWP is still initializing. Prefer litespeed_init unless you specifically need to run before the rest of LSCWP is available.

litespeed_after_admin_init¶

do_action( 'litespeed_after_admin_init' );

This hook has no parameters.

Fires after LSCWP has finished its admin-side init pass. Use it to add admin-only integrations that depend on LSCWP admin classes.

litespeed_load_thirdparty¶

do_action( 'litespeed_load_thirdparty' );

This hook has no parameters.

Fires when LSCWP loads the integrations under thirdparty/. Hook here if you are shipping your own third-party integration file and want it loaded alongside the bundled integrations.

Config¶

Read, override, and persist LSCWP settings, and filter the .htaccess file that LSCWP writes to wp-content/litespeed/. See src/conf.cls.php and src/file.cls.php. Setting slugs are defined in src/base.cls.php.

litespeed_conf¶

apply_filters( 'litespeed_conf', string $slug );

Reads a single LSCWP setting. Pass the setting slug to retrieve the current value. Setting slugs are defined in src/base.cls.php, and defaults are in data/const.default.ini.

if ( apply_filters( 'litespeed_conf', 'cache-priv' ) ) {
    // Private cache is enabled.
}

litespeed_save_conf¶

do_action( 'litespeed_save_conf', array|false $the_matrix = false );

Saves the supplied settings and regenerates the .htaccess rewrite rules. The array is optional; call the hook without arguments to regenerate rules from current settings.

litespeed_conf_multi_switch¶

do_action( 'litespeed_conf_multi_switch', string $option_id, int $states );

Registers a config option as a multi-state switch — an integer with N possible values — instead of a plain on/off toggle. Must be fired before litespeed_conf_append for the same option, or the option will be treated as a boolean. Added in v3.0. Fired in src/conf.cls.php; handled by Base::set_multi_switch() in src/base.cls.php.

// Register a 3-state switch, then append it as a config option.
do_action( 'litespeed_conf_multi_switch', 'my_plugin_mode', 3 );
do_action( 'litespeed_conf_append', 'my_plugin_mode', 0 );

litespeed_conf_append¶

do_action( 'litespeed_conf_append', string $key, mixed $default_value );

Registers a new option in the configuration store with an initial value. Use this once, during setup, for options that your integration owns.

litespeed_conf_force¶

do_action( 'litespeed_conf_force', string $key, mixed $value );

Overrides a setting in memory only for the remainder of the current request. Nothing is persisted, and reads that have already occurred are not retroactively changed.

litespeed_update_confs¶

do_action( 'litespeed_update_confs', array $update_confs );

Persists an array of slug => value setting changes at once. Use this action for bulk updates rather than looping over litespeed_save_conf.

litespeed_conf_load_option_{$option}¶

apply_filters( "litespeed_conf_load_option_{$option}", mixed $value );

Runs when the named option loads, allowing you to rewrite its value. Replace {$option} with a setting slug.

add_filter( 'litespeed_conf_load_option_esi', '__return_false' );

litespeed_static_dir_htaccess¶

Defined in src/file.cls.php.

apply_filters( 'litespeed_static_dir_htaccess', string $htaccess );

Filters the contents LSCWP writes to wp-content/litespeed/.htaccess. LSCWP rewrites this file whenever it differs byte-for-byte from the built-in template, so manual edits are reverted. Use this filter to make a persistent change.

The default block contains an Options -Indexes directive and a RewriteRule .* - [F,L] deny rule. Some shared hosts forbid Options in .htaccess and return HTTP 500 for the whole directory when they encounter it, blocking combined CSS and JavaScript files from loading. Use this filter to remove those lines or replace the entire file.

add_filter( 'litespeed_static_dir_htaccess', function ( $htaccess ) {
    return preg_replace( '/^\s*Options\s+-Indexes\s*\R?/mi', '', $htaccess );
} );

Cache control¶

Use these hooks to decide whether the current response is cacheable, whether it is public or private, and how long it lives. See src/control.cls.php.

litespeed_control_finalize¶

do_action( 'litespeed_control_finalize', string|false $esi_id );

Fires at the end of every cacheable request, immediately before headers are sent. Hook here to make cache-control decisions that depend on the fully rendered page. For example, mark the page non-cacheable because a warning rendered mid-page.

This action does not fire for admin pages or responses that are already known to be non-cacheable.

litespeed_control_set_private¶

do_action( 'litespeed_control_set_private', string|false $reason = false );

Marks the current response as private cache content for one user rather than public cache content.

litespeed_control_set_nocache¶

do_action( 'litespeed_control_set_nocache', string|false $reason = false );

Marks the current response as non-cacheable. The string argument is recorded in the debug log.

litespeed_control_set_cacheable¶

do_action( 'litespeed_control_set_cacheable', string|false $reason = false );

Marks the response as cacheable. This is primarily useful for scripted or REST-style endpoints where the standard wp action does not run and LSCWP cannot decide on its own.

litespeed_control_force_cacheable¶

do_action( 'litespeed_control_force_cacheable', string|false $reason = false );

Behaves like litespeed_control_set_cacheable, but overrides most non-cacheable conditions that LSCWP would otherwise apply. Use sparingly because this action tells LSCWP to ignore its safety checks.

litespeed_control_force_public¶

do_action( 'litespeed_control_force_public', string|false $reason = false );

Forces the response into public cache even when normal rules would otherwise send it to private cache.

litespeed_control_cacheable¶

apply_filters( 'litespeed_control_cacheable', bool $cacheable );

Reads the current cacheable status. Read-only: adding a filter that changes the return value does nothing. To change cacheability, use a litespeed_control_set_* or litespeed_control_force_* action.

litespeed_control_set_ttl¶

do_action( 'litespeed_control_set_ttl', int|string $ttl, string|false $reason = false );

Sets the TTL, in seconds, for the current cache entry or ESI block.

litespeed_control_ttl¶

apply_filters( 'litespeed_control_ttl', int $ttl );

Reads the TTL that LSCWP plans to use for the current response.

litespeed_can_change_vary¶

Defined in src/vary.cls.php.

apply_filters( 'litespeed_can_change_vary', bool $can_change );

Returns true if the vary cookie can still change for the current request. LSCWP does not change the vary cookie during unsupported request methods, crawler requests, or when other conditions prevent a change. Filter here to impose an additional constraint.

Tag¶

Attach cache tags to the current response so you can later purge groups of pages together. See src/tag.cls.php.

litespeed_tag_finalize¶

do_action( 'litespeed_tag_finalize' );

This hook has no parameters.

Fires at the end of every cacheable request. Hook here if you need to add tags based on what the request produced, such as queried objects or taxonomy terms, rather than information known before rendering.

litespeed_tag_add¶

do_action( 'litespeed_tag_add', string|array $tags );

Adds one or more tags to the current page’s tag list in addition to the built-in tags that LSCWP generates. You can later purge every page that carries the tag with litespeed_purge.

litespeed_tag_add_post¶

do_action( 'litespeed_tag_add_post', int|string $post_id );

Adds a tag scoped to a post ID. Use this inside a loop, or after a conditional, to tag posts that share a property your plugin needs to track.

litespeed_tag_add_widget¶

do_action( 'litespeed_tag_add_widget', string|int $widget_id );

Adds a tag scoped to a widget so that the widget’s cached output can be purged independently.

litespeed_tag_add_private¶

do_action( 'litespeed_tag_add_private', string|array $tags );

Adds one or more tags to the private cache tag list for the current page. Purge these tags later with litespeed_purge_private.

litespeed_tag_add_private_esi¶

do_action( 'litespeed_tag_add_private_esi', string $tag );

Adds a tag to the private ESI tag list. Use it for ESI blocks that have per-user content.

Purge¶

Trigger cache purges, redefine which WordPress events cause a post purge, or modify the list of tags that a purge is about to send. See src/purge.cls.php.

litespeed_purge_post_events¶

apply_filters( 'litespeed_purge_post_events', array $events );

Replaces LSCWP’s built-in list of WordPress events that trigger an automatic post purge. Return an array of hook names.

add_filter( 'litespeed_purge_post_events', function () {
    return array( 'delete_post', 'wp_trash_post' );
} );

litespeed_purge_finalize¶

do_action( 'litespeed_purge_finalize' );

This hook has no parameters.

Fires at the end of the request, analogous to litespeed_tag_finalize, but for purge tags. Use it when the decision to purge depends on what the request produced.

litespeed_purge¶

do_action( 'litespeed_purge', string|array $tags, bool $purge2 = false );

Purges every cached page carrying the specified tag or tags.

litespeed_purge_tags¶

apply_filters( 'litespeed_purge_tags', array $purge_tags, bool $is_private );

Runs immediately before purge tags are sent to the server, allowing you to add, remove, or replace them. $is_private is true when the pending purge targets private cache.

Returning array( '_nothing' ) is the standard method for canceling a purge.

add_filter( 'litespeed_purge_tags', function ( $purge_tags, $is_private ) {
    if ( isset( $_SERVER['REQUEST_URI'] ) && strpos( $_SERVER['REQUEST_URI'], 'LSCWP_CTRL=purge' ) !== false ) {
        do_action( 'litespeed_debug2', 'Preserve manual purge action' );
        return $purge_tags;
    }

    return array( '_nothing' );
}, 10, 2 );

litespeed_purge_all¶

do_action( 'litespeed_purge_all', string|false $reason = false );

Purges all caches managed by LSCWP for the current site, including LSCache, CSS, JavaScript, local resources, object cache, and OPcache.

litespeed_purge_post¶

do_action( 'litespeed_purge_post', int $post_id );

Purges everything tagged with the specified post ID, including the post’s own page and any archives that LSCWP tagged with the ID.

litespeed_purge_posttype¶

do_action( 'litespeed_purge_posttype', string $post_type );

Purges every cached page for the specified post type.

litespeed_purge_url¶

do_action( 'litespeed_purge_url', string $url );

Purges one URL. The hook accepts either a path such as /path/to/page/ or a complete URL such as https://example.com/path/to/page/.

litespeed_purge_widget¶

do_action( 'litespeed_purge_widget', string|int $widget_id );

Purges a widget’s cached fragment.

litespeed_purge_esi¶

do_action( 'litespeed_purge_esi', string $tag );

Purges a public ESI block by name.

litespeed_purge_private¶

do_action( 'litespeed_purge_private', string|array $tags );

Purges one or more tags from the current user’s private cache.

litespeed_purge_private_esi¶

do_action( 'litespeed_purge_private_esi', string $tag );

Purges a private ESI block by name.

litespeed_purge_private_all¶

do_action( 'litespeed_purge_private_all' );

This hook has no parameters.

Purges every entry in the current user’s private cache.

litespeed_purge_all_object¶

do_action( 'litespeed_purge_all_object' );

This hook has no parameters.

Flushes the WordPress object cache, such as Memcached or Redis, when LSCWP manages it.

litespeed_api_purge_post¶

do_action( 'litespeed_api_purge_post', int $post_id );

Fires at the start of building the purge tag list for a single post, before any built-in tags are collected. Third parties can hook in and call Purge::add() (or fire litespeed_purge) to push additional tags that should be purged alongside the post. Added in v1.0.0. Fired in src/purge.cls.php.

add_action( 'litespeed_api_purge_post', function( $post_id ) {
    // Also purge a custom tag whenever this post is purged.
    do_action( 'litespeed_purge', 'my_plugin_related_' . $post_id );
} );

Purge events¶

These actions fire after LSCWP completes a purge. Add listeners with add_action() to run your own code, such as logging, cache warming, or external notifications, after LSCWP purges content. See src/purge.cls.php.

litespeed_purged_all_lscache¶

do_action( 'litespeed_purged_all_lscache' );

This hook has no parameters.

Fires after Purge All LSCache.

litespeed_purged_pages¶

do_action( 'litespeed_purged_pages' );

This hook has no parameters.

Fires after Purge All Pages.

litespeed_purged_cat¶

do_action( 'litespeed_purged_cat', string $category );

Fires after Purge Category.

litespeed_purged_tag¶

do_action( 'litespeed_purged_tag', string $tag );

Fires after Purge Tag.

litespeed_purged_link¶

do_action( 'litespeed_purged_link', string $url );

Fires after Purge URL.

litespeed_purged_frontpage¶

do_action( 'litespeed_purged_frontpage' );

This hook has no parameters.

Fires after Purge Front Page.

litespeed_purged_all¶

do_action( 'litespeed_purged_all' );

This hook has no parameters.

Fires after LSCWP purges all caches, including LSCache, object cache, and other managed stores.

litespeed_purged_all_object¶

do_action( 'litespeed_purged_all_object' );

This hook has no parameters.

Fires after Purge All Object Cache.

litespeed_purged_all_opcache¶

do_action( 'litespeed_purged_all_opcache' );

This hook has no parameters.

Fires after Purge All OPcache.

litespeed_purged_single¶

do_action( 'litespeed_purged_single' );

This hook has no parameters.

Fires after Purge Single Tag.

litespeed_purged_esi¶

do_action( 'litespeed_purged_esi', string $tag );

Fires after Purge ESI Tag.

litespeed_purged_comment_widget¶

do_action( 'litespeed_purged_comment_widget', string $widget_id );

Fires after LSCWP adds the Recent Comments widget to the purge list in response to a comment-count update. Use it to trigger side effects (logging, purging related caches) when the widget is invalidated. Added in v1.1.3. Fired in src/purge.cls.php.

add_action( 'litespeed_purged_comment_widget', function( $widget_id ) {
    error_log( 'Recent Comments widget purged: ' . $widget_id );
} );

litespeed_purged_feeds¶

do_action( 'litespeed_purged_feeds' );

This hook has no parameters.

Fires after the feed tag is added to the purge list on a comment-count update. Only fires when the Feed TTL setting is greater than 0. Use it to purge any custom feed-related caches your plugin maintains. Added in v1.0.9. Fired in src/purge.cls.php.

add_action( 'litespeed_purged_feeds', function() {
    // Invalidate a custom cached feed.
    delete_transient( 'my_plugin_custom_feed' );
} );

litespeed_purged_on_logout¶

do_action( 'litespeed_purged_on_logout' );

This hook has no parameters.

Fires after the user’s private cache is purged on logout.

ESI¶

Edge Side Includes (ESI) lets you “punch holes” in an otherwise cached page so that specific fragments, such as nonces, shopping carts, and greeting banners, can be cached separately, cached per user, or not cached. See src/esi.cls.php. For background information, see ESI and LiteSpeed Cache.

Default WordPress nonces are already treated as ESI blocks automatically. They are cached for 12 hours independently of the surrounding page’s TTL. Register custom nonces with litespeed_nonce.

litespeed_nonce¶

do_action( 'litespeed_nonce', string $action );

Registers a custom nonce action so LSCWP serves it through ESI. Call this action before the code that creates the nonce.

If ESI is disabled for the request, LSCWP falls back to a normal wp_create_nonce() call, so it is safe to leave this action in place.

do_action( 'litespeed_nonce', 'example_nonce' );

litespeed_esi_status¶

apply_filters( 'litespeed_esi_status', bool $enabled );

Returns true when ESI is enabled for the current request. Use it as a guard before performing ESI-specific work.

litespeed_esi_url¶

apply_filters(
    'litespeed_esi_url',
    string $block_id,
    string $wrapper,
    array $params = array(),
    string $control = 'private,no-vary',
    bool $silence = false,
    bool $preserved = false,
    bool $svar = false,
    array $inline_param = array()
);

Generates an ESI include tag. Pair it with an add_action( 'litespeed_esi_load-{block_id}', ... ) callback that renders the block’s HTML.

<div>
    <?php
    echo apply_filters( 'litespeed_esi_url', 'my_esi_block', 'Custom ESI block' );
    ?>
</div>

add_action( 'litespeed_esi_load-my_esi_block', function () {
    do_action( 'litespeed_control_set_ttl', 300 );
    echo 'Hello world ' . rand( 1, 99999 );
} );

litespeed_esi_load-{block}¶

do_action( "litespeed_esi_load-{$block}", array $params );

Fires when the server requests the body of an ESI block named {block}. Your callback must output the block HTML. Inside the callback, use litespeed_control_set_ttl or litespeed_control_set_nocache to control block caching.

litespeed_esi_params¶

apply_filters( 'litespeed_esi_params', array $params, string $block_id );

Filters the parameter array attached to an ESI include immediately before it is serialized into the subrequest URL. Use it to add or remove context that the block requires.

litespeed_widget_default_options¶

apply_filters( 'litespeed_widget_default_options', array $options, WP_Widget $widget );

Filters default ESI options, including TTL and cache mode, for a widget. See thirdparty/woocommerce.cls.php for an implementation example.

litespeed_tpl_normal / litespeed_is_not_esi_template¶

do_action( 'litespeed_tpl_normal' );

These hooks have no parameters.

litespeed_tpl_normal signals that the current request is a normal top-level template request rather than an ESI subrequest. Third-party integrations use this to prevent ESI-only helpers from running twice. See thirdparty/yith-wishlist.cls.php and thirdparty/woocommerce.cls.php for implementation examples.

Vary¶

The vary cookie allows one URL to cache multiple versions, such as logged-in and guest versions, currencies, or languages. Use these hooks to control which cookies contribute to the vary value. See src/vary.cls.php.

litespeed_vary_cookies¶

apply_filters( 'litespeed_vary_cookies', array $cookies );

Adds cookies to the site-wide vary list. Every URL varies on a cookie added through this filter.

litespeed_vary_curr_cookies¶

apply_filters( 'litespeed_vary_curr_cookies', array $cookies );

Adds cookies to the vary list for the current request only. Use this filter when a cookie should affect caching only on some pages, such as a shopping-cart cookie relevant only at checkout.

function lscwp_add_custom_cookie( $list ) {
    $list[] = 'GDPR_cookie';

    return $list;
}

add_filter( 'litespeed_vary_curr_cookies', 'lscwp_add_custom_cookie' );
add_filter( 'litespeed_vary_cookies', 'lscwp_add_custom_cookie' );

litespeed_vary¶

apply_filters( 'litespeed_vary', array $vary );

Filters the in-progress vary value. Before finalization, it is an array. Afterwards, LSCWP converts it into a string stored in the default vary cookie.

litespeed_vary_ajax_force¶

do_action( 'litespeed_vary_ajax_force' );

This hook has no parameters.

Forces vary finalization during the current request even when it is an AJAX request. Use it when an AJAX endpoint sets a vary-relevant cookie that must persist before the response is sent.

litespeed_vary_no¶

do_action( 'litespeed_vary_no' );

This hook has no parameters.

Tells LSCWP not to create a vary for the current page.

litespeed_is_mobile¶

apply_filters( 'litespeed_is_mobile', bool $is_mobile );

Reads or modifies the mobile-vary status that LSCWP uses for the current request.

Cloud¶

These hooks relate to QUIC.cloud CDN integration. See src/cloud.cls.php.

litespeed_is_from_cloud¶

apply_filters( 'litespeed_is_from_cloud', bool $is_from_cloud );

When active, the filter returned true if the current request originated from a recognized QUIC.cloud CDN node. It was previously used to restrict custom REST endpoints to QUIC.cloud requests.

Optimize¶

Use these hooks to control CSS, JavaScript, and UCSS optimization. See src/optimize.cls.php, src/css.cls.php, and src/ucss.cls.php.

litespeed_can_optm¶

apply_filters( 'litespeed_can_optm', bool $can_optm );

Return false to skip page optimization, including CSS and JavaScript combining, minification, and deferral, for the current request.

litespeed_optm¶

do_action( 'litespeed_optm' );

This hook has no parameters.

Fires when LSCWP is about to run its optimization pass. Hook here to make a last-minute configuration change with litespeed_conf_force that affects optimization only for the current request.

add_action( 'litespeed_optm', function () {
    if ( get_post_type() === 'page' ) {
        do_action( 'litespeed_conf_force', 'optm-ucss', false );
    }
} );

litespeed_ccss_url¶

apply_filters( 'litespeed_ccss_url', string $url );

Modifies the URL that LSCWP treats as the page being generated for CCSS. Use it when several front-end URLs should share generated CCSS.

litespeed_ucss_url¶

apply_filters( 'litespeed_ucss_url', string $url );

Works like litespeed_ccss_url, but for UCSS.

litespeed_ucss_per_pagetype¶

apply_filters( 'litespeed_ucss_per_pagetype', bool $enabled );

By default, LSCWP generates UCSS per URL. Return true to generate one shared UCSS file for the current post type. URLs whose post types return false continue to use per-URL UCSS.

litespeed_optm_uri_exc¶

apply_filters( 'litespeed_optm_uri_exc', array $list );

Adds URI patterns to the LSCWP optimization exclusion list. Requests matching an entry are served without optimization.

litespeed_optimize_js_excludes¶

apply_filters( 'litespeed_optimize_js_excludes', array $list );

Adds files to JS Excludes. See JS Excludes.

litespeed_optm_js_defer_exc¶

apply_filters( 'litespeed_optm_js_defer_exc', array $list );

Adds files to JS Deferred/Delayed Excludes. See JS Deferred/Delayed Excludes.

litespeed_optm_gm_js_exc¶

apply_filters( 'litespeed_optm_gm_js_exc', array $list );

Adds files to Guest Mode JS Excludes. See Guest Mode JS Excludes.

litespeed_vpi_should_queue¶

apply_filters( 'litespeed_vpi_should_queue', bool $should_queue, string $request_url );

Return true or false to include or exclude a URL from the Viewport Images (VPI) queue.

litespeed_optm_html_after_head¶

apply_filters( 'litespeed_optm_html_after_head', bool $after_head );

By default, LSCWP places optimized UCSS, CCSS, combined CSS, and combined JavaScript blocks near the top of <head>. Return true to place them immediately before </head>.

Media¶

These hooks affect image and media processing. See src/media.cls.php.

litespeed_media_add_missing_sizes¶

apply_filters( 'litespeed_media_add_missing_sizes', bool $enabled );

Return false to bypass the Add Missing Sizes media option. This can be useful in Guest Optimization flows that do not need width and height attributes added.

GUI¶

These hooks relate to the admin bar and HTML wrappers used by the LSCWP front-end UI. See src/gui.cls.php.

litespeed_clean_wrapper_begin¶

apply_filters( 'litespeed_clean_wrapper_begin', string $marker );

Outputs an opening marker. LSCWP removes everything between it and the matching closing marker from the final HTML sent to browsers. Use the markers to wrap admin-only diagnostics.

litespeed_clean_wrapper_end¶

apply_filters( 'litespeed_clean_wrapper_end', string $marker );

Outputs the closing marker for litespeed_clean_wrapper_begin.

litespeed_frontend_shortcut / litespeed_backend_shortcut¶

do_action( 'litespeed_frontend_shortcut' );

These hooks have no parameters.

litespeed_frontend_shortcut fires when LSCWP renders front-end admin-bar shortcuts. litespeed_backend_shortcut renders corresponding admin-side shortcuts.

Debug¶

Use these hooks to write to wp-content/debug.log through the LSCWP logging channel. See src/debug2.cls.php.

litespeed_debug¶

do_action( 'litespeed_debug', string $message, mixed $context = null );

Writes a standard-level entry to wp-content/debug.log through the LSCWP log channel.

litespeed_debug2¶

do_action( 'litespeed_debug2', string $message, mixed $context = null );

Writes an advanced-level entry. It appears only when Admin IP Only or Debug Level: Advanced is active.

litespeed_disable_all¶

do_action( 'litespeed_disable_all', string $reason );

Disables all LSCWP debug logging for the remainder of the current request.

Buffer¶

Use these filters to modify page HTML before or after LSCWP transformations. See src/core.cls.php.

litespeed_buffer_before¶

apply_filters( 'litespeed_buffer_before', string $content );

Runs on the page buffer before LSCWP applies CDN URL rewrites, CSS and JavaScript optimization, image lazy loading, and other transformations.

add_filter( 'litespeed_buffer_before', function ( $content ) {
    return str_replace(
        '<link rel="pingback" href="https://example.com/xmlrpc.php">',
        '',
        $content
    );
}, 0 );

litespeed_buffer_after¶

apply_filters( 'litespeed_buffer_after', string $content );

Runs on the page buffer after LSCWP completes its transformations.

Debugging and developer tips¶

Working usage examples for most public hooks are under thirdparty/ in the plugin source. Searching that directory locally is often faster than searching GitHub.

Beyond the basic compatibility tests and troubleshooting steps, you can open a support ticket or join the #wpcache-dev channel on Slack for help and to share integration work.