Fix Categories were being stripped from products during manual sync. by iamdharmesh · Pull Request #451 · woocommerce/woocommerce-square

iamdharmesh · 2026-01-21T11:04:37Z

All Submissions:

Does your code follow the WooCommerce Sniffs variant of WordPress coding standards?
Have you written new tests for your changes, as applicable?
Have you successfully run tests with your changes locally?
Will this change require new documentation or changes to existing documentation?

Changes proposed in this Pull Request:

In PR #408, we added support for syncing multiple categories. However, we missed adding this support to manual synchronization. This PR fixes an issue in manual and interval synchronization where categories were being stripped from products synced from Square.

Note

While working on this, I noticed that synced categories do not maintain the parent–child relationship during synchronization. I have reported a separate issue to explore implementation options and potentially address it.

Closes https://linear.app/a8c/issue/SQUARE-231/categories-get-stripped-off-from-products-that-are-synced-from-square

Steps to test the changes in this Pull Request:

Square SOR:
- Create a product in Square with multiple categories.
- Sync from Square to WooCommerce (via import).
- Verify that the WooCommerce product has all categories assigned correctly.
- Update the product on the Square side (e.g., update the product title).
- Wait for the interval polling to trigger (or trigger it manually).
- Verify that the WooCommerce product still has all categories assigned correctly and that none are removed.
- Trigger a manual sync from the settings and verify that the WooCommerce product still has all categories assigned correctly and that none are removed.
WooCommerce SOR:
- Create a product in WooCommerce with multiple categories and sync it with Square.
- Verify that the Square product has all categories assigned correctly.
- Update the product on the WooCommerce side (e.g., update the product title).
- Verify that the Square product still has all categories assigned correctly and that none are removed.
- Trigger a manual sync from the settings and verify that the Square product still has all categories assigned correctly and that none are removed.

Changelog entry

Fix - Categories were being stripped from products during manual sync.

…SOR)

github-actions · 2026-03-13T08:10:26Z

🔍 WordPress Plugin Check Report

❌ Status: Failed

📊 Report

🎯 Total Issues	❌ Errors	⚠️ Warnings
8	8	0

❌ Errors (8)

📁 includes/WC_Payments_Compatibility.php (1 error)

📍 Line	🔖 Check	💬 Message
`0`	missing_direct_file_access_protection	PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;

📁 includes/Framework/PaymentGateway/Admin/views/html-user-payment-token-editor-token.php (1 error)

📍 Line	🔖 Check	💬 Message
`0`	missing_direct_file_access_protection	PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;

📁 includes/Framework/PaymentGateway/Admin/views/html-user-payment-token-editor.php (1 error)

📍 Line	🔖 Check	💬 Message
`0`	missing_direct_file_access_protection	PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;

📁 includes/Framework/PaymentGateway/Admin/views/html-order-partial-capture.php (1 error)

📍 Line	🔖 Check	💬 Message
`0`	missing_direct_file_access_protection	PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;

📁 includes/Framework/PaymentGateway/Admin/views/html-user-profile-field-customer-id.php (1 error)

📍 Line	🔖 Check	💬 Message
`0`	missing_direct_file_access_protection	PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;

📁 includes/Framework/PaymentGateway/Admin/views/html-user-profile-section.php (1 error)

📍 Line	🔖 Check	💬 Message
`0`	missing_direct_file_access_protection	PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;

📁 includes/Framework/PaymentGateway/Admin/views/html-admin-gateway-status.php (1 error)

📍 Line	🔖 Check	💬 Message
`0`	missing_direct_file_access_protection	PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;

📁 includes/Admin/Product_Editor_Compatibility.php (1 error)

📍 Line	🔖 Check	💬 Message
`0`	missing_direct_file_access_protection	PHP file should prevent direct access. Add a check like: if ( ! defined( 'ABSPATH' ) ) exit;

🤖 Generated by WordPress Plugin Check Action • Learn more about Plugin Check

Copilot

Pull request overview

Fixes category assignment loss during Square→Woo sync (manual + interval) by centralizing multi-category extraction/import and updating sync handlers and E2E coverage accordingly.

Changes:

Refactors Square category ID extraction/import into Category::get_category_ids_from_catalog_item() and reuses it in product import and product updates.
Updates product update logic to assign multiple WooCommerce categories instead of a single category.
Expands E2E utilities/specs to create, sync, and assert multiple categories.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tests/e2e/utils/square-sandbox.js	Adds support for multiple categories in Square sandbox helpers and catalog info extraction.
tests/e2e/utils/helper.js	Updates Woo product creation helper to handle multiple categories from a comma-delimited string.
tests/e2e/specs/d8.square-sor-multiple-variations.spec.js	Updates expected variation attribute ordering/values (test expectations).
tests/e2e/specs/c4.product-import.spec.js	Extends import test to validate multiple categories after Square import.
tests/e2e/specs/c2.woo-sor.spec.js	Extends Woo→Square sync test to validate multiple categories pushed to Square.
includes/Sync/Product_Import.php	Replaces inline category import logic with shared category-ID extraction helper.
includes/Handlers/Product.php	Updates product-from-Square handler to set multiple category terms.
includes/Handlers/Category.php	Introduces shared helper to map/import Square categories to Woo term IDs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

faisal-alvi

@iamdharmesh thanks for working on this!

When Square has no categories, we should explicitly set product categories to empty so Woo matches Square, or document that we intentionally leave existing categories. I have also added a few suggestions. Please have a look.

faisal-alvi · 2026-03-17T13:02:11Z

+			try {
+				$response = wc_square()->get_api()->batch_retrieve_catalog_objects( $missing_category_ids );
+				if ( $response->get_data() instanceof \Square\Models\BatchRetrieveCatalogObjectsResponse ) {
+					$missing_categories = $response->get_data()->getObjects();


if getObjects() returns an empty array (e.g. deleted/invalid IDs), we only log on exception. Should we consider logging when some IDs were requested but none returned, for “category still missing” cases?

We log exception if we didn't get a proper response, but not logging for the empty array? Could you please provide more information on what we want to do here? Thanks

iamdharmesh · 2026-04-07T13:41:55Z

@faisal-alvi this is ready for your review.

Fix Categories get stripped off from products in Manual sync (Square …

ca90fc4

…SOR)

iamdharmesh self-assigned this Jan 21, 2026

iamdharmesh added 3 commits January 28, 2026 18:21

E2E: Update tests for the multiple categories sync

4405de2

E2E: Make E2E tests more accurate.

fb820a1

Merge branch 'trunk' into fix/SQUARE-231

c642353

vikrampm1 added this to the Future Release milestone Feb 15, 2026

Merge branch 'trunk' into fix/SQUARE-231

a658062

iamdharmesh force-pushed the fix/SQUARE-231 branch from 1f089b3 to a658062 Compare March 13, 2026 17:29

iamdharmesh added 2 commits March 14, 2026 00:04

E2E: fix flaky tests

b1bed68

Merge branch 'trunk' into fix/SQUARE-231

9f38a7b

iamdharmesh requested a review from Copilot March 16, 2026 05:20

Copilot started reviewing on behalf of iamdharmesh March 16, 2026 05:20 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

Comment thread includes/Handlers/Category.php

Comment thread includes/Handlers/Category.php

Comment thread tests/e2e/utils/square-sandbox.js Outdated

Comment thread tests/e2e/utils/helper.js Outdated

Comment thread tests/e2e/specs/c4.product-import.spec.js

Apply suggestions from Copilot code review

400cc34

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

iamdharmesh requested a review from faisal-alvi March 16, 2026 05:37

iamdharmesh commented Mar 16, 2026

View reviewed changes

Comment thread tests/e2e/specs/c4.product-import.spec.js Outdated

E2E: fix E2E tests.

558aa0f

faisal-alvi requested changes Mar 17, 2026

View reviewed changes

iamdharmesh added 3 commits March 20, 2026 23:51

Add since version and catalog item instance check.

1ccb8de

Merge branch 'trunk' into fix/SQUARE-231

8a059d9

Remove unwanted category set.

258c50b

iamdharmesh requested a review from faisal-alvi April 7, 2026 13:41

Merge branch 'trunk' into fix/SQUARE-231

db96b16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Categories were being stripped from products during manual sync.#451

Fix Categories were being stripped from products during manual sync.#451
iamdharmesh wants to merge 13 commits intotrunkfrom
fix/SQUARE-231

iamdharmesh commented Jan 21, 2026

Uh oh!

github-actions Bot commented Mar 13, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

faisal-alvi left a comment

Uh oh!

Uh oh!

Uh oh!

faisal-alvi Mar 17, 2026

Uh oh!

iamdharmesh Apr 7, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iamdharmesh commented Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

iamdharmesh commented Jan 21, 2026

All Submissions:

Changes proposed in this Pull Request:

Steps to test the changes in this Pull Request:

Changelog entry

Uh oh!

github-actions Bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 WordPress Plugin Check Report

📊 Report

❌ Errors (8)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

faisal-alvi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

faisal-alvi Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

iamdharmesh Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iamdharmesh commented Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Mar 13, 2026 •

edited

Loading