Changeset 6751

Timestamp:

12/08/2017 02:09:08 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Intercept: first pass intercept API.

This change introduces 3 new functions for generating a default intercept value and comparing against it in specific places. If the return value differs from the default intercept value, we know that function call was intercepted by a filter, and that value will become the new return value without executing the remaining part of the function.

See #3184.

Location:

trunk/src/includes

Files:

• core/abstraction.php (modified) (5 diffs)
• core/options.php (modified) (1 diff)
• extend/buddypress/functions.php (modified) (1 diff)
• topics/template.php (modified) (1 diff)
• users/template.php (modified) (7 diffs)

trunk/src/includes/core/abstraction.php

@@ -74 +74 @@
 }
 
+/** Globals *******************************************************************/
+
 /**
  * Lookup and return a global variable
@@ -144 +146 @@
     return bbp_get_global_object( 'wpdb', 'WPDB' );
 }
+
+/** Pagination ****************************************************************/
 
 /**
@@ -302 +306 @@
 }
 
+/** Multisite *****************************************************************/
+
 /**
  * Is this a large bbPress installation?
@@ -359 +365 @@
  * @since 2.6.0 bbPress (r6733)
  */
-function bbp_restore_current_site( ) {
+function bbp_restore_current_site() {
 
     // Switch back to the original site
@@ -365 +371 @@
         restore_current_blog();
     }
+}
+
+/** Interception **************************************************************/
+
+/**
+ * Generate a default intercept value.
+ *
+ * @since 2.6.0
+ *
+ * @staticvar mixed $rand Null by default, random string on first call
+ *
+ * @return string
+ */
+function bbp_default_intercept() {
+    static $rand = null;
+
+    // Generate a new random and unique string
+    if ( null === $rand ) {
+
+        // If ext/hash is not present, compat.php's hash_hmac() does not support sha256.
+        $algo = function_exists( 'hash' )
+            ? 'sha256'
+            : 'sha1';
+
+        // Old WP installs may not have AUTH_SALT defined.
+        $salt = defined( 'AUTH_SALT' ) && AUTH_SALT
+            ? AUTH_SALT
+            : (string) wp_rand();
+
+        // Create unique ID
+        $rand = hash_hmac( $algo, uniqid( $salt, true ), $salt );
+    }
+
+    // Return random string (from locally static variable)
+    return $rand;
+}
+
+/**
+ * Whether a value has been intercepted
+ *
+ * @since 2.6.0
+ *
+ * @param bool $value
+ */
+function bbp_is_intercepted( $value = '' ) {
+    return ( bbp_default_intercept() === $value );
+}
+
+/**
+ * Allow interception of a method or function call.
+ *
+ * @since 2.6.0
+ *
+ * @param string $action Typically the name of the caller function
+ * @param array  $args   Typically the results of caller function func_get_args()
+ *
+ * @return mixed         Intercept results. Default bbp_default_intercept().
+ */
+function bbp_maybe_intercept( $action = '', $args = array() ) {
+
+    // Backwards compatibility juggle
+    $hook      = ( false === strpos( $action, 'pre_' ) )
+        ? "pre_{$action}"
+        : $action;
+
+    // Sanitize the hook same
+    $key       = sanitize_key( $hook );
+
+    // Default return value
+    $default   = bbp_default_intercept();
+
+    // Filter and return
+    return apply_filters( $key, $default, extract( (array) $args ) );
 }
 

trunk/src/includes/core/options.php

@@ -263 +263 @@
     }
 
-    // Bail if strategy is overloaded to false|null
-    $strategy = apply_filters( 'bbp_pre_load_options', 'notoptions' );
-    if ( empty( $strategy ) ) {
-        return;
+    // Maybe intercept
+    $intercept = bbp_maybe_intercept( __FUNCTION__, 'notoptions' );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
     }
 

trunk/src/includes/extend/buddypress/functions.php

@@ -794 +794 @@
     }
 
-    /**
-     * Overrides the formatted activity action new activity string.
-     *
-     * @since 2.6.0 bbPress (r6370)
-     *
-     * @param string               $activity_action Activity action string value
-     * @param string               $type            The type of post. Expects `topic` or `reply`.
-     * @param string               $action          The current action string.
-     * @param BP_Activity_Activity $activity        The BuddyPress activity object.
-     */
-    if ( $pre = apply_filters( 'bbp_pre_format_activity_action_new_post', false, $type, $action, $activity ) ) {
-        return $pre;
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( __FUNCTION__, func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
     }
 

trunk/src/includes/topics/template.php

@@ -321 +321 @@
 function bbp_add_sticky_topics( &$query, $args = array() ) {
 
-    // Bail if overloaded
-    if ( null !== apply_filters( 'bbp_pre_add_stick_topics', null, $query, $args ) ) {
-        return;
+    // Bail if intercepted
+    $intercept = bbp_maybe_intercept( __FUNCTION__, func_get_args() );
+    if ( bbp_is_intercepted( $intercept ) ) {
+        return $intercept;
     }
 

trunk/src/includes/users/template.php

@@ -535 +535 @@
         }
 
-        // Allow early overriding of the profile URL to cut down on processing
-        $early_profile_url = apply_filters( 'bbp_pre_get_user_profile_url', $user_id );
-        if ( is_string( $early_profile_url ) ) {
-            return $early_profile_url;
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_profile_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
         }
 
@@ -625 +625 @@
         }
 
-        // Allow early overriding of the profile edit URL to cut down on processing
-        $early_profile_url = apply_filters( 'bbp_pre_get_user_profile_edit_url', $user_id );
-        if ( is_string( $early_profile_url ) ) {
-            return $early_profile_url;
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_profile_edit_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
         }
 
@@ -984 +984 @@
         }
 
-        // Allow early overriding of the profile URL to cut down on processing
-        $early_profile_url = apply_filters( 'bbp_pre_get_favorites_permalink', $user_id );
-        if ( is_string( $early_profile_url ) ) {
-            return $early_profile_url;
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_favorites_permalink', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
         }
 
@@ -1175 +1175 @@
         }
 
-        // Allow early overriding of the profile URL to cut down on processing
-        $early_profile_url = apply_filters( 'bbp_pre_get_subscriptions_permalink', $user_id );
-        if ( is_string( $early_profile_url ) ) {
-            return $early_profile_url;
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_subscriptions_permalink', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
         }
 
@@ -1614 +1614 @@
         }
 
-        // Allow early overriding of the profile URL to cut down on processing
-        $early_url = apply_filters( 'bbp_pre_get_user_topics_created_url', $user_id );
-        if ( is_string( $early_url ) ) {
-            return $early_url;
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_topics_created_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
         }
 
@@ -1667 +1667 @@
         }
 
-        // Allow early overriding of the profile URL to cut down on processing
-        $early_url = apply_filters( 'bbp_pre_get_user_replies_created_url', $user_id );
-        if ( is_string( $early_url ) ) {
-            return $early_url;
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_replies_created_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
         }
 
@@ -1720 +1720 @@
         }
 
-        // Allow early overriding of the profile URL to cut down on processing
-        $early_url = apply_filters( 'bbp_pre_get_user_engagements_url', $user_id );
-        if ( is_string( $early_url ) ) {
-            return $early_url;
+        // Bail if intercepted
+        $intercept = bbp_maybe_intercept( 'bbp_pre_get_user_engagements_url', func_get_args() );
+        if ( bbp_is_intercepted( $intercept ) ) {
+            return $intercept;
         }