Prevent possible warning in COTMigrationUtil::get_post_or_object_meta()

[jorgeatorres]

All Submissions:

• Have you followed the WooCommerce Contributing guideline?
• Does your code follow the WordPress' coding standards?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

This PR makes sure that $post->ID is set before attempting to use it inside calls to COTMigrationUtil::get_post_or_object_meta().

This function mostly exists for HPOS/posts compat reasons and serves functions woocommerce_wp_select(), woocommerce_wp_text_input(), woocommerce_wp_hidden_input(), etc. in wc-meta-box-functions.php.

Closes #35543.

How to test the changes in this Pull Request:

• Have you followed the Writing high-quality testing instructions guide?

Per #35543, you should "write a snippet to call woocommerce_wp_select in a WooCommerce > Settings hook […]".

The issue can also be replicated by just calling those functions in almost any context where the $post global is not set, but to replicate the exact conditions of #35543, the following can be used:

1. Create a test plugin/snippet with the following code (or add it to the theme's functions.php)

   add_action(
       'woocommerce_settings_general',
       function() {
    	   woocommerce_wp_select(
    		   array(
    			   'id'          => 'my-favorite-topping',
    			   'value'       => 'pepperoni',
    			   'label'       => 'Pizza Topping',
    			   'options'     => [
    				   'pineapple' => 'Pineapple',
    				   'salami'    => 'Salami',
    				   'pepperoni' => 'Pepperoni',
    				   'onion'     => 'Onion',
    			   ],
    			   'desc_tip'    => true,
    			   'description' => 'Toppings are a serious matter. Choose wisely.',
    		   )
    	   );
       },
       999
   );

2. Go to WC > Settings and scroll to the bottom of the page.
3. You should see a dropdown named "Pizza Topping" (no need to make a selection, though the best choice has been pre-selected for you).
4. Now, to the "errors" part:
   • On trunk, you should see a warning in the log such as PHP Notice: Trying to get property 'ID' of non-object in […].
   • On this branch, no warning should be logged.

[jorgeatorres]

Just noting that I've decided to use false as "default" value when $post->ID is not set, just to make get_post_or_object_meta () mimic what get_post_meta() does: return false for invalid $post_id (see codex). This, however, makes probably little difference in real use.

[codecov]

Codecov Report

Merging #37026 (7c76118) into trunk (ac47d18) will decrease coverage by 0.0%.
The diff coverage is 24.3%.

Additional details and impacted files

@@            Coverage Diff             @@
##             trunk   #37026     +/-   ##
==========================================
- Coverage     46.7%    46.7%   -0.0%     
- Complexity   17183    17188      +5     
==========================================
  Files          429      429             
  Lines        64799    64820     +21     
==========================================
+ Hits         30251    30253      +2     
- Misses       34548    34567     +19     

Impacted Files	Coverage Δ
...ocommerce/includes/admin/class-wc-admin-assets.php	0.0% <0.0%> (ø)
...mmerce/includes/admin/class-wc-admin-importers.php	0.0% <0.0%> (ø)
plugins/woocommerce/includes/class-wc-ajax.php	4.3% <0.0%> (-0.1%)	⬇️
...s/Version1/class-wc-rest-coupons-v1-controller.php	42.9% <0.0%> (ø)
...rs/Version1/class-wc-rest-orders-v1-controller.php	46.2% <0.0%> (ø)
...rters/class-wc-product-csv-importer-controller.php	36.1% <28.6%> (ø)
.../includes/import/class-wc-product-csv-importer.php	74.9% <44.4%> (ø)
...s/Version2/class-wc-rest-coupons-v2-controller.php	94.7% <75.0%> (ø)
plugins/woocommerce/includes/class-wc-coupon.php	73.9% <100.0%> (ø)
...lugins/woocommerce/includes/class-wc-discounts.php	84.5% <100.0%> (ø)
... and 19 more

[github-actions]

Test Results Summary

Commit SHA: 7c76118

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 53s
E2E Tests	189	0	0	6	0	195	17m 11s

---

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

[PanosSynetos]

Hey @jorgeatorres , thanks for working on this! - Once this is ready to merge, could you please share a zip so we can test it on our environments? cc @jimjasson

[rrennick]

@jorgeatorres There were issues in the PHP 7.4 unit tests.

[jorgeatorres]

@jorgeatorres There were issues in the PHP 7.4 unit tests.

Thanks @rrennick. Don't know why those failed but after re-running the job, they are now passing.

[rrennick]

LGTM. Tested great.

[rrennick]

Once this is ready to merge, could you please share a zip so we can test it on our environments?

@PanosSynetos I went ahead and merged this as it was a single line change. If you want to test this you can use pnpm run build:zip in the plugins/woocommerce folder to create a zip.

[PanosSynetos]

Thanks, we'll test it out! (sorry I missed the ping)

[PanosSynetos]

Tested, we're good 👌 and the warning is gone