Update Payments menu item display and linking behavior #51541

vladolaru · 2024-09-19T10:18:01Z

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:

We detach the Payments top-level menu item from the presence of an active WooPayments incentive:

When the WooPayments plugin is NOT active, regardless of an incentive being available - the left nav payments item will always show.
When the WooPayments plugin is active, it will take over the Payments menu item for its use.
If an incentive is available, clicking the nav item will take the merchant to the incentive page.
If an incentive is unavailable or dismissed, clicking the nav item will take the merchant to the currently active Payments task page (either the base "Get paid" task or the "Get paid with WooPayments" task).

Additionally, we remove the recommended treatment of PSP suggestions when WooPayments is recommended.

Here is a recording of the new behavior on a fresh JurassicNinja site:

Closes #51111

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

Create a new JurassicNinja site with just WooCommerce on this PR's live branch (here is a direct JN create link)
Go to the newly created site WP admin dashboard
Go through the WooCommerce profiler (click on the "WooCommerce" menu item if it doesn't start automatically), click on "Skip guided setup", and choose India as your store's location
Go to WooCommerce > Home and you should see a "Get paid" task and a "Payments" top-level menu item with a red dot notice:
Click on the "Payments" top-level menu item and you should see the Payments task page (notice the /wp-admin/admin.php?page=wc-admin&task=payments URL):
Click "Enable" for the "Cash on delivery" offline payment method in the bottom "Offline payments methods" section.
Refresh the page, and the "Payments" top-level menu item should NOT have a red dot notice.
Go to WooCommerce > Home and the "Get paid" task should be complete (striked out).
Click on the "Payments" top-level menu item and click on "Get started" for the Stripe recommended payment provider:
After the Stripe extension is installed, go to WooCommerce > Settings > Payments and click on "Finish setup" for Stripe:
Once on the Stripe extensions settings page, click on "Create or connect a test account instead" and them "Skip this form":
Once the Stripe test account is set up and you are redirected back to the Stripe extension settings page, go to WooCommerce > Home and make sure the "Get paid" task is completed (striked out)
Click on the "Payments" top-level menu item and Stripe shouldn't be present:
Go to WooCommerce > Settings > General and change your store's location country to United States (the specific state doesn't matter)
Go to WooCommerce > Home and you should see a completed "Get paid with WooPayments" task (striked out) and a "Set up additional payments options" task in the "Things to do next" list:
Click on the "Set up additional payments options" task and you should see a page with WooPayments at the top and additional payment options below (the "Payments" top-level menu item should be present and NOT have a red dot notice):
Click on the "Payments" top-level menu item and you should remain on the same page (notice the wp-admin/admin.php?page=wc-admin&task=payments URL)
Click on "Get started" for WooPayments, and after the WooPayments plugin is installed and activated, click on "Connect":
You should be taken to the Jetpack connection screen (approve the connection) and then to the WooPayments wizard (click on Cancel):
Go to WooCommerce > Home and click on the "Set up additional payments options" task in the "Things to do next" list. You should be taken to the task page with WooPayments featuring a "Finish setup" button:
Click on the "Finish setup" button, and you will be taken to the WooPayments wizard. Click on Cancel and you will be taken to the WooPayments Connect page.
Click on "Enable sandbox mode" in the "I'm setting up the store for someone else" bottom section. After your sandbox account is set up, you will be taken to the Payments > Overview page with a complete/enabled account
Go to Plugins > Installed plugins and deactivate both WooPayments and WooCommerce Stripe Gateway.
Go to WooCommerce > Settings > Payments and disable the "Cash on delivery" payment method
Go to WooCommerce > Home and you should see "Get paid with WooPayments" task with a discount badge. At the same time, you should see a "Payments" top-level menu item with a red dot notice:
Click on the "Payments" top-level menu item and you will see the WooPayments incentive page:
Dismiss the incentive by clicking on the "No thanks" link and then click on "Just dismiss WooPayments" in the modal.
You will be redirected to the WooCommerce > Home page with a "Get paid with WooPayments" task without a discount badge and a "Payments" top-level main menu item with a red dot notice:
Click on the "Payments" top-level main menu item and you will be taken to the task page (notice the wp-admin/admin.php?page=wc-admin&task=woocommerce-payments URL). WooPayments is present, and there is no recommended badge for the gateway in the "Other payment providers" section below:
Click on "Enable" for the "Cash on delivery" offline payment method and refresh the page. The "Payments" top-level main menu item should NOT have a red dot notice anymore.
Go to WooCommerce > Home and click on the "Get paid with WooPayments" task. WooPayments will be activated and you will be redirected to the WooPayments settings page since you already have a connected account.
Go to WooCommerce > Home and the "Get paid with WooPayments" task should be completed (striked out), and in the "Things to do next" task list, you should have a "Set up additional payment options" task and a "Set up real payments on your store" task.
Click on the "Set up additional payment options" task, and you should see a task page with an additional payment options section and a "Activate BNPL instantly on WooPayments" section:

Changelog entry

Automatically create a changelog entry from the details below.

This Pull Request does not require a changelog entry. (Comment required below)

Changelog Entry Details

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

Changelog Entry Comment

Comment

…ge for clarity

github-actions · 2024-09-19T10:24:46Z

Test using WordPress Playground

The changes in this pull request can be previewed and tested using a WordPress Playground instance.
WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Test this pull request with WordPress Playground.

Note that this URL is valid for 30 days from when this comment was last updated. You can update it by closing/reopening the PR or pushing a new commit.

github-actions · 2024-09-19T10:39:46Z

Size Change: 0 B

Total Size: 2.38 MB

_{compressed-size-action}

… extended task list also

* Minor cleanup * refact: Rename must_be_visible to is_incentive_visible for clarity * refact: Rename register_payments_welcome_page to register_menu_and_page for clarity * Don't show the incentive page if the user can't manage WC * Introduce menu item when no incentive * Don't recommend additional gateways when WCPay is present * Render gateway suggestions on the WCPay task page, also * Add changelog entry * Remove short array syntax * Lint fixes * Simplify Payments task view logic * Simplify WooPayments task view logic * Improve WooPayments task complete logic * WooPayments can't be connected or onboarded if it is not active * refact: Rename private static method * Improve logic to determine the Payments task slug by factoring in the extended task list also * docs: Add details about our use of the Payments task logic * Add type hint * Do not recommend offline methods when WooPayments is supported * On suggestion enablement redirect to the same task page * Lint fixes * test: Fix unit tests * Maintain deprecated navigation logic

* Update Payments menu item display and linking behavior (#51541) * Minor cleanup * refact: Rename must_be_visible to is_incentive_visible for clarity * refact: Rename register_payments_welcome_page to register_menu_and_page for clarity * Don't show the incentive page if the user can't manage WC * Introduce menu item when no incentive * Don't recommend additional gateways when WCPay is present * Render gateway suggestions on the WCPay task page, also * Add changelog entry * Remove short array syntax * Lint fixes * Simplify Payments task view logic * Simplify WooPayments task view logic * Improve WooPayments task complete logic * WooPayments can't be connected or onboarded if it is not active * refact: Rename private static method * Improve logic to determine the Payments task slug by factoring in the extended task list also * docs: Add details about our use of the Payments task logic * Add type hint * Do not recommend offline methods when WooPayments is supported * On suggestion enablement redirect to the same task page * Lint fixes * test: Fix unit tests * Maintain deprecated navigation logic * Prep for cherry pick 51541 --------- Co-authored-by: Vlad Olaru <[email protected]> Co-authored-by: WooCommerce Bot <[email protected]>

thekendog · 2024-11-13T12:37:03Z

It appears this was included in 9.4.1. It's broken. I now have a constant Payments menu item with an orange bubble. Clicking it shows a blank page. If I enable a payment method from the regular settings area, the orange bubble goes away on the menu item, but the page is still blank when I click it.

Why was this added? WooCommerce already has 4 menu items in the admin section. I don't really want another one to clutter things up. There probably should be a way to remove this easily, once it's fixed.

dcx15 · 2024-11-13T12:48:56Z

Why was this added?

I assume it is just a classic case of Automattic wanting to upsell something.

Fun.

thekendog · 2024-11-13T12:56:06Z

Why was this added?

I assume it is just a classic case of Automattic wanting to upsell something.

Fun.

I understand then wanting to upsell something and make money. I'm fine with that. There just needs to be a way to remove this menu item once I dismiss the task. That and it needed more thorough testing I guess.

mrleemon · 2024-11-13T13:49:41Z

Same here. This "Payments" tab appears even though I don't have WooPayments enabled. Clicking it takes me to a blank page. I would like an option to remove this.

maddisondesigns · 2024-11-14T04:14:39Z

This PR either needs to be reversed or a fix put in place ASAP, to remove the extra Payments top-level menu item (which shows as a blank page. This PR was obviously never tested properly before being merged.

mattthomasphoto · 2024-11-14T11:08:51Z

Awful that you can’t dismiss this WooPayments page as I just the official Woo Stripe for payments and now there’s this extra menu for no reason but “advertising”

Using the below hides the Payments menu - however CSS to hide something that shouldn't be there in the first place!

// Hide WooCommerce Payments menu item with CSS function hide_payments_menu_css() { echo '<style> .toplevel_page_admin\\?page\\=wc-admin\\&task\\=payments { display: none !important; } </style>'; } add_action('admin_head', 'hide_payments_menu_css');

This needs sorting ASAP!

vladolaru · 2024-11-14T14:21:12Z

@maddisondesigns, could you help me with some details on how you are testing this and getting the blank page? An SSR of the test store would also come in handy. Thank you.

thekendog · 2024-11-14T14:32:47Z

#39668 (comment)

dcx15 · 2024-11-14T15:24:54Z

This feels like such an odd change and the issue it closes doesn't mention anything about why it was needed. Is the purpose simply to signpost the WooPayments service offered by Woo?

There are more people posting about the page being blank at https://wordpress.org/support/topic/payments-menu-after-upgrading-to-9-4-1-empty-page/ too

richboos · 2024-11-14T16:11:57Z

This really shouldn't appear as a top-level menu item in WordPress. Payment integrations aren't something that is frequently visited. Compare to other top-level entries:

WooCommerce - It's own thing, obviously
Products - products come and go, prices change, stock levels change, etc
Marketing - coupons get created and rotated

But Payments? Why? Who is changing out payment providers weekly?

I think we know why, which would be what @dcx15 implied - it's an advertisement decision, not a usage-based decision.

maddisondesigns · 2024-11-15T02:02:54Z

@vladolaru All I'm doing is clicking on the Payments top-level menu item that has appeared since the most recent update. Here's a (very short) screencast showing that the page is blank after clicking on the menu item. This is on a live site, but I've also tested this on a couple of local development sites, and the exact same thing happens.

WC.Payments.Blank.Screen.-.2024-11-15.mp4

And no, there was no No thanks link to click on. The menu item just appeared after the most recent update and it's always been showing a blank screen.

maddisondesigns · 2024-11-28T09:58:51Z

@vladolaru As mentioned over in this issue #52812, this "fix" that has been merged, has still not actually fixed the issue! I'm still seeing a Payments menu item in my dashboard, with WooCommerce 9.4.2 Instead of seeing a blank page when I click on it though, it now just redirects me to the Payments Tab in the WC Settings.

Screencast: https://share.zight.com/P8uKZvOP

I'm seeing the same thing on multiple sites. This whole menu item needs to be completely removed from the Dashboard!

vladolaru added 8 commits September 19, 2024 13:03

Minor cleanup

5103367

refact: Rename must_be_visible to is_incentive_visible for clarity

4709f85

refact: Rename register_payments_welcome_page to register_menu_and_pa…

6fe5cba

…ge for clarity

Don't show the incentive page if the user can't manage WC

e72756b

Introduce menu item when no incentive

67f8928

Don't recommend additional gateways when WCPay is present

ddf430f

Render gateway suggestions on the WCPay task page, also

e5337d3

Add changelog entry

57d7a67

vladolaru self-assigned this Sep 19, 2024

github-actions bot added the plugin: woocommerce Issues related to the WooCommerce Core plugin. label Sep 19, 2024

Merge branch 'trunk' into update/51111-payments-menu-item

43c9581

vladolaru added 2 commits September 19, 2024 13:26

Remove short array syntax

1117ce5

Lint fixes

c82d809

vladolaru and others added 14 commits September 19, 2024 19:26

Simplify Payments task view logic

fbd1464

Simplify WooPayments task view logic

c5b12ef

Improve WooPayments task complete logic

17b85b7

WooPayments can't be connected or onboarded if it is not active

cbadd61

refact: Rename private static method

6b34220

Improve logic to determine the Payments task slug by factoring in the…

b7cad39

… extended task list also

docs: Add details about our use of the Payments task logic

955474d

Add type hint

ab7ed21

Do not recommend offline methods when WooPayments is supported

949a0db

On suggestion enablement redirect to the same task page

e516a80

Merge branch 'trunk' into update/51111-payments-menu-item

ddbfb1c

Lint fixes

9a87664

test: Fix unit tests

b03a347

Maintain deprecated navigation logic

eec9b08

vladolaru marked this pull request as ready for review September 20, 2024 07:54

github-actions bot added this to the 9.5.0 milestone Sep 20, 2024

github-actions bot added the needs: analysis Indicates if the PR requires a PR testing scrub session. label Sep 20, 2024

naman03malhotra modified the milestones: 9.5.0, 9.4.0 Sep 23, 2024

This was referenced Sep 23, 2024

Cherry pick 51541 into release/9.4 #51615

Merged

Delete changelog files based on PR 51541 #51616

Merged

anu-rock mentioned this pull request Nov 14, 2024

WooPayments shows in the admin menu without being installed #39668

Closed

5 tasks

maddisondesigns mentioned this pull request Nov 15, 2024

“Payments” menu after upgrading to 9.4.1 empty page #52812

Closed

5 tasks

anu-rock mentioned this pull request Nov 15, 2024

Incorrect wording in WooPayments no thanks modal #52868

Closed

5 tasks

This was referenced Nov 15, 2024

Fix Payments menu item linking to a blank page #52882

Merged

Fix Payments menu item linking to a blank page #52900

Merged

vladolaru mentioned this pull request Dec 6, 2024

Change Payments menu and tasks behavior depending on React Payments page feature flag #53514

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Payments menu item display and linking behavior #51541

Update Payments menu item display and linking behavior #51541

vladolaru commented Sep 19, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024

thekendog commented Nov 13, 2024

dcx15 commented Nov 13, 2024

thekendog commented Nov 13, 2024

mrleemon commented Nov 13, 2024

maddisondesigns commented Nov 14, 2024

mattthomasphoto commented Nov 14, 2024 •

edited

Loading

vladolaru commented Nov 14, 2024

thekendog commented Nov 14, 2024

dcx15 commented Nov 14, 2024 •

edited

Loading

richboos commented Nov 14, 2024 •

edited

Loading

maddisondesigns commented Nov 15, 2024 •

edited

Loading

maddisondesigns commented Nov 28, 2024

Update Payments menu item display and linking behavior #51541

Update Payments menu item display and linking behavior #51541

Conversation

vladolaru commented Sep 19, 2024 • edited Loading

Submission Review Guidelines:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Changelog entry

Significance

Type

Message

Comment

github-actions bot commented Sep 19, 2024 • edited Loading

Test using WordPress Playground

github-actions bot commented Sep 19, 2024

thekendog commented Nov 13, 2024

dcx15 commented Nov 13, 2024

thekendog commented Nov 13, 2024

mrleemon commented Nov 13, 2024

maddisondesigns commented Nov 14, 2024

mattthomasphoto commented Nov 14, 2024 • edited Loading

vladolaru commented Nov 14, 2024

thekendog commented Nov 14, 2024

dcx15 commented Nov 14, 2024 • edited Loading

richboos commented Nov 14, 2024 • edited Loading

maddisondesigns commented Nov 15, 2024 • edited Loading

maddisondesigns commented Nov 28, 2024

vladolaru commented Sep 19, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024 •

edited

Loading

mattthomasphoto commented Nov 14, 2024 •

edited

Loading

dcx15 commented Nov 14, 2024 •

edited

Loading

richboos commented Nov 14, 2024 •

edited

Loading

maddisondesigns commented Nov 15, 2024 •

edited

Loading