Changeset 13991 for trunk/src/bp-core/classes/class-bp-optout.php

Timestamp:

07/27/2024 08:16:17 PM (19 months ago)

Author:

espellcaste

Message:

Core: Add cache_results flag to the BP_Optout::get getter.

When performing a request with cache_results, it stops the optout information retrieved from being added to the cache.

See #8552
Closes ​https://github.com/buddypress/buddypress/pull/344/

File:

• trunk/src/bp-core/classes/class-bp-optout.php (modified) (12 diffs)

trunk/src/bp-core/classes/class-bp-optout.php

@@ -102 +102 @@
      * @global wpdb $wpdb WordPress database object.
      *
-     * @return bool
+     * @return false|int
      */
     public function save() {
+        global $wpdb;
 
         // Return value.
@@ -110 +111 @@
 
         // Default data and format.
-        $data        = array(
+        $data = array(
             'email_address_hash' => $this->email_address,
             'user_id'            => $this->user_id,
@@ -116 +117 @@
             'date_modified'      => $this->date_modified,
         );
+
         $data_format = array( '%s', '%d', '%s', '%s' );
 
@@ -123 +125 @@
          * @since 8.0.0
          *
-         * @param BP_Optout object $this Characteristics of the opt-out to be saved.
+         * @param BP_Optout $bp_optout Characteristics of the opt-out to be saved.
          */
         do_action_ref_array( 'bp_optout_before_save', array( &$this ) );
@@ -137 +139 @@
         // Set the opt-out ID if successful.
         if ( ! empty( $result ) && ! is_wp_error( $result ) ) {
-            global $wpdb;
-
             $this->id = $wpdb->insert_id;
             $retval   = $wpdb->insert_id;
@@ -505 +505 @@
      *
      * @since 8.0.0
+     * @since 15.0.0 Introduced the `cache_results` parameter.
      *
      * @global wpdb $wpdb WordPress database object.
@@ -526 +527 @@
      *                                           Default: false (no pagination,
      *                                           all items).
+     *     @type bool         $cache_results     Optional. Whether to cache the optout information. Default: true.
      *     @type int          $per_page          Number of items to show per page.
      *                                           Default: false (no pagination,
@@ -541 +543 @@
     public static function get( $args = array() ) {
         global $wpdb;
+
         $optouts_table_name = self::get_table_name();
 
@@ -556 +559 @@
                 'page'          => false,
                 'per_page'      => false,
+                'cache_results' => true,
                 'fields'        => 'all',
             ),
@@ -562 +566 @@
 
         $sql = array(
-            'select'     => 'SELECT',
-            'fields'     => '',
-            'from'       => "FROM {$optouts_table_name} o",
-            'where'      => '',
-            'orderby'    => '',
-            'pagination' => '',
+            'select' => 'SELECT',
+            'from'   => "FROM {$optouts_table_name} o",
         );
 
@@ -612 +612 @@
          * @since 8.0.0
          *
-         * @param string $value Concatenated SQL statement.
-         * @param array  $sql   Array of SQL parts before concatenation.
-         * @param array  $r     Array of parsed arguments for the get method.
+         * @param string $paged_optouts_sql Concatenated SQL statement.
+         * @param array  $sql               Array of SQL parts before concatenation.
+         * @param array  $r                 Array of parsed arguments for the get method.
          */
         $paged_optouts_sql = apply_filters( 'bp_optouts_get_paged_optouts_sql', $paged_optouts_sql, $sql, $r );
 
-        $cached = bp_core_get_incremented_cache( $paged_optouts_sql, 'bp_optouts' );
-        if ( false === $cached ) {
+        if ( $r['cache_results'] ) {
+            $cached = bp_core_get_incremented_cache( $paged_optouts_sql, 'bp_optouts' );
+            if ( false === $cached ) {
+                $paged_optout_ids = $wpdb->get_col( $paged_optouts_sql );
+                bp_core_set_incremented_cache( $paged_optouts_sql, 'bp_optouts', $paged_optout_ids );
+            } else {
+                $paged_optout_ids = $cached;
+            }
+        } else {
             $paged_optout_ids = $wpdb->get_col( $paged_optouts_sql );
-            bp_core_set_incremented_cache( $paged_optouts_sql, 'bp_optouts', $paged_optout_ids );
-        } else {
-            $paged_optout_ids = $cached;
         }
 
@@ -634 +638 @@
         }
 
-        $uncached_ids = bp_get_non_cached_ids( $paged_optout_ids, 'bp_optouts' );
-        if ( $uncached_ids ) {
-            $ids_sql      = implode( ',', array_map( 'intval', $uncached_ids ) );
-            $data_objects = $wpdb->get_results( "SELECT o.* FROM {$optouts_table_name} o WHERE o.id IN ({$ids_sql})" );
-            foreach ( $data_objects as $data_object ) {
-                wp_cache_set( $data_object->id, $data_object, 'bp_optouts' );
+        if ( $r['cache_results'] ) {
+            $uncached_ids = bp_get_non_cached_ids( $paged_optout_ids, 'bp_optouts' );
+            if ( $uncached_ids ) {
+                $ids_sql      = implode( ',', array_map( 'intval', $uncached_ids ) );
+                $data_objects = $wpdb->get_results( "SELECT o.* FROM {$optouts_table_name} o WHERE o.id IN ({$ids_sql})" );
+                foreach ( $data_objects as $data_object ) {
+                    wp_cache_set( $data_object->id, $data_object, 'bp_optouts' );
+                }
             }
         }