{"id":98585,"date":"2019-02-24T21:15:38","date_gmt":"2019-02-24T21:15:38","guid":{"rendered":"https:\/\/wordpress.org\/plugins\/gazchaps-woocommerce-getaddress-io-plugin\/"},"modified":"2025-12-02T13:47:37","modified_gmt":"2025-12-02T13:47:37","slug":"gazchaps-woocommerce-getaddress-io","status":"closed","type":"plugin","link":"https:\/\/oci.wordpress.org\/plugins\/gazchaps-woocommerce-getaddress-io\/","author":15973480,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","version":"3.2.4","stable_tag":"3.2.4","tested":"6.7.5","requires":"4.8.0","requires_php":"5.6","requires_plugins":null,"header_name":"GazChap's WooCommerce getAddress.io Postcode Lookup","header_author":"Gareth 'GazChap' Griffiths","header_description":"Adds a UK postcode address lookup tool to the WooCommerce checkout process.","assets_banners_color":"","last_updated":"2025-12-02 13:47:37","external_support_url":"","external_repository_url":"","donate_link":"https:\/\/ko-fi.com\/gazchap","header_plugin_uri":"https:\/\/www.gazchap.com\/posts\/woocommerce-getaddress-io","header_author_uri":"https:\/\/www.gazchap.com","rating":5,"author_block_rating":0,"active_installs":100,"downloads":8933,"num_ratings":16,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","changelog"],"tags":{"2.3":{"tag":"2.3","author":"gazchap","date":"2023-10-08 15:42:09"},"3.0":{"tag":"3.0","author":"gazchap","date":"2023-10-08 15:43:02"},"3.1":{"tag":"3.1","author":"gazchap","date":"2023-10-19 11:03:44"},"3.2":{"tag":"3.2","author":"gazchap","date":"2023-10-26 07:52:47"},"3.2.1":{"tag":"3.2.1","author":"gazchap","date":"2024-08-12 11:50:10"},"3.2.2":{"tag":"3.2.2","author":"gazchap","date":"2024-09-04 10:01:45"},"3.2.3":{"tag":"3.2.3","author":"gazchap","date":"2025-01-10 17:03:05"},"3.2.4":{"tag":"3.2.4","author":"gazchap","date":"2025-12-02 13:47:37"}},"upgrade_notice":[],"ratings":{"1":0,"2":0,"3":0,"4":0,"5":16},"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":2038423,"resolution":"128x128","location":"assets","locale":""},"icon-256x256.png":{"filename":"icon-256x256.png","revision":2038423,"resolution":"256x256","location":"assets","locale":""}},"assets_banners":[],"assets_blueprints":{},"all_blocks":[],"tagged_versions":["2.3","3.0","3.1","3.2","3.2.1","3.2.2","3.2.3","3.2.4"],"block_files":[],"assets_screenshots":{"screenshot-1.png":{"filename":"screenshot-1.png","revision":2038423,"resolution":"1","location":"assets","locale":""},"screenshot-2.png":{"filename":"screenshot-2.png","revision":2038423,"resolution":"2","location":"assets","locale":""},"screenshot-3.png":{"filename":"screenshot-3.png","revision":2545163,"resolution":"3","location":"assets","locale":""},"screenshot-4.png":{"filename":"screenshot-4.png","revision":2545163,"resolution":"4","location":"assets","locale":""}},"screenshots":{"1":"The Find Address button on the default Storefront theme, before the lookup has been completed","2":"The address selection drop-down menu on display","3":"The administrator settings in the WooCommerce administration dashboard","4":"The address lookup feature within the WooCommerce add\/edit order screen"},"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[168404,282,168405,168406,286],"plugin_category":[45],"plugin_contributors":[153410],"plugin_business_model":[],"class_list":["post-98585","plugin","type-plugin","status-closed","hentry","plugin_tags-address-lookup","plugin_tags-ecommerce","plugin_tags-postcode-lookup","plugin_tags-uk-address-lookup","plugin_tags-woocommerce","plugin_category-ecommerce","plugin_contributors-gazchap","plugin_committers-gazchap"],"banners":[],"icons":{"svg":false,"icon":"https:\/\/s.w.org\/plugins\/geopattern-icon\/gazchaps-woocommerce-getaddress-io.svg","icon_2x":false,"generated":true},"screenshots":[{"src":"https:\/\/ps.w.org\/gazchaps-woocommerce-getaddress-io\/assets\/screenshot-1.png?rev=2038423","caption":"The Find Address button on the default Storefront theme, before the lookup has been completed"},{"src":"https:\/\/ps.w.org\/gazchaps-woocommerce-getaddress-io\/assets\/screenshot-2.png?rev=2038423","caption":"The address selection drop-down menu on display"},{"src":"https:\/\/ps.w.org\/gazchaps-woocommerce-getaddress-io\/assets\/screenshot-3.png?rev=2545163","caption":"The administrator settings in the WooCommerce administration dashboard"},{"src":"https:\/\/ps.w.org\/gazchaps-woocommerce-getaddress-io\/assets\/screenshot-4.png?rev=2545163","caption":"The address lookup feature within the WooCommerce add\/edit order screen"}],"raw_content":"<!--section=description-->\n<p>This plugin enables your customers to complete their billing\/shipping addresses by entering their postcode and selecting their address from the options given.<\/p>\n\n<p>It utilises getAddress.io (https:\/\/getaddress.io) to do the lookup using their Royal Mail Postcode Address File.<\/p>\n\n<p>An API key is required for the integration to work, and the integration only appears when the customer has selected United Kingdom (or, more specifically, the ISO-3166-2 code \"GB\") for their country.<\/p>\n\n<p>It can optionally be turned off for the shipping or billing addresses, and can be enabled or disabled in each of the checkout, customer account and WooCommerce admin screens.<\/p>\n\n<p>Postcodes that are looked up are saved in a custom database table for 24 hours to help reduce your costs for use of the getAddress.io API.<\/p>\n\n<h3>IMPORTANT NOTE<\/h3>\n\n<p>With the update to v3.2.4, I have had to make the difficult decision to discontinue this plugin.<\/p>\n\n<p>There are legal and ethical concerns regarding the source of the data used by the getAddress.io API, and consequently to protect myself and my users, I have little choice but to discontinue the plugin development.<\/p>\n\n<p>After the plugin update (or a new installation) the plugin will remain active for 30 days and then the lookup facilities will no longer be available, at which point you should deactivate and uninstall the plugin. A notice will be displayed in the admin panel informing you of this, showing the date that your lookup will cease to function.<\/p>\n\n<p>I am unable to field queries regarding possible alternative providers or plugins, but WooCommerce have recently added a native Address Lookup system into version 10.3 of WooCommerce which should rapidly become popular and gain the support of most postcode lookup services.<\/p>\n\n<p>For more information: https:\/\/blog.ideal-postcodes.co.uk\/ideal-postcodes-wins-high-court-ruling<\/p>\n\n<h3>Requirements<\/h3>\n\n<p><a href=\"https:\/\/woocommerce.com\">WooCommerce<\/a>, at least version 3.0.\n<a href=\"https:\/\/getaddress.io\">getAddress.io API Key<\/a>. A number of pricing plans are available.<\/p>\n\n<p><strong>Note:<\/strong> Currently, this plugin does NOT support WooCommerce Checkout Blocks introduced as the default checkout experience in WooCommerce version 8.3, it can only be used with the WooCommerce checkout shortcode. I aim to make this plugin compatible with Checkout Blocks as soon as possible.<\/p>\n\n<h3>Usage<\/h3>\n\n<p>Once installed and activated, you need to go to the WooCommerce -&gt; Settings -&gt; General page in the WordPress dashboard. You can enter your API key and set your other options here.<\/p>\n\n<h3>Conflicts with other plugins<\/h3>\n\n<p>Certain plugins that also modify checkout fields can conflict with this plugin and prevent it from working.<\/p>\n\n<p>Usually, the symptom of this is that the \"Find Address\" button does not appear.<\/p>\n\n<p>Since version 2.1, I've added a Hook Priority setting at the bottom of the settings for the plugin that you can use to try and fix these conflicts.<\/p>\n\n<p>The default priority is 10, but using a higher number makes my plugin modify the checkout later in the process - you will probably need to experiment to find the priority that makes my plugin's changes happen after the conflicting plugin.<\/p>\n\n<p>For example, a priority of 1001 seems to fix conflicts with the \"Checkout Field Editor\" plugin by ThemeHigh.<\/p>\n\n<h3>Filter Reference<\/h3>\n\n<p>For developers, I've included a few filters that you can use to customise certain aspects of the plugin. These are:<\/p>\n\n<h4>User Interface<\/h4>\n\n<p>All of these filters take one argument, <code>$text<\/code>.<\/p>\n\n<pre><code>gazchaps-woocommerce-getaddress-io_find-address-button-text - the text shown on the Find Address buttons (default: Find Address)\ngazchaps-woocommerce-getaddress-io_find-address-searching-text - the text shown when the Find Address button is selected (default: Searching...)\ngazchaps-woocommerce-getaddress-io_enter-address-manually-text - the text shown for the \"Enter an address manually\" link (default: Enter an address manually)\n<\/code><\/pre>\n\n<p>Note: Although these two texts are translatable, filters will override any translations.<\/p>\n\n<h4>Error Messages<\/h4>\n\n<p>All of these filters take one argument, <code>$message<\/code>, the error message that will be displayed to the user.<\/p>\n\n<pre><code>gazchaps-woocommerce-getaddress-io_api_error_400 - shown when the postcode supplied is invalid\/empty\ngazchaps-woocommerce-getaddress-io_api_error_401 - shown when the API key provided in the settings is invalid\ngazchaps-woocommerce-getaddress-io_api_error_404 - shown when no addresses were found for the supplied postcode\ngazchaps-woocommerce-getaddress-io_api_error_429 - shown when the API key has hit its usage limit\ngazchaps-woocommerce-getaddress-io_api_error_500 - shown when there is a server error at getAddress.io\n<\/code><\/pre>\n\n<p>Note: By default, the error messages are \"customer friendly\", i.e. they don't go into much detail about the cause of the error!<\/p>\n\n<h4>Styling<\/h4>\n\n<pre><code>gazchaps-woocommerce-getaddress-io_billing_selector_row_class - changes the CSS class on the form-row that the billing address selector is placed into\ngazchaps-woocommerce-getaddress-io_shipping_selector_row_class - changes the CSS class on the form-row that the shipping address selector is placed into\ngazchaps-woocommerce-getaddress-io_clear_additional_fields - defaults to true, set to '__return_false' to stop the \"additional fields\" area of the checkout having a clear style applied to it&lt;h3&gt;License&lt;\/h3&gt;Licensed under the [GNU General Public License v2.0](http:\/\/www.gnu.org\/licenses\/gpl-2.0.html)\n<\/code><\/pre>\n\n<!--section=installation-->\n<p>Install via the WordPress Plugin Directory, or download a release from this repository and install as you would a normal WordPress plugin.<\/p>\n\n<!--section=changelog-->\n<h4>3.2.4 (05\/11\/2025)<\/h4>\n\n<ul>\n<li>Added cutoff timer to disable lookup facilities in 30 days as a result of legal concerns surrounding getAddress.io and their API.<\/li>\n<\/ul>\n\n<h4>3.2.3 (10\/10\/2024)<\/h4>\n\n<ul>\n<li>Bugfix - fixed another issue with WP_Errors. Thanks again to jhmaths for the report.<\/li>\n<\/ul>\n\n<h4>3.2.2 (04\/09\/2024)<\/h4>\n\n<ul>\n<li>Bugfix - fixed a PHP warning being generated when a lookup fails with a WP_Error. Thanks to jhmaths for the report.<\/li>\n<\/ul>\n\n<h4>3.2.1 (16\/04\/2024)<\/h4>\n\n<ul>\n<li>Bugfix - fixed a PHP warning being generated when errors occurred. Thanks to connectisl for the report.<\/li>\n<\/ul>\n\n<h4>3.2 (26\/10\/2023)<\/h4>\n\n<ul>\n<li>Bugfix - fixed some PHP warnings being generated by the new database class. Thanks to donlee101 for the report.<\/li>\n<\/ul>\n\n<h4>3.1 (19\/10\/2023)<\/h4>\n\n<ul>\n<li>Bugfix - changing country to a non-UK country after performing a postcode lookup now hides the 'Select address' menu. Thanks to Conor for the report.<\/li>\n<\/ul>\n\n<h4>3.0 (08\/10\/2023)<\/h4>\n\n<ul>\n<li>Rewritten to support the new getAddress.io API -- the API used previously is no longer available to new getAddress.io customers.<\/li>\n<li>Added custom database table to cache postcode results across visitors. Results are cached for 1 day before being purged in a daily cron job.<\/li>\n<li>Moved settings to their own section (at the top) in the WooCommerce -&gt; Settings -&gt; General tab.<\/li>\n<li>Removed ability to send an over-usage email, as getAddress.io now does this natively.<\/li>\n<li>Removed notes about test postcodes from readme and settings screen, they're no longer supported.<\/li>\n<\/ul>\n\n<h4>2.3 (14\/06\/2023)<\/h4>\n\n<ul>\n<li>Declared compatibility with WooCommerce High Performance Order Storage -- thanks benatherton for the information.<\/li>\n<\/ul>\n\n<h4>2.2 (10\/02\/2022)<\/h4>\n\n<ul>\n<li>Stopped using  elements to output the Find Address buttons, as this was causing issues with some other checkout-modification plugins like Fluid Checkout.<\/li>\n<li>Updated event listeners for the Find Address and Enter Address Manually elements so that they work if those elements are first added to the page after load.<\/li>\n<\/ul>\n\n<h4>2.1 (09\/12\/2021)<\/h4>\n\n<ul>\n<li>Added a Hook Priority setting that can be used to try and correct conflicts caused by plugins like Checkout Field Editor Pro. Increase the priority until the lookup button comes back.<\/li>\n<\/ul>\n\n<h4>2.0.4 (15\/07\/2021)<\/h4>\n\n<ul>\n<li>Fixed an issue with the Enter\/Return key (or equivalent on mobile) submitting the entire checkout form instead of triggering the postcode lookup. Thanks to donlee101 for the report.<\/li>\n<\/ul>\n\n<h4>2.0.3 (10\/06\/2021)<\/h4>\n\n<ul>\n<li>Fixed a bug with the new hide address fields option not functioning correctly when GB is the only country available to select. Thanks again to prodograw.<\/li>\n<\/ul>\n\n<h4>2.0.2 (10\/06\/2021)<\/h4>\n\n<ul>\n<li>Removed reliance on certain CSS classes in the checkout, as some themes apparently don't use them. Thanks to prodograw for the report.<\/li>\n<li>Fixed a bug that would stop the \"tidy postcode\" routine running when looking up a postcode currently in the cache<\/li>\n<li>Removed some duplicate JS that had crept in<\/li>\n<\/ul>\n\n<h4>2.0.1 (09\/06\/2021)<\/h4>\n\n<ul>\n<li>Somehow the push I did to the WordPress plugin repo missed some files - hopefully this will fix it...<\/li>\n<\/ul>\n\n<h4>2.0 (09\/06\/2021)<\/h4>\n\n<ul>\n<li>Added postcode lookup to the WooCommerce admin when creating and editing orders<\/li>\n<li>Added option (disabled by default) to hide the address input fields until an address has been selected<\/li>\n<li>Added option to show an \"Enter address manually\" button for use in conjunction with the above \"hide address fields\" option<\/li>\n<li>Added new filter for changing the \"Enter address manually\" text<\/li>\n<li>Added link to getaddress.io in plugin settings<\/li>\n<li>Updated donation link to Ko-Fi instead of PayPal<\/li>\n<\/ul>\n\n<h4>1.5.1 (27\/08\/2020)<\/h4>\n\n<ul>\n<li>Fix layout issue seemingly introduced by the WooCommerce 4.4 update, that pushed the \"Find Address\" button on to the next row.<\/li>\n<\/ul>\n\n<h4>1.5 (14\/08\/2020)<\/h4>\n\n<ul>\n<li>The address results selector now works properly in the Account pages on the front-end. Thanks to Ben Wheeler for some additional assistance here.<\/li>\n<li>Added an additional \"Searching...\" state when the button is clicked for better user experience<\/li>\n<li>Added settings in WC admin panel to change the text shown on the Find Address button, and the text shown in the new \"Searching...\" state<\/li>\n<li>Added filters for the above texts for developer control<\/li>\n<li>The JavaScript file is now only enqueued when on the checkout or account pages, which should speed up performance of other pages.<\/li>\n<\/ul>\n\n<h4>1.4 (12\/06\/2020)<\/h4>\n\n<ul>\n<li>Uses the postcode returned by getAddress.io to \"tidy up\" the postcode field after the lookup is completed. Thanks to bootle for the suggestion.<\/li>\n<\/ul>\n\n<h4>1.3 (06\/05\/2020)<\/h4>\n\n<ul>\n<li>Updated JS to trigger WooCommerce's order update Ajax request when an address is selected. Thanks to rfvdan for the report.<\/li>\n<\/ul>\n\n<h4>1.2 (02\/05\/2019)<\/h4>\n\n<ul>\n<li>Fixed a bug that caused the JavaScript to stop running prematurely if a particular address field was not present on the checkout page. Thanks to Max Devlin for the report.<\/li>\n<\/ul>\n\n<h4>1.1 (25\/02\/2019)<\/h4>\n\n<ul>\n<li>Added a caching mechanism to prevent repeated lookups for the same postcode in the same browser session, thus saving API usage<\/li>\n<\/ul>\n\n<h4>1.0 (24\/02\/2019)<\/h4>\n\n<ul>\n<li>Initial release.<\/li>\n<\/ul>","raw_excerpt":"Adds a UK postcode lookup tool into WooCommerce&#039;s checkout process.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/98585","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=98585"}],"author":[{"embeddable":true,"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/gazchap"}],"wp:attachment":[{"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=98585"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=98585"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=98585"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=98585"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=98585"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/oci.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=98585"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}