Query: Require queryId for enhanced pagination to prevent PHP notices. by peterwilsoncc · Pull Request #55720 · WordPress/gutenberg

peterwilsoncc · 2023-10-31T04:26:59Z

What?

Adds a check to ensure the Query ID is set before rendering enhanced pagination.

Why?

Without a Query ID the enhanced pagination will throw a notice. The Query ID doesn't include a default so can be unset.

How?

Within render_block_core_query() the conditions checking $attributes['enhancedPagination'] are modified to also check isset( $attributes['queryId'] ). If either item is not set then the feature is not enabled.

Testing Instructions

Enable debug mode in your wp-config file:

define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );
define( 'WP_DEBUG_DISPLAY', true );

Download and activate peters-sample-theme.zip which contains bad markup in templates/index.html
Generate some sample posts via WP CLI: wp post generate
Visit the the front end of the site.
- on trunk you should see some notices thrown
- on this branch the notices should not throw
Activate the TT2 theme
Edit the home page to enable advanced pagination on the query loop
Navigate posts, ensure advanced pagination works.

Testing Instructions for Keyboard

N/A

Screenshots or screencast

hellofromtonya · 2023-10-31T13:09:44Z

Test Report

This report validates that the indicated patch addresses the issue.

Environment

OS: macOS
Web Server: Nginx
PHP: 8.0.30
WordPress: 6.4 RC2
Browser: Firefox
Theme: https://github.com/WordPress/gutenberg/files/13211136/peters-sample-theme.zip
Active Plugins: None

Actual Results

Before the patch, can reproduce the PHP Warnings 🐞❌
After applying the patch: no PHP Warnings ✅

Test Report Icons:
🐞 <= Indicates where issue ("bug") occurs.
✅ <= Behavior is ''expected''.
❌ <= Behavior is ''NOT expected''.

hellofromtonya

See my test report which confirms:

can reproduce the PHP Warning before this PR
this PR resolves the issue.

hellofromtonya · 2023-10-31T13:14:03Z

React Native e2e tests (Android):
The failing test is unrelated to this PR, as it seems the service is unavailable. Restarting.

hellofromtonya · 2023-10-31T13:14:48Z

@SiobhyB @mikachan marking this PR for cherry-picking for 6.4 RC3.

DAreRodz

Thanks for the fix, @peterwilsoncc! 🙏

The enhanced pagination indeed requires the queryId attribute to be set to generate the data-wp-navigation-id prop, so this change makes total sense.

mikachan · 2023-10-31T16:38:24Z

I just cherry-picked this PR to the 6.4-rc3-2 branch to get it included in the next release: de980d5

peterwilsoncc · 2023-10-31T23:03:34Z

Thanks for merging this promptly. I've created #55747 as a follow up to investigate whether the ID can be autogenerated if it's missing in order to respect developer intent.

* Update label for lightbox editor UI (#55724) * Update label for lightbox editor UI * Change lightbox label in Global Styles * Require queryId for enhanced pagination. (#55720) * Change pattern category taxonomy public param to false (#55748) * Query block enhanced pagination: Detect inner plugin blocks during render (#55714) * Flag inner plugin blocks inside query loop * Improve PHP logic a little * Only disallow plugin blocks and post content * Get rid of global variables * Fix returned content from render callback * Handle composed query stacks * Disable navigation on the browser * Replace `count` with `empty` * Add PHPdocs and improve var naming * Lint PHP * Clarify docs a little * Move the disable check before preventDefault * Restore previous navigate logic * Set filter priorities back to 10 * Basic inspector warnings * Make render query filter static * Add stable modal logic * Switch back to ToggleControl * Auto remove filter when query stack is empty * Add first unit tests * Switch to inverse control * Add test case for nested queries * Prevent passing `null` to the Tag Processr * Get rid of explicit auto mode and notices * Test directives in the Pagination Previous block * Minor typos and improvements * Improve modal texts * Fix WPCS * Reorder teardowns * Reset the dirty flag after it's used * Prevent usage of post content block --------- Co-authored-by: David Arenas <david.arenas@automattic.com> * Reuse existing screen-reader-text CSS class. (#55309) --------- Co-authored-by: Artemio Morales <artemio.morales@a8c.com> Co-authored-by: Peter Wilson <519727+peterwilsoncc@users.noreply.github.com> Co-authored-by: Glen Davies <glendaviesnz@users.noreply.github.com> Co-authored-by: Luis Herranz <luisherranz@gmail.com> Co-authored-by: David Arenas <david.arenas@automattic.com> Co-authored-by: Andrea Fercia <a.fercia@gmail.com>

This second update for RC3 includes the following fixes: * [WordPress/gutenberg#55724 Update label for lightbox editor UI] - string change. * [WordPress/gutenberg#55720 Query: Require queryId for enhanced pagination to prevent PHP notices] and warnings. * [WordPress/gutenberg#55714 Query block enhanced pagination: Detect inner plugin blocks during render] - which avoids turning off enhanced pagination in TT4, includes string changes. * [WordPress/gutenberg#55309 Query Loop block: Reuse existing screen-reader-text CSS class for the enhanced pagination aria-live region]. Follow up to [57034], [56987], [56961], [56849], [56818], [56816]. Props afercia, aristath, artemiosans, czapla, darerodz, glendaviesnz, hellofromTonya, jameskoster, joen, luisherranz, mikachan, ocean90, peterwilsoncc, ramonopoly, rajinsharwar, swissspidy. Fixes #59411. Built from https://develop.svn.wordpress.org/trunk@57048 git-svn-id: http://core.svn.wordpress.org/trunk@56559 1a063a9b-81f0-0310-95a4-ce76da25c4cd

This second update for RC3 includes the following fixes: * [WordPress/gutenberg#55724 Update label for lightbox editor UI] - string change. * [WordPress/gutenberg#55720 Query: Require queryId for enhanced pagination to prevent PHP notices] and warnings. * [WordPress/gutenberg#55714 Query block enhanced pagination: Detect inner plugin blocks during render] - which avoids turning off enhanced pagination in TT4, includes string changes. * [WordPress/gutenberg#55309 Query Loop block: Reuse existing screen-reader-text CSS class for the enhanced pagination aria-live region]. Follow up to [57034], [56987], [56961], [56849], [56818], [56816]. Props afercia, aristath, artemiosans, czapla, darerodz, glendaviesnz, hellofromTonya, jameskoster, joen, luisherranz, mikachan, ocean90, peterwilsoncc, ramonopoly, rajinsharwar, swissspidy. Fixes #59411. Built from https://develop.svn.wordpress.org/trunk@57048 git-svn-id: https://core.svn.wordpress.org/trunk@56559 1a063a9b-81f0-0310-95a4-ce76da25c4cd

This second update for RC3 includes the following fixes: * [WordPress/gutenberg#55724 Update label for lightbox editor UI] - string change. * [WordPress/gutenberg#55720 Query: Require queryId for enhanced pagination to prevent PHP notices] and warnings. * [WordPress/gutenberg#55714 Query block enhanced pagination: Detect inner plugin blocks during render] - which avoids turning off enhanced pagination in TT4, includes string changes. * [WordPress/gutenberg#55309 Query Loop block: Reuse existing screen-reader-text CSS class for the enhanced pagination aria-live region]. Follow up to [57034], [56987], [56961], [56849], [56818], [56816]. Reviewed by davidbaumwald , jorbin. Merges [57048] to the 6.4 branch. Props afercia, aristath, artemiosans, czapla, darerodz, glendaviesnz, hellofromTonya, jameskoster, joen, luisherranz, mikachan, ocean90, peterwilsoncc, ramonopoly, rajinsharwar, swissspidy. Fixes #59411. git-svn-id: https://develop.svn.wordpress.org/branches/6.4@57049 602fd350-edb4-49c9-b593-d223f7449a82

This second update for RC3 includes the following fixes: * [WordPress/gutenberg#55724 Update label for lightbox editor UI] - string change. * [WordPress/gutenberg#55720 Query: Require queryId for enhanced pagination to prevent PHP notices] and warnings. * [WordPress/gutenberg#55714 Query block enhanced pagination: Detect inner plugin blocks during render] - which avoids turning off enhanced pagination in TT4, includes string changes. * [WordPress/gutenberg#55309 Query Loop block: Reuse existing screen-reader-text CSS class for the enhanced pagination aria-live region]. Follow up to [57034], [56987], [56961], [56849], [56818], [56816]. Reviewed by davidbaumwald , jorbin. Merges [57048] to the 6.4 branch. Props afercia, aristath, artemiosans, czapla, darerodz, glendaviesnz, hellofromTonya, jameskoster, joen, luisherranz, mikachan, ocean90, peterwilsoncc, ramonopoly, rajinsharwar, swissspidy. Fixes #59411. Built from https://develop.svn.wordpress.org/branches/6.4@57049 git-svn-id: http://core.svn.wordpress.org/branches/6.4@56560 1a063a9b-81f0-0310-95a4-ce76da25c4cd

This second update for RC3 includes the following fixes: * [WordPress/gutenberg#55724 Update label for lightbox editor UI] - string change. * [WordPress/gutenberg#55720 Query: Require queryId for enhanced pagination to prevent PHP notices] and warnings. * [WordPress/gutenberg#55714 Query block enhanced pagination: Detect inner plugin blocks during render] - which avoids turning off enhanced pagination in TT4, includes string changes. * [WordPress/gutenberg#55309 Query Loop block: Reuse existing screen-reader-text CSS class for the enhanced pagination aria-live region]. Follow up to [57034], [56987], [56961], [56849], [56818], [56816]. Props afercia, aristath, artemiosans, czapla, darerodz, glendaviesnz, hellofromTonya, jameskoster, joen, luisherranz, mikachan, ocean90, peterwilsoncc, ramonopoly, rajinsharwar, swissspidy. Fixes #59411. git-svn-id: https://develop.svn.wordpress.org/trunk@57048 602fd350-edb4-49c9-b593-d223f7449a82

peterwilsoncc added [Type] Bug An existing feature does not function as intended [Block] Query Loop Affects the Query Loop Block labels Oct 31, 2023

Require queryId for enhanced pagination.

21480de

peterwilsoncc force-pushed the fix/55719-prevent-enhanced-pagination-notices branch from cb33d90 to 21480de Compare October 31, 2023 04:29

peterwilsoncc marked this pull request as ready for review October 31, 2023 04:44

peterwilsoncc requested a review from ajitbohra as a code owner October 31, 2023 04:44

hellofromtonya approved these changes Oct 31, 2023

View reviewed changes

hellofromtonya added the Backport to WP Beta/RC label Oct 31, 2023

DAreRodz approved these changes Oct 31, 2023

View reviewed changes

DAreRodz merged commit 12694ff into trunk Oct 31, 2023

DAreRodz deleted the fix/55719-prevent-enhanced-pagination-notices branch October 31, 2023 15:56

github-actions bot added this to the Gutenberg 17.0 milestone Oct 31, 2023

mikachan pushed a commit that referenced this pull request Oct 31, 2023

Require queryId for enhanced pagination. (#55720)

de980d5

mikachan removed the Backport to WP Beta/RC label Oct 31, 2023

mikachan mentioned this pull request Oct 31, 2023

Cherry-picked commits for WordPress 6.4 RC3 v2 #55736

Merged

hellofromtonya mentioned this pull request Nov 1, 2023

Update npm packages to latest versions for 6.4 RC3 v2 WordPress/wordpress-develop#5610

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Query: Require queryId for enhanced pagination to prevent PHP notices.#55720

Query: Require queryId for enhanced pagination to prevent PHP notices.#55720
DAreRodz merged 1 commit intotrunkfrom
fix/55719-prevent-enhanced-pagination-notices

peterwilsoncc commented Oct 31, 2023 •

edited

Loading

Uh oh!

hellofromtonya commented Oct 31, 2023

Uh oh!

hellofromtonya left a comment

Uh oh!

hellofromtonya commented Oct 31, 2023

Uh oh!

hellofromtonya commented Oct 31, 2023

Uh oh!

DAreRodz left a comment

Uh oh!

mikachan commented Oct 31, 2023

Uh oh!

peterwilsoncc commented Oct 31, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

peterwilsoncc commented Oct 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

Uh oh!

hellofromtonya commented Oct 31, 2023

Test Report

Environment

Actual Results

Uh oh!

hellofromtonya left a comment

Choose a reason for hiding this comment

Uh oh!

hellofromtonya commented Oct 31, 2023

Uh oh!

hellofromtonya commented Oct 31, 2023

Uh oh!

DAreRodz left a comment

Choose a reason for hiding this comment

Uh oh!

mikachan commented Oct 31, 2023

Uh oh!

peterwilsoncc commented Oct 31, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

peterwilsoncc commented Oct 31, 2023 •

edited

Loading