, (*1)
Description
This plugin adds a support for the geo_query part of the WP_Query and WP_User_Query., (*2)
Supports geo data stored in post/user meta or in a custom table., (*3)
It uses the Haversine SQL implementation by Ollie Jones (see here)., (*4)
The plugin works on PHP 5.3+., (*5)
It supports the GitHub Updater., (*6)
Activate the plugin and you can use the geo_query parameter in all your WP_Query and WP_User_Query queries., (*7)
Few examples are here below, e.g. for the Rest API., (*8)
Installation
Upload the plugin to the plugin folder and activate it., (*9)
To install dependencies with Composer (not required):, (*10)
composer install
or, (*11)
php composer.phar install
within our folder. See here for more information on how to install Composer., (*12)
Then play with the example below, in your theme or in a plugin., (*13)
Have fun ;-), (*14)
Example - Basic WP_Query usage:
Here's an example of the default input parameters of the geo_query part:, (*15)
$args = [
'post_type' => 'post',
'posts_per_page' => 10,
'ignore_sticky_posts' => true,
'orderby' => [ 'title' => 'DESC' ],
'geo_query' => [
'lat' => 64, // Latitude point
'lng' => -22, // Longitude point
'lat_meta_key' => 'geo_lat', // Meta-key for the latitude data
'lng_meta_key' => 'geo_lng', // Meta-key for the longitude data
'radius' => 150, // Find locations within a given radius (km)
'order' => 'DESC', // Order by distance
'distance_unit' => 111.045, // Default distance unit (km per degree). Use 69.0 for statute miles per degree.
'context' => '\\Birgir\\Geo\\GeoQueryHaversine', // Default implementation, you can use your own here instead.
],
];
$query = new WP_Query( $args );
Example - Rest API usage:
Here's a modified example from @florianweich:, (*16)
add_filter( 'rest_query_vars', function ( $valid_vars ) {
return array_merge( $valid_vars, [ 'geo_location' ] );
} );
add_filter( 'rest_post_query', function( $args, $request ) {
$geo = json_decode( $request->get_param( 'geo_location' ) );
if ( isset( $geo->lat, $geo->lng ) ) {
$args['geo_query'] = [
'lat' => (float) $geo->lat,
'lng' => (float) $geo->lng,
'lat_meta_key' => 'geo_lat',
'lng_meta_key' => 'geo_lng',
'radius' => ($geo->radius) ? (float) $geo->radius : 50,
];
}
return $args;
}, 10, 2 );
Test it with e.g.:, (*17)
https://example.com/wp-json/wp/v2/posts?geo_location={"lat":"64.128288","lng":"-21.827774","radius":"50"}
One can use rest_{custom-post-type-slug}_query filter for a custom post type., (*18)
Example - Basic WP_User_Query usage:
Here's an example from @acobster:, (*19)
$args = [
'role' => 'subscriber',
'geo_query' => [
'lat' => 47.236,
'lng' => -122.435,
'lat_meta_key' => 'geo_lat',
'lng_meta_key' => 'geo_lng',
'radius' => 1,
'context' => '\\Birgir\\Geo\\GeoQueryUserHaversine',
],
];
$query = new WP_User_Query( $args );
$args = array(
'post_type' => 'post',
'posts_per_page' => 10,
'ignore_sticky_posts' => true,
'orderby' => array( 'title' => 'DESC' ),
'geo_query' => array(
'table' => 'custom_table', // Table name for the geo custom table.
'pid_col' => 'pid', // Column name for the post ID data
'lat_col' => 'lat', // Column name for the latitude data
'lng_col' => 'lng', // Column name for the longitude data
'lat' => 64.0, // Latitude point
'lng' => -22.0, // Longitude point
'radius' => 1, // Find locations within a given radius (km)
'order' => 'DESC', // Order by distance
'distance_unit' => 111.045, // Default distance unit (km per degree). Use 69.0 for statute miles per degree.
'context' => '\\Birgir\\Geo\\GeoQueryPostCustomTableHaversine', // Custom table implementation, you can use your own here instead.
),
);
$query = new WP_Query( $args );
Check the unit test method test_custom_table_in_wp_query() as a more detailed example., (*20)
Notes on the parameters:
-
The plugin assumes we store the latitudes and longitudes as custom fields ( post meta), so we need to tell the query about meta keys with the 'lat_meta_key' and 'lng_meta_key' parameters., (*21)
-
Skipping the 'radius' parameter means that no distance filtering will take place., (*22)
-
If we use the 'order' parameter within the 'geo_query', then it will be prepended to the native 'orderby' parameter., (*23)
-
The 'distance_unit' parameter should be 69.0 for distance in statute miles, else 111.045 for distance in kilometers., (*24)
-
If we want to use the optimized Haversine version by Ollie Jones, we use:, (*25)
'context' => '\\Birgir\\Geo\\GeoQueryHaversineOptimized'
Notice that on our current plugin setup (i.e. fetching data from the LONGTEXT post meta fields) this isn't more performant than the default GeoQueryHaversine class., (*26)
A future work could be to use a custom table with indexes, for the optimization to work., (*27)
-
If we create our own implementation of the Haversine formula, for example the GeoQueryCustom class, we just have to make sure it implements the GeoQueryInterface interface:, (*28)
'context' => 'GeoQueryCustom'
Feedback
Any suggestions are welcomed., (*29)
Changelog
0.2.2 (2024-01-05)
- Bump composer/installers to ^2.0.0. Props @wujekbogdan, (*30)
0.2.1 (2023-07-26)
- Fix deprecated notice in PHP 8.1 #24, (*31)
0.2.0 (2020-04-25)
- Support for fetching points from a custom table and doing Haversine formula in WP_Query., (*32)
0.1.1 (2019-01-23)
- Fixed #14. Fixed the user query ordering. Props @baden03, (*33)
0.1.0 (2018-08-06)
- Added support for user queries. Props @acobster
- Fixed Travis issue. Travis runs successfully for PHP 7.2, 7.1,7,5.6 when installed via Composer and also 5.4 when installed without Composer. Skip the 5.4 Composer check for now., (*34)
0.0.7 (2018-06-27)
- Fixed #10. Use ^1.0.0 for composer installer. Props @wujekbogdan, (*35)
0.0.6 (2017-11-16)
- Fixed #6. Support floating point radius. Props @wujekbogdan
- Added integration tests., (*36)
0.0.5 (2017-02-26), (*37)
- Added fallback for those that don't use Composer
- Removed the vendor directory
0.0.4 (2017-02-26), (*38)
- Fixed #4. Props @billzhong .
0.0.3 (2015-04-29), (*39)
- Fixed #2. Fixed a typo. Props @Ben764 and @con322.
0.0.2 (2015-03-10), (*40)
- Added: Support for the GitHub Updater.
- Updated: README.md
- Changed: Use distance_value instead of distance_in_km in SQL, since we can use miles by changing the distance_unit parameter.
0.0.1 - Init, (*41)
Wallogit.com
