Provide a way to load multiple specific network options with a single database / cache request

[spacedmonkey]

There is already a way to prime caches for options in a single request, in the functions wp_prime_option_caches. In WordPress multisite context, there is already wp_load_core_site_options, but that function is designed to run once and is not a developer function. A function should be added to core to allow developers to prime network options caches with a single function call. This function should be used inside of wp_load_core_site_options.

Follow on from #58962 [56445],[56990]

Introduced the new function wp_prime_network_option_caches in option.php. This function simplifies the handling of network option caches, enhancing the speed of operations. In the wp_load_core_site_options function, removed cache processing code and replaced it with a call to the new function. These changes improve code efficiency and readability.

Trac ticket: https://core.trac.wordpress.org/ticket/61053

[peterwilsoncc]

@spacedmonkey I was under the impression that the site options used the meta cache, either directly or indirectly.

If that isn't the case, is there any reason it can't be set up as such?

[spacedmonkey]

Replying to peterwilsoncc:

@spacedmonkey I was under the impression that the site options used the meta cache, either directly or indirectly.

If that isn't the case, is there any reason it can't be set up as such?

There is a ticket for converting these functions to use metadata api, see #37181. It was committed in [54080] and then reverted in [54637]. I haven't had a chance loop back on that ticket.

It is unclear to me that loading all network options in memory for every request would be a good thing for performance. Loading in all network transients ( if object cache is not enabled ), might result in megabytes of text or json, might have serious performance issues.

Amazing feedback @peterwilsoncc . It is really appricated. Your best code review! Legend.

[peterwilsoncc]

The ​linked pull request looks good for commit.

@spacedmonkey I'll assign this to you and let you do the honours, thanks for your patience during the review process.

Thanks for the feedback @joemcgill . Actioned feedback.

[spacedmonkey]

In 58182:

Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.

WordPress's get_network_option function generally makes individual database requests for each network option. While some options are preloaded in wp_load_core_site_options, many still require single database calls to the network options table.

Building on the work done in [56445], [56990], and [57013], which introduced the wp_prime_option_caches function, this commit adds two new functions: wp_prime_network_option_caches and wp_prime_site_option_caches. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.

The function wp_prime_site_option_caches is similar to get_site_option, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.

These functions have been implemented in wp_load_core_site_options, get_site_transient, and set_site_transient.

Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.

Committed ​https://github.com/WordPress/wordpress-develop/commit/6662cb0bef6bdd3fd2aa02db92f5781a4b5db657