wpsl_distance_unit - WP Store Locator

Description
Usage
Changelog
Source File

Description

This filter allows you to switch between km and miles in the search results based on the visitor’s location.

You can use this to show the distance in miles for US-based visitors, and in kilometers for visitors from other parts of the world.

Usage

The code below shows how to use the filter.

In the first part, we call the actual filter and the wpsl_get_user_country function to get the country code from the current visitor.

add_filter( 'wpsl_distance_unit', 'custom_distance_unit' ); function custom_distance_unit() { $user_country = wpsl_get_user_country(); // Set the correct distance unit if ( $user_country == 'US' ) { $distance_unit = 'mi'; } else { $distance_unit = 'km'; } return $distance_unit; }

The code below shows the wpsl_get_user_country function. This makes the call to the IP Geolocation API from freegeoip.net to determine the country code based on the IP used.

/** * Get the country name for the current user based on the used IP. * * @return string $user_country The name of the country the users IP is from. */ function wpsl_get_user_country() { // The API key from https://ipstack.com/. $api_key = ''; // How long before the cache expires in seconds $cache_expires = 1800; // Grab the users IP $user_ip = wpsl_get_user_ip(); /* * Uncomment the line below if you want to test it with a US based IP. * This will make the distance show up in miles instead of kilometers. */ //$user_ip = '54.239.17.6'; // Create the name for the transient that holds the country the IP originates from. $transient_name = 'wpsl_' . filter_var( $user_ip, FILTER_SANITIZE_NUMBER_INT ) . '_user_country'; // The URL to the IP Geolocation API $api_url = 'http://api.ipstack.com/' . $user_ip . '?access_key='. $api_key; // If no existing transient exists, then we have to determine which county the IP is from. if ( false === ( $user_country = get_transient( $transient_name ) ) ) { // Get the country name the IP is located in. $response = wp_remote_get( $api_url ); if ( !is_wp_error( $response ) ) { $user_location = json_decode( wp_remote_retrieve_body( $response ) ); $user_country = $user_location->country_code; // If the API returns a country code, then save it for 30 minutes ( 1800 seconds ). if ( isset( $user_country ) && $user_country ) { set_transient( $transient_name, $user_country, $cache_expires ); // set it to expire in 1800 seconds = 30 min. } } } return $user_country; }

The last function grabs the IP from the current visitor.

/** * Get the user IP. * * @return string The user IP */ function wpsl_get_user_ip() { $ip = ''; $headers = array( 'HTTP_CLIENT_IP', 'HTTP_X_FORWARDED_FOR', 'REMOTE_ADDR' ); foreach ( $headers as $header ) { if ( isset( $_SERVER[$header] ) && $_SERVER[$header] ) { $ip = $_SERVER[$header]; if ( $ip ) { break; } } } // HTTP_X_FORWARDED_FOR can return a list of IP's instead of a single one. $ip_array = array_map( 'trim', explode( ',', $ip ) ); return $ip_array[0]; }

A more detailed explanation how this works is described in this article.

Changelog

Since 2.2.8

Source File

This filter is located in /frontend/class-frontend.php

Placement

The code needs to be placed in the functions.php file inside your active theme folder.