Skip to content

Add fallback for store notice #59729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 24, 2025

Conversation

dsas
Copy link
Contributor

@dsas dsas commented Jul 17, 2025

Submission Review Guidelines:

Changes proposed in this Pull Request:

The store notice hook changed from wp_footer to wp_body_open in #55494 to improve accessibility. Old themes don't necessarily have support for wp_body_open - it was introduced in WP5.2 which means that the store notice wasn't appearing.

This change fixes the problem by outputting the store notice in the footer again if the wp_body_open hook hasn't been called.

Closes https://linear.app/a8c/issue/THEME-37 .

(For Bug Fixes) Bug introduced in PR #55494 .

Screenshots or screen recordings:

Before After
Screenshot 2025-07-17 at 11 15 25 Screenshot 2025-07-17 at 11 14 36

How to test the changes in this Pull Request:

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

  1. Switch to an old theme like lodestar
  2. Go to /wp-admin/customize.php, open up WooCommerce → Store Notice
  3. Tick the "Enable store notice" checkbox
  4. Look at the front-end of the website

Before this change, the store notice wasn't being displayed, now it is.

You should also check:

  • The page html to ensure it's not being output twice etc.
  • That the dismiss button works

Testing that has already taken place:

I followed my own steps above on a fresh new checkout of WooCommerce using a fresh new wp-env'd wp.

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

Fallback to displaying store notices via the wp_footer hook if the wp_body_open hook didn't fire. This improves compatibility with themes that haven't been updated to include the wp_body_open hook.

Changelog Entry Comment

Comment

@github-actions github-actions bot added the plugin: woocommerce Issues related to the WooCommerce Core plugin. label Jul 17, 2025
@dsas dsas marked this pull request as ready for review July 17, 2025 10:34
@dsas dsas requested a review from Manussakis July 17, 2025 10:34
Copy link
Contributor

github-actions bot commented Jul 17, 2025

Testing Guidelines

Hi @Manussakis ,

Apart from reviewing the code changes, please make sure to review the testing instructions (Guide) and verify that relevant tests (E2E, Unit, Integration, etc.) have been added or updated as needed.

Reminder: PR reviewers are required to document testing performed. This includes:

  • 🖼️ Screenshots or screen recordings.
  • 📝 List of functionality tested / steps followed.
  • 🌐 Site details (environment attributes such as hosting type, plugins, theme, store size, store age, and relevant settings).
  • 🔍 Any analysis performed, such as assessing potential impacts on environment attributes and other plugins, conducting performance profiling, or using LLM/AI-based analysis.

⚠️ Within the testing details you provide, please ensure that no sensitive information (such as API keys, passwords, user data, etc.) is included in this public issue.

Copy link
Contributor

coderabbitai bot commented Jul 17, 2025

📝 Walkthrough

Walkthrough

A fallback mechanism was added to ensure WooCommerce store notices are displayed even if the wp_body_open hook is not supported by the active theme. The system now checks if wp_body_open has fired and, if not, outputs the store notice via the wp_footer hook for improved compatibility with older themes.

Changes

File(s) Change Summary
plugins/woocommerce/includes/wc-template-hooks.php Added anonymous function to wp_footer to display store notice if wp_body_open is not triggered.
plugins/woocommerce/changelog/59729-theme-37-woocommerce-store-notice... Added changelog entry describing the new fallback mechanism for store notice display.

Sequence Diagram(s)

sequenceDiagram
    participant Theme
    participant WordPress
    participant WooCommerce

    Note over Theme,WordPress: Page load begins

    WordPress->>Theme: Render page
    Theme-->>WordPress: Fires hooks (wp_body_open, wp_footer, etc.)

    alt Theme supports wp_body_open
        WordPress->>WooCommerce: Trigger woocommerce_demo_store on wp_body_open
        WooCommerce->>WordPress: Output store notice
    else Theme does NOT support wp_body_open
        WordPress->>WooCommerce: Trigger anonymous function on wp_footer
        WooCommerce->>WooCommerce: Check did_action('wp_body_open')
        alt wp_body_open not triggered
            WooCommerce->>WordPress: Output store notice via woocommerce_demo_store
        else wp_body_open triggered
            Note over WooCommerce: Do nothing (already shown)
        end
    end
Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 58d0f02 and e2ffb9b.

📒 Files selected for processing (2)
  • plugins/woocommerce/changelog/59729-theme-37-woocommerce-store-notice-doesnt-show-up (1 hunks)
  • plugins/woocommerce/includes/wc-template-hooks.php (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • plugins/woocommerce/changelog/59729-theme-37-woocommerce-store-notice-doesnt-show-up
  • plugins/woocommerce/includes/wc-template-hooks.php
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (24)
  • GitHub Check: Blocks e2e tests 9/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Blocks e2e tests 5/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Blocks e2e tests 8/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Blocks e2e tests 2/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Blocks e2e tests 7/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Blocks e2e tests 1/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Blocks e2e tests 10/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Core e2e tests 6/6 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Blocks e2e tests 6/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Metrics - @woocommerce/plugin-woocommerce [performance]
  • GitHub Check: Core e2e tests 5/6 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Blocks e2e tests 3/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: PHP: 7.4 WP: latest - 1 [WP 6.7.2] 1/2 - @woocommerce/plugin-woocommerce [unit:php]
  • GitHub Check: Core API tests - @woocommerce/plugin-woocommerce [api]
  • GitHub Check: Blocks e2e tests 4/10 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: PHP: 7.4 WP: latest - 1 [WP 6.7.2] 2/2 - @woocommerce/plugin-woocommerce [unit:php]
  • GitHub Check: PHP: 8.4 WP: latest [WP latest] 2/2 - @woocommerce/plugin-woocommerce [unit:php]
  • GitHub Check: Core e2e tests 4/6 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Core e2e tests 3/6 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Core e2e tests 1/6 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: PHP: 8.4 WP: latest [WP latest] 1/2 - @woocommerce/plugin-woocommerce [unit:php]
  • GitHub Check: Core e2e tests 2/6 - @woocommerce/plugin-woocommerce [e2e]
  • GitHub Check: Lint - @woocommerce/plugin-woocommerce
  • GitHub Check: build
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch theme-37-woocommerce-store-notice-doesnt-show-up

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented Jul 17, 2025

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.

@nomadav3H
Copy link

I think I noticed this on a clients website, the store notices do not seem to be showing up, will this be updated in the next version oc woocommerce ?

@dsas dsas requested review from Manussakis and removed request for Manussakis July 21, 2025 20:00
Copy link

@mmtr mmtr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests as expected for me on the Playground link.

On a theme without wp_body_open support (e.g. Lodestar), the notice is displayed in the footer:

Screenshot 2025-07-22 at 11 17 50

On a theme with wp_body_open support (e.g. Storefront), the notice is displayed at the beginning of the body:

Screenshot 2025-07-22 at 11 28 25

@dsas dsas force-pushed the theme-37-woocommerce-store-notice-doesnt-show-up branch from 17fcd9f to 58d0f02 Compare July 24, 2025 09:00
dsas and others added 3 commits July 24, 2025 17:53
The store notice hook changed from wp_footer to wp_body_open in #55494
to improve accessibility. Old themes don't necessarily have support for
wp_body_open - it was introduced in WP5.2 which means that the store
notice wasn't appearing.

This change fixes the problem by outputting the store notice in the
footer again if the wp_body_open hook hasn't been called.
@dsas dsas force-pushed the theme-37-woocommerce-store-notice-doesnt-show-up branch from 2262912 to e2ffb9b Compare July 24, 2025 16:54
@dsas dsas merged commit 7c4868a into trunk Jul 24, 2025
69 of 71 checks passed
@dsas dsas deleted the theme-37-woocommerce-store-notice-doesnt-show-up branch July 24, 2025 17:23
@github-actions github-actions bot added this to the 10.2.0 milestone Jul 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugin: woocommerce Issues related to the WooCommerce Core plugin.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants