Changeset 40790 for trunk/src/wp-admin/includes/ajax-actions.php

Timestamp:

05/19/2017 05:48:01 AM (8 years ago)

Author:

azaozz

Message:

Dashboard: Improve the handling of locations determined by geolocating the IP address and by entering a city name. Fix couple of edge cases, and some names.

Props iandunn coreymckrill.
Fixes #40702.

File:

• trunk/src/wp-admin/includes/ajax-actions.php (modified) (2 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -313 +313 @@
     $events_client  = new WP_Community_Events( $user_id, $saved_location );
     $events         = $events_client->get_events( $search, $timezone );
+    $ip_changed     = false;
 
     if ( is_wp_error( $events ) ) {
@@ -319 +320 @@
         ) );
     } else {
-        if ( isset( $events['location'] ) ) {
-            // Store the location network-wide, so the user doesn't have to set it on each site.
+        if ( empty( $saved_location['ip'] ) && ! empty( $events['location']['ip'] ) ) {
+            $ip_changed = true;
+        } elseif ( isset( $saved_location['ip'] ) && ! empty( $events['location']['ip'] ) && $saved_location['ip'] !== $events['location']['ip'] ) {
+            $ip_changed = true;
+        }
+
+        /*
+         * The location should only be updated when it changes. The API doesn't always return
+         * a full location; sometimes it's missing the description or country. The location
+         * that was saved during the initial request is known to be good and complete, though.
+         * It should be left in tact until the user explicitly changes it (either by manually
+         * searching for a new location, or by changing their IP address).
+         *
+         * If the location were updated with an incomplete response from the API, then it could
+         * break assumptions that the UI makes (e.g., that there will always be a description
+         * that corresponds to a latitude/longitude location).
+         *
+         * The location is stored network-wide, so that the user doesn't have to set it on each site.
+         */
+        if ( $ip_changed || $search ) {
             update_user_option( $user_id, 'community-events-location', $events['location'], true );
         }