Changeset 6208 for sites/trunk/api.wordpress.org/public_html/events/1.0/index.php

Timestamp:

12/03/2017 05:28:28 PM (7 years ago)

Author:

iandunn

Message:

Events: Abstract the Core user agent check, to allow reuse.

File:

• sites/trunk/api.wordpress.org/public_html/events/1.0/index.php (modified) (2 diffs)

sites/trunk/api.wordpress.org/public_html/events/1.0/index.php

@@ -161 +161 @@
     return compact( 'error', 'location', 'events' );
 
+}
+
+/**
+ * Determine if the client making the API request is WordPress Core.
+ *
+ * This can be used to limit the effects of some data processing to just the Events Widget in
+ * Core. Otherwise, those changes would result in unexpected data for other clients, like
+ * having WordCamps stuck to the end of the request by `stick_wordcamps()`.
+ *
+ * Ideally this would be isolated to Core itself, and exclude plugins using `wp_remote_get()`.
+ * There isn't a good way to do that, though, so plugins will still get unexpected results.
+ * They can set a custom user agent to get the raw data, though.
+ *
+ * @param string $user_agent
+ *
+ * @return bool
+ */
+function is_client_core( $user_agent ) {
+    // This doesn't simply return the value of `strpos()` because `0` means `true` in this context
+    if ( false === strpos( $user_agent, 'WordPress/' ) ) {
+        return false;
+    }
+
+    return true;
 }
 
@@ -732 +756 @@
     $regional_wordcamps = array();
 
-    /*
-     * Limit effects to the Events Widget in Core.
-     * Otherwise this would return unexpected results to other clients.
-     *
-     * This is the closest we can get to detecting Core, so it'll still distort results for any
-     * plugins that are fetching events with `wp_remote_get()`.
-     */
-    if ( false === strpos( $user_agent, 'WordPress/' ) ) {
+    if ( ! is_client_core( $user_agent ) ) {
         return $local_events;
     }