Fix - TGM Plugin activation calling undefined function wc_get_screen_ids

[shivapoudel]

If we add woocommerce and enable the force_activation config in TGM plugin activation then the bug appears.

Submission Review Guidelines:

• I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have reviewed my code for security best practices.
• Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

All this does is ensure that a particular file is loaded before a function within that file is called. Most of the time, the file is already loaded, so in those cases, this change does nothing. Rather than having to install and set up the third-party TGM Plugin, all we really need to do here is make sure this change doesn't break anything. So after switching to this branch, try a few things:

• Deactivating and reactivating the plugin
• Navigate to a few different WooCommerce pages within WP Admin

Doing these things, you shouldn't see any fatal errors about notices or about functions already being defined.

Changelog entry

• Automatically create a changelog entry from the details below.

Significance

• Patch
• Minor
• Major

Type

• Fix - Fixes an existing bug
• Add - Adds functionality
• Update - Update existing functionality
• Dev - Development related task
• Tweak - A minor adjustment to the codebase
• Performance - Address performance issues
• Enhancement - Improvement to existing functionality

Message

Ensure WC admin functions are defined before attempting to add notices.

Comment

[github-actions]

Hi ,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

[coreymckrill]

Hi @shivapoudel, thanks for the PR! Rather than bailing early on the add_notices method when wc_get_screen_ids doesn't exist, I think it would be preferable to maintain the functionality and just ensure that wc_get_screen_ids does exist.

The reason the error is happening is that the wc-admin-functions.php file isn't getting loaded during the TGM request for some reason. But we could do something like what happens here, and require the file within add_notices. So maybe at the top of the method we could add a line like this:

require_once WC_ABSPATH . 'includes/admin/wc-admin-functions.php';

What do you think?

[shivapoudel]

But TGM is external library so how the inclusion occurs? Or you mean to say rather than function_exists check just to include the file within wc_get_screen_ids function.

[coreymckrill]

Or you mean to say rather than function_exists check just to include the file within wc_get_screen_ids function.

Sort of. I mean something like the below suggestion.

[shivapoudel]

@coreymckrill Adapted the changes. Thanks!

[coreymckrill]

Closing and re-opening this PR to fix the stuck CI actions...