woocommerce-square
Last commit date
build
21 hours ago
i18n
21 hours ago
includes
21 hours ago
templates
1 year ago
vendor
21 hours ago
apple-developer-merchantid-domain-association
2 years ago
changelog.txt
21 hours ago
license.txt
3 years ago
readme.txt
21 hours ago
woocommerce-square.php
21 hours ago
readme.txt
259 lines
| 1 | === WooCommerce Square === |
| 2 | Contributors: woocommerce, automattic |
| 3 | Tags: credit card, square, woocommerce, inventory sync |
| 4 | Requires at least: 6.9 |
| 5 | Tested up to: 7.0 |
| 6 | Requires PHP: 7.4 |
| 7 | Stable tag: 5.4.2 |
| 8 | License: GPL-3.0-or-later |
| 9 | License URI: https://www.gnu.org/licenses/gpl-3.0.html |
| 10 | |
| 11 | Securely accept payments, synchronize sales, and seamlessly manage inventory and product data between WooCommerce and Square POS. |
| 12 | |
| 13 | == Description == |
| 14 | |
| 15 | This plugin allows you to securely accept payments, synchronize sales, and seamlessly manage inventory and product data between WooCommerce and Square POS. |
| 16 | |
| 17 | The Square plugin is PCI and SAQ A-level compliant. |
| 18 | |
| 19 | = Accept payments anywhere, anytime = |
| 20 | |
| 21 | - The Square plugin extends WooCommerce to allow you to accept payments via Square - including support for [Apple Pay®](https://www.apple.com/apple-pay/), [Google Pay](https://www.google.com/payments/solutions/), [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/) and [WooCommerce Pre-Orders](https://woocommerce.com/products/woocommerce-pre-orders/). |
| 22 | - Recurring customers can save payment methods and use them at checkout. |
| 23 | - Customize payment forms with automatic formatting, mobile-friendly options, and retina card icons. |
| 24 | |
| 25 | = Manage your business all in one place = |
| 26 | |
| 27 | Sync your product and inventory information from WooCommerce to Square, or from Square to WooCommerce — set everything up once, and whenever you make a sale, your inventory automatically updates on both platforms. |
| 28 | |
| 29 | - If you sell mainly online, set WooCommerce as your system of record so WooCommerce pushes product name, inventory, prices, categories, and images to Square. |
| 30 | - If you sell in multiple locations and online, set Square as your system of record so Square pushes product name, inventory, prices, categories, and images to WooCommerce. |
| 31 | |
| 32 | == Installation == |
| 33 | |
| 34 | You can download an [older version of this gateway for older versions of WooCommerce from here](https://wordpress.org/plugins/woocommerce-square/developers/). |
| 35 | |
| 36 | = Automatic installation = |
| 37 | |
| 38 | Automatic installation is the easiest option as WordPress handles the file transfers itself and you don’t need to leave your web browser. To |
| 39 | automatically install WooCommerce Square, log in to your WordPress dashboard, navigate to the Plugins menu, and click **Add New**. |
| 40 | |
| 41 | In the search field type "WooCommerce Square" and click **Search Plugins**. Once you've found our plugin you can install it by clicking **Install Now**, as well as view details about it such as the point release, rating, and description. |
| 42 | |
| 43 | = Manual installation = |
| 44 | |
| 45 | The manual installation method involves downloading our plugin and uploading it to your web server via your favorite FTP application. The WordPress codex contains [instructions on how to do this here](http://codex.wordpress.org/Managing_Plugins#Manual_Plugin_Installation). |
| 46 | |
| 47 | = Updating = |
| 48 | |
| 49 | Automatic updates should work like a charm; as always though, ensure you backup your site just in case. |
| 50 | |
| 51 | = Note = |
| 52 | If running PHP 8.2+, you may see some deprecation notices being logged. These notices are known and do not impact any plugin functionality. |
| 53 | |
| 54 | == Frequently Asked Questions == |
| 55 | |
| 56 | = Does this require an SSL certificate? = |
| 57 | |
| 58 | Yes! An SSL certificate must be installed on your site to use Square. |
| 59 | |
| 60 | = Where can I find documentation? = |
| 61 | |
| 62 | For help setting up and configuring the plugin, please refer to our [user guide](https://woo.com/document/woocommerce-square/). |
| 63 | |
| 64 | = Where can I get support or talk to other users? = |
| 65 | |
| 66 | If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.org/support/plugin/woocommerce-square/). |
| 67 | |
| 68 | == Screenshots == |
| 69 | |
| 70 | 1. The main plugin settings. |
| 71 | 2. The payment gateway settings. |
| 72 | |
| 73 | == Changelog == |
| 74 | |
| 75 | = 5.4.2 - 2026-07-22 = |
| 76 | * Update - Remove deprecated beta Product Editor (`@woocommerce/product-editor`) integration. |
| 77 | * Fix - Remove obsolete pre-7.6 WooCommerce compatibility code, as the minimum supported WooCommerce version is now 10.7. |
| 78 | * Dev - Bump WooCommerce "tested up to" version 11.0. |
| 79 | * Dev - Bump WooCommerce minimum supported version to 10.8. |
| 80 | * Dev - Bump WordPress minimum supported version to 6.9. |
| 81 | |
| 82 | = 5.4.1 - 2026-06-24 = |
| 83 | * Fix - Syncing new products to Square no longer leaves them at zero inventory if the sync fails partway through. |
| 84 | * Dev - Bump WooCommerce "tested up to" version 10.9. |
| 85 | * Dev - Bump WooCommerce minimum supported version to 10.7. |
| 86 | |
| 87 | = 5.4.0 - 2026-05-28 = |
| 88 | * Add - Register seven read-only abilities with the WordPress Abilities API, gated behind the woocommerce_square_abilities_enabled filter (default off) and the WC 10.9 loader. |
| 89 | * Fix - Correct button alignment in the Import Products modal on WP 7.0. |
| 90 | * Fix - Allow extending the "Pay for Order" functionality via the WordPress capability system. |
| 91 | * Fix - Square product syncs no longer fail entirely when one item has an outdated catalog ID. |
| 92 | * Fix - Product categories are updated properly during manual sync. |
| 93 | * Fix - Ensure stale category mappings are fully cleaned up when two WooCommerce categories share the same Square category ID. |
| 94 | * Dev - Removed stale Action Scheduler DELETE hook from Plugin.php. |
| 95 | * Dev - Bump WooCommerce "tested up to" version 10.8. |
| 96 | * Dev - Bump WooCommerce minimum supported version to 10.6. |
| 97 | |
| 98 | = 5.3.3 - 2026-05-07 = |
| 99 | * Add - Admin notice to inform merchants if a successful product sync has not occurred in a while. |
| 100 | * Fix - Add SKU-based existence check before creating new Square catalog items to prevent duplicates. |
| 101 | * Fix - Skip SKU-based product matching for Square variations with no SKU to prevent unrelated WooCommerce products from being overwritten during sync. |
| 102 | * Fix - Push inventory now attempts SKU-based lookup for synced products missing a Square variation ID. |
| 103 | * Fix - Syncs no longer crash when encountering certain malformed items in your Square catalog. |
| 104 | * Fix - Add safeguard to skip disabling cards on Square when removing tokens from staging/non-production sites. |
| 105 | * Fix - Ensure the debug mode admin notice link points to the correct settings page. |
| 106 | * Dev - Bump WooCommerce "tested up to" version 10.7. |
| 107 | * Dev - Bump WooCommerce minimum supported version to 10.5. |
| 108 | |
| 109 | = 5.3.2 - 2026-04-06 = |
| 110 | * Fix - Prevent stale Square catalog IDs from breaking checkout while still surfacing genuine coupon redemption failures as checkout errors. |
| 111 | * Fix - Ensure that the order note wordings for partial payments are translatable. |
| 112 | * Dev - Replace deprecated `wc_enqueue_js` with `wp_add_inline_script`. |
| 113 | * Dev - Bump WordPress "Tested up to" to 7.0. |
| 114 | * Dev - Bump WordPress minimum supported to 6.8. |
| 115 | * Dev - Bump WooCommerce minimum supported version to 10.4. |
| 116 | |
| 117 | = 5.3.1 - 2026-03-26 = |
| 118 | * Fix - Improved reliability when customers change or remove an applied gift card at checkout. |
| 119 | * Fix - Improved authorization handling for order-related requests in the payment flow. |
| 120 | * Dev - Bump WooCommerce "tested up to" version 10.6. |
| 121 | |
| 122 | = 5.3.0 - 2026-03-05 = |
| 123 | * Add - Initial support for Square Discount Codes (Coupons). |
| 124 | * Fix - Set the "Synced with Square" taxonomy to private. |
| 125 | * Fix - Ensure that there is no `DivisionByZeroError` fatal error in Square when the total amount is zero and the tax amount is non-zero. |
| 126 | * Fix - Partial-Total Verification when Gift Card is used. |
| 127 | * Fix - Improved data access restrictions on payment method page. |
| 128 | * Dev - Bump WooCommerce "tested up to" version 10.5. |
| 129 | * Dev - Bump WooCommerce minimum supported version to 10.3. |
| 130 | |
| 131 | = 5.2.0 - 2026-01-15 = |
| 132 | * Add - A notice for the inventory sync in bulk edit screen. |
| 133 | * Add - Helper text and notices to clarify the difference between "Sync Now" and "Import all Products from Square". |
| 134 | * Fix - Ensure that the order is not marked as 'On Hold' when saving the card fails after a successful payment. |
| 135 | * Fix - Prevent fatal errors occurring on incompatible environments. |
| 136 | * Fix - Ensure default titles are displayed for payment methods if not set by the merchant. |
| 137 | * Fix - Prevent images being updated from square when the "Enable to override Product images from Square" setting is turned off. |
| 138 | * Fix - Improve sync settings language for better clarity. |
| 139 | * Fix - CSV-imported products from Square with inventory tracking disabled are now correctly imported as "In Stock" instead of "Out of Stock" with stock management enabled. |
| 140 | * Fix - Resolve fatal errors that may occur after a server migration. |
| 141 | * Dev - Update `apimatic/unirest-php` package to 4.0.7. |
| 142 | * Dev - Bump WooCommerce minimum supported version to 10.2. |
| 143 | * Dev - Bump WordPress minimum supported version to 6.7. |
| 144 | * Dev - Error logging when gift card application fails due to missing session token or Square API errors. |
| 145 | * Dev - Remove application of E2E status labels from GitHub actions. |
| 146 | |
| 147 | = 5.1.2 - 2025-12-10 = |
| 148 | * Security - Resolve CVE-2025-13457. |
| 149 | * Dev - Bump WooCommerce "tested up to" version 10.4. |
| 150 | * Dev - Bump WordPress "tested up to" version 6.9. |
| 151 | |
| 152 | = 5.1.1 - 2025-11-03 = |
| 153 | * Fix - Missing attribute names after Product Import. |
| 154 | * Fix - Update for PHP 8.4 compatibility. |
| 155 | * Dev - Bump WooCommerce "tested up to" version 10.3. |
| 156 | * Dev - Bump WooCommerce minimum supported version to 10.1. |
| 157 | * Dev - Updates to our QIT GitHub Action workflow. |
| 158 | * Dev - Add new deploy workflow. |
| 159 | |
| 160 | = 5.1.0 - 2025-09-29 = |
| 161 | * Add - Support for multiple categories in WooCommerce-Square product synchronization. |
| 162 | * Add - Improve debugging with more options and verbose descriptions. |
| 163 | * Fix - Sync only the utilized option values. |
| 164 | * Fix - Fatal error when using partial product quantities. |
| 165 | * Fix - Ensure the outline is properly visible when the Google Pay button is focused. |
| 166 | * Fix - Ensure users are warned that clicking “Buy with GPay” opens in a new window. |
| 167 | * Dev - Bump WooCommerce "tested up to" version 10.2. |
| 168 | * Dev - Bump WooCommerce minimum supported version to 10.0. |
| 169 | |
| 170 | = 5.0.1 - 2025-12-10 = |
| 171 | * Security - Resolve CVE-2025-13457 for version 5.0. |
| 172 | |
| 173 | = 5.0.0 - 2025-09-10 = |
| 174 | * Add - Order fulfillment sync between WooCommerce and Square orders for those that opt-in. |
| 175 | * Fix - Ensure inventory sync isn’t interrupted in case of a category insert failure. |
| 176 | * Fix - Accurately count attribute values – 250 values, not characters. |
| 177 | |
| 178 | = 4.9.9 - 2025-12-10 = |
| 179 | * Security - Resolve CVE-2025-13457 for version 4.9. |
| 180 | |
| 181 | = 4.9.8 - 2025-08-21 = |
| 182 | * Fix - Ensure there is no fatal error on the product page when the product price is blank. |
| 183 | * Fix - Corrected variation option assignment logic to prevent mismatched item option IDs during manual syncs to Square. |
| 184 | * Fix - Prevent mixing Production tokens when in Sandbox mode. |
| 185 | * Fix - Vertical spacing on "Enable Payment Methods" step. |
| 186 | * Dev - Bump WooCommerce "tested up to" version 10.1. |
| 187 | * Dev - Bump WooCommerce minimum supported version to 9.9. |
| 188 | * Dev - Bump WordPress minimum supported version to 6.7. |
| 189 | * Dev - Update vulnerable NPM packages. |
| 190 | * Dev - Remove loading translations, as it is automatically handled by WordPress since version 4.6. |
| 191 | |
| 192 | = 4.9.7 - 2025-07-28 = |
| 193 | * Fix - Resolve `CARD_DECLINED_VERIFICATION_REQUIRED` error for 3DS-required credit card payments. |
| 194 | * Fix - Unblock UI and show a generic error when buyer verification fails. |
| 195 | * Dev - Update NPM packages with security issues. |
| 196 | |
| 197 | = 4.9.6 - 2025-07-10 = |
| 198 | * Add - When importing products from Square, a new "View Progress" link on the "Update" page allows ability to more closely monitor that progress. |
| 199 | * Fix - Ensure that Digital Wallet payment methods and Cash App Pay function properly in Block Checkout when using Safari. |
| 200 | * Fix - Prevent the "Sync with Square" setting from getting unchecked. |
| 201 | |
| 202 | = 4.9.5 - 2025-06-30 = |
| 203 | * Fix - Ensure the customer is created on the Square side without errors when adding a payment method. |
| 204 | * Fix - Ensure that the request body is correctly logged in the debug logs. |
| 205 | * Dev - Bump WooCommerce "tested up to" version 10.0. |
| 206 | * Dev - Bump WooCommerce minimum supported version to 9.8. |
| 207 | |
| 208 | = 4.9.4 - 2025-06-13 = |
| 209 | * Fix - Ensure no fatal error occurs at checkout when using a free local pickup shipping method. |
| 210 | |
| 211 | = 4.9.3 - 2025-06-09 = |
| 212 | * Add - Support for Square's EMV 3-D Secure authentication flow to comply with countries that have 3DS mandates and improve payment security. |
| 213 | * Add - Pre-sync validations for Product Variations. |
| 214 | * Add - Digit handling for country-specific currencies to prevent incorrect division by 100 for currencies like Japanese Yen. |
| 215 | * Add - Indicate customer initiated payments in Square API requests. |
| 216 | * Fix - Only sync attributes used for variations to Square, preventing item option mismatch errors when WooCommerce products have unused attributes. |
| 217 | * Fix - Ensure consistent error messages between the Block Checkout and the Shortcode Checkout. |
| 218 | * Dev - Bump Square PHP SDK version from `35.1.0.20240320` to `40.0.0.20250123`. |
| 219 | |
| 220 | = 4.9.2 - 2025-05-27 = |
| 221 | * Dev - Bump WooCommerce "tested up to" version 9.9. |
| 222 | * Dev - Bump WooCommerce minimum supported version to 9.7. |
| 223 | |
| 224 | = 4.9.1 - 2025-05-05 = |
| 225 | * Add - Set the onboarding URL for the "Complete setup" button on the new payment settings page. |
| 226 | * Change - Remove the `wc_square_update_product_set_variation_name` filter. |
| 227 | * Fix - Issue with Product Price override update logic. |
| 228 | * Fix - Show detailed error messages on Checkout Page based on Debug Mode settings. |
| 229 | * Fix - Ensure that debug logs for payment gateways are being generated as expected. |
| 230 | * Dev - Add in performance logging during the checkout process. |
| 231 | * Dev - Update E2E tests to accommodate payment modernization changes in WooCommerce Core. |
| 232 | |
| 233 | = 4.9.0 - 2025-04-07 = |
| 234 | * Add - Support for syncing multiple Product Variations. |
| 235 | * Add - Support for WooCommerce's new Email Improvements feature. |
| 236 | * Fix - Digital Wallets and Cash App payment issues in Woo 9.8. |
| 237 | * Fix - Deprecated PHP error for Gift Cards. |
| 238 | * Fix - jQuery error on Cart & Checkout pages when a Subscription product is added to the cart, as Digital Wallets cannot be used for Subscription products. |
| 239 | * Fix - Remove duplicate onboarding notice. |
| 240 | * Dev - Bump WooCommerce "tested up to" version 9.8. |
| 241 | * Dev - Bump WooCommerce minimum supported version to 9.6. |
| 242 | * Dev - Bump WordPress minimum supported version to 6.6. |
| 243 | * Dev - Bump WordPress "tested up to" version 6.8. |
| 244 | * Dev - Updates to E2E tests setup. |
| 245 | * Dev - Update all third-party actions our workflows rely on to use versions based on specific commit hashes. |
| 246 | |
| 247 | [View historical changelog details here](https://github.com/woocommerce/woocommerce-square/blob/trunk/changelog.txt). |
| 248 | |
| 249 | == Upgrade Notice == |
| 250 | |
| 251 | = 5.1.2 = |
| 252 | Security release affecting versions 4.2 upward, please update promptly. Minor releases are available on wordpress.org. |
| 253 | |
| 254 | = 3.5.0 = |
| 255 | * Note that this version bumps the minimum PHP version from 7.2 to 7.4. |
| 256 | |
| 257 | = 1.0.25 = |
| 258 | * Public Release! |
| 259 |