Skip to content

Add wp cache flush-group for flushing a cache group #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielbachhuber merged 8 commits into from
Apr 26, 2023
Merged

Add wp cache flush-group for flushing a cache group #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e457f5e
Added group flushing.
janw-me Apr 5, 2023
ac0f8e0
Added failsafe for older WP versions.
janw-me Apr 5, 2023
f64f35f
Processed feedback.
janw-me Apr 7, 2023
7224f08
Merge branch 'main' into issues-80-wp_cache_flush_group
janw-me Apr 17, 2023
4b8c339
Added test for error on clear-group
janw-me Apr 17, 2023
45e3790
Renamed clear-group to flush-group
janw-me Apr 26, 2023
5b60b69
Set correct error message in the test.
janw-me Apr 26, 2023
e8d2fa8
Make sure a test only runs at 6.1 or later.
janw-me Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,27 @@ Errors if the object cache can't be flushed.



### wp cache flush-group

Removes all cache items in a group, if the object cache implementation supports it.

~~~
wp cache flush-group <group>
~~~

**OPTIONS**

<group>
Cache group key.

**EXAMPLES**

# Clear cache group.
$ wp cache flush-group my_group
Success: Cache group 'my_group' was flushed.



### wp cache get

Gets a value from the object cache.
Expand Down
1 change: 1 addition & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"cache decr",
"cache delete",
"cache flush",
"cache flush-group",
"cache get",
"cache incr",
"cache replace",
Expand Down
53 changes: 53 additions & 0 deletions features/cache.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,59 @@ Feature: Managed the WordPress object cache
Error: Could not replace object 'bar' in group 'foo'. Does it not exist?
"""

@require-wp-6.1
Scenario: Some cache groups cannot be cleared.
Given a WP install
When I run `wp cache flush-group add_multiple`
Then STDOUT should be:
"""
Success: Cache group 'add_multiple' was flushed.
"""
Copy link
Member

@danielbachhuber danielbachhuber Apr 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll want to move this step to a new scenario so you can control it with @require-wp-6.1


@require-wp-6.1
Scenario: Some cache groups cannot be cleared.
Given a WP install
And a wp-content/mu-plugins/unclearable-test-cache.php file:
"""php
<?php
class Dummy_Object_Cache extends WP_Object_Cache {
public function flush_group( $group ) {
if ( $group === 'permanent_root_cache' ) {
return false;
}
return parent::flush_group( $group );
}
}
$GLOBALS['wp_object_cache'] = new Dummy_Object_Cache();
"""
When I try `wp cache flush-group permanent_root_cache`
Then STDERR should be:
"""
Error: Cache group 'permanent_root_cache' was not flushed.
"""

@less-than-wp-6.1
Scenario: Some cache groups cannot be cleared.
Given a WP install
And a wp-content/mu-plugins/unclearable-test-cache.php file:
"""php
<?php
class Dummy_Object_Cache extends WP_Object_Cache {
public function flush_group( $group ) {
if ( $group === 'permanent_root_cache' ) {
return false;
}
return parent::flush_group( $group );
}
}
$GLOBALS['wp_object_cache'] = new Dummy_Object_Cache();
"""
When I try `wp cache flush-group permanent_root_cache`
Then STDERR should be:
"""
Error: Group flushing is not supported.
"""

Scenario: Flushing cache on a multisite installation
Given a WP multisite installation

Expand Down
29 changes: 29 additions & 0 deletions src/Cache_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,4 +378,33 @@ public function supports( $args, $assoc_args ) {
WP_CLI::halt( 1 );
}

/**
* Removes all cache items in a group, if the object cache implementation supports it.
*
* ## OPTIONS
*
* <group>
* : Cache group key.
*
* ## EXAMPLES
*
* # Clear cache group.
* $ wp cache flush-group my_group
* Success: Cache group 'my_group' was flushed.
*
* @subcommand flush-group
*/
public function flush_group( $args, $assoc_args ) {
list( $group ) = $args;

if ( ! function_exists( 'wp_cache_supports' ) || ! wp_cache_supports( 'flush_group' ) ) {
WP_CLI::error( 'Group flushing is not supported.' );
}

if ( ! wp_cache_flush_group( $group ) ) {
WP_CLI::error( "Cache group '$group' was not flushed." );
}
WP_CLI::success( "Cache group '$group' was flushed." );
}

}