geocoder.api.php in Geocoder 8.3

API documentation for Geocoder module.

File

geocoder.api.php

<?php

/**
 * @file
 * API documentation for Geocoder module.
 */

/**
 * Alter the Address String to Geocode.
 *
 * Allow others modules to adjust the address string.
 *
 * @param string $address_string
 *   The address string to geocode.
 * */
function hook_geocode_address_string_alter(string &$address_string) {

  // Make custom alterations to adjust the address string.
}

/**
 * Alter the Coordinates to Reverse Geocode.
 *
 * Allow others modules to adjust the Coordinates to Reverse Geocode.
 *
 * @param string $latitude
 *   The latitude.
 * @param string $longitude
 *   The longitude.
 * */
function hook_reverse_geocode_coordinates_alter(string &$latitude, string &$longitude) {

  // Make custom alterations to the Coordinates to Reverse Geocode.
}

/**
 * Alter the Country Code in setting the Address field from Geojson.
 *
 * @param string $country_code
 *   The country code.
 * @param array $geojson_array
 *   The geojson array.
 *
 * @see DumperPluginManager->setCountryFromGeojson
 * */
function hook_geocode_country_code_alter(string &$country_code, array $geojson_array) {

  // Make custom alterations to the Country Code.
}

Functions

Name	Description
hook_geocode_address_string_alter	Alter the Address String to Geocode.
hook_geocode_country_code_alter	Alter the Country Code in setting the Address field from Geojson.
hook_reverse_geocode_coordinates_alter	Alter the Coordinates to Reverse Geocode.