Linux 软件免费装
Banner图

WP REST Cache

开发者 acato
rockfire
yoeridekker
更新时间 2025年6月25日 20:31
PHP版本: 7.0 及以上
WordPress版本: 6.8
版权: GPLv3
版权网址: 版权信息

标签

cache api rest wp-rest-api rest cache

下载

2019.2.1 2019.4.0 2019.4.1 2019.4.2 2019.4.3 2019.4.4 2019.4.5 2020.1.0 2020.2.1 2020.2.2 2020.3.0 2020.3.1 2021.2.0 2021.2.1 2024.2.2 2021.4.0 2021.4.1 2022.2.1 2019.2.0 2020.2.0 2021.1.0 2022.2.0 2022.2.2 2023.1.0 2019.1.5 2022.1.0 2024.1.1 2024.1.2 2022.1.1 2023.2.0 2020.1.1 2020.3.2 2024.2.0 2019.3.0 2023.2.1 2024.1.0 2024.2.1 2024.2.3 2024.3.0 2025.1.0 2025.1.1 2019.1.2 2019.1.3 2019.1.4 2019.1.6 2021.3.0 2022.1.2 2023.1.1 2024.1.3 2025.1.2 2025.1.3 2025.1.4

详情介绍:

Are you facing speed issues, using the WordPress REST API? This plugin will allow WordPress to cache the responses of the REST API, making it much faster. This plugin offers:

屏幕截图:

  • An overview of cached endpoint calls.
  • An overview of cached single items.
  • Cache details page - Cache info.
  • Cache details page - Cache data.

常见问题:

I have edited a page/post, do I need to clear the cache?

No, the plugin will automatically flush all cache related to the page/post you just edited.

I have created a custom post type, will the plugin cache the custom post type endpoint?

Yes, the plugin will automatically cache the endpoint of custom post types. Unless you have created a custom WP_REST_Controller for it, then it will not automatically cache the endpoint.

I have created a custom taxonomy, will the plugin cache the taxonomy endpoint?

Yes, the plugin will automatically cache the endpoint of custom taxonomies. Unless you have created a custom WP_REST_Controller for it, then it will not automatically cache the endpoint.

I have created a custom WP REST endpoint, will the plugin cache this endpoint?

No, the plugin will not cache your custom endpoint unless you tell it to cache it using the hook wp_rest_cache/allowed_endpoints (See 'Can I register my own endpoint for caching?'). Please keep in mind that once you do so the plugin will not automatically flush the cache of that endpoint if something is edited (it has no way of knowing when to flush the cache). It will however try to determine the relations and for the determined relations it will flush the cache automatically once the relation is edited.

Can I register my own endpoint for caching?

Yes you can! Use the hook wp_rest_cache/allowed_endpoints like this: `/**

  • Register the /wp-json/acf/v3/posts endpoint so it will be cached. / function wprc_add_acf_posts_endpoint( $allowed_endpoints ) { if ( ! isset( $allowed_endpoints[ 'acf/v3' ] ) || ! in_array( 'posts', $allowed_endpoints[ 'acf/v3' ] ) ) { $allowed_endpoints[ 'acf/v3' ][] = 'posts'; } return $allowed_endpoints; } add_filter( 'wp_rest_cache/allowed_endpoints', 'wprc_add_acf_posts_endpoint', 10, 1);` Please note:* the WP REST Cache plugin will try to detect relations in the cached data to automatically flush the cache when related items are edited, but this detection is not flawless so your caches might not be flushed automatically.

Can I unregister an endpoint so it is no longer cached?

Yes you can! Use the hook wp_rest_cache/allowed_endpoints like this: `/**

  • Unregister the /wp-json/wp/v2/comments endpoint so it will not be cached. */ function wprc_unregister_wp_comments_endpoint( $allowed_endpoints ) { if ( isset( $allowed_endpoints[ 'wp/v2' ] ) && ( $key = array_search( 'comments', $allowed_endpoints[ 'wp/v2' ] ) ) !== false ) { unset( $allowed_endpoints[ 'wp/v2' ][ $key ] ); } return $allowed_endpoints; } add_filter( 'wp_rest_cache/allowed_endpoints', 'wprc_unregister_wp_comments_endpoint', 100, 1);`

Can I force a call to the REST API to not use caching?

Yes you can! Add the GET-parameter skip_cache=1 to your call and no caching will be used.

On the cache overview page I see the object type is 'unknown'. Can I help the WP REST Cache plugin to detect the object type correctly?

Yes you can! Use the hook wp_rest_cache/determine_object_type like this: function wprc_determine_object_type( $object_type, $cache_key, $data, $uri ) { if ( $object_type !== 'unknown' || strpos( $uri, $your_namespace . '/' . $your_rest_base ) === false ) { return $object_type; } // Do your magic here $object_type = 'website'; // Do your magic here return $object_type; } add_filter( 'wp_rest_cache/determine_object_type', 'wprc_determine_object_type', 10, 4 );

Can expired caches be automatically regenerated?

Yes they can! Go to Settings > WP REST Cache, on the Settings tab you can check Enable cache regeneration, this will activate a cron job which will check if there are any expired (or flushed) caches and regenerate them. Using the Regeneration interval you can determine how often this regeneration process should run. The Max number regenerate caches limits the number of regenerated caches per regeneration process, this is so your server doesn't get flooded with the regeneration calls.

Can I hide the 'Clear REST cache' in the wp-admin bar?

Yes you can! Use the hook wp_rest_cache/display_clear_cache_button like this: function wprc_display_clear_cache_button( $show ) { return false; } add_filter('wp_rest_cache/display_clear_cache_button', 'wprc_display_clear_cache_button', 10, 1);

Can I differentiate between caches based upon request headers?

Yes you can! There are two options for this:

  1. Go to Settings > WP REST Cache and add Global cacheable request headers. This is a comma seperated list. These headers will be used for ALL endpoints.
  2. Use the hook wp_rest_cache/cacheable_request_headers to specify per endpoint which request headers should be used. Like this: function wprc_add_cacheable_request_headers( $cacheable_headers ) { $cacheable_headers['wp/v2/posts'] = 'LANG'; return $cacheable_headers; } add_filter('wp_rest_cache/cacheable_request_headers', 'wprc_add_cacheable_request_headers', 10, 1);

Can I change which users can change the settings and flush caches?

Yes you can! Use the hook wp_rest_cache/settings_capability like this: function wprc_change_settings_capability( $capability ) { // Change the capability to users who can edit posts. return 'edit_posts'; } add_filter('wp_rest_cache/settings_capability', 'wprc_change_settings_capability', 10, 1);

Can I use WP CLI to flush caches from the command line?

Yes you can! Use the wp wp-rest-cache flush command to flush caches. Type wp wp-rest-cache flush --help to see all options.

Is Redis Object Cache supported?

We are using the WordPress transient API, so as long as you are using a Redis Object Cache plugin which enables Redis caching through the transients API it is supported.

How can I report security bugs?

You can report security bugs through the Patchstack Vulnerability Disclosure Program. The Patchstack team helps validate, triage and handle any security vulnerabilities. Report a security vulnerability.

更新日志:

2025.1.4 Release Date: June 25th, 2025 Fix: Better checking of existing primary key before updating it. 2025.1.3 Release Date: June 25th, 2025 Fix: Check if primary key exists before dropping it. 2025.1.2 Release Date: June 11th, 2025 Fix: Make sure comment endpoints are flushed when the corresponding post is deleted or unpublished. Improvement: Add VDP to FAQ. 2025.1.1 Release Date: June 6th, 2025 Fix: A path-traversal vulnerability in the plugin was discovered and fixed. It was reported by Darius Sveikauskas. 2025.1.0 Release Date: April 10th, 2025 Improvement: Flush media endpoint caches when a new media has been uploaded. Earlier versions For the changelog of earlier versions, please refer to the changelog on Github.