Feature: Add wp_cache_replace_multiple function

[Debarghya-Banerjee]

Trac Ticket: Core-56060

Overview

• This Pull Request introduces the wp_cache_replace_multiple function, addressing the need to replace multiple cache values only if they already exist. This functionality is essential for scenarios involving multiple caching backends, allowing developers to manage cache data without unintentionally adding new entries.

Problem Statement

• The existing replace() method does not effectively check for the existence of multiple keys, particularly when the $group parameter is empty. This limitation can cause issues in managing caches across different backends, especially when updates are needed without creating new entries.

Key Features

• Conditional Replacement: The function checks if each specified key exists in the cache before attempting to replace its value, ensuring that only existing keys are updated.

• Batch Processing: It utilizes set_multiple() for efficient bulk updates, minimizing backend calls and improving overall performance.

• Return Values: The function returns an array of keys that were successfully replaced, providing clear feedback on the updates made.

Benefits

• Improved Cache Integrity: Prevents the addition of new entries, maintaining the integrity of existing cache data.

• Performance Efficiency: Reduces unnecessary operations by only updating existing entries.

• Usability: Enhances developer experience with a straightforward approach to manage cache values.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props debarghyabanerjee, apermo.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• The Plugin and Theme Directories cannot be accessed within Playground.
• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

[Debarghya-Banerjee]

Hi @spacedmonkey , can you please take a look into this PR. Thanks.

[apermo]

WPCS fixed for PHPDoc, otherwise it looks good to me.