Changeset 54080 for trunk/src/wp-includes/ms-network.php

Timestamp:

09/06/2022 11:26:45 AM (2 years ago)

Author:

spacedmonkey

Message:

Networks and Sites: Use metadata api in *_network_options` functions.

Replace logic found in get_network_option, update_network_option and delete_network_option to use the metadata api. Using the metadata api has a number of benefits, such as consistency, default values and useful filters. This change also improves performance by priming the caches of all network options in a single database request.

Props spacedmonkey, swissspidy, sc0ttkclark, johnjamesjacoby, flixos90, jeremyfelt, pento, peterwilsoncc, mukesh27, desrosj.
Fixes #37181

File:

• trunk/src/wp-includes/ms-network.php (modified) (5 diffs)

trunk/src/wp-includes/ms-network.php

@@ -85 +85 @@
     $network_ids = (array) $ids;
     wp_cache_delete_multiple( $network_ids, 'networks' );
+    wp_cache_delete_multiple( $network_ids, 'site_meta' );
 
     foreach ( $network_ids as $id ) {
@@ -108 +109 @@
  *
  * @since 4.6.0
+ * @since 6.1.0 Introduced the `$update_meta_cache` parameter.
  *
- * @param array $networks Array of network row objects.
+ * @param array $networks          Array of network row objects.
+ * @param bool  $update_meta_cache Whether to update site meta cache. Default true.
  */
-function update_network_cache( $networks ) {
+function update_network_cache( $networks, $update_meta_cache = true ) {
     $data = array();
     foreach ( (array) $networks as $network ) {
         $data[ $network->id ] = $network;
     }
+
     wp_cache_add_multiple( $data, 'networks' );
+    if ( $update_meta_cache ) {
+        $network_ids = array_keys( $data );
+        update_meta_cache( 'site', $network_ids );
+    }
 }
 
@@ -123 +131 @@
  *
  * @since 4.6.0
+ * @since 6.1.0 Introduced the `$update_meta_cache` parameter.
  * @since 6.1.0 This function is no longer marked as "private".
  *
@@ -128 +137 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param array $network_ids Array of network IDs.
+ * @param array $network_ids       Array of network IDs.
+ * @param bool  $update_meta_cache Whether to update site meta cache. Default true.
  */
-function _prime_network_caches( $network_ids ) {
+function _prime_network_caches( $network_ids, $update_meta_cache = true ) {
     global $wpdb;
 
@@ -137 +147 @@
         $fresh_networks = $wpdb->get_results( sprintf( "SELECT $wpdb->site.* FROM $wpdb->site WHERE id IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
-        update_network_cache( $fresh_networks );
+        update_network_cache( $fresh_networks, $update_meta_cache );
     }
 }