Repository navigation
Preserved queries in onboarding archives #195
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| <?php | ||
| /** | ||
| * Class Test_Onboarding_Templates | ||
| * | ||
| * @package raft | ||
| * | ||
| * @phpstan-type ParsedBlock array{blockName: string|null, attrs: array<string, mixed>, innerBlocks: list<array<string, mixed>>, innerHTML: string, innerContent: list<string|null>} | ||
| */ | ||
|
|
||
| class Test_Onboarding_Templates extends WP_UnitTestCase { | ||
| /** | ||
| * Onboarding archive templates must list the posts of the archive being viewed. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function test_archive_templates_inherit_the_archive_query(): void { | ||
| $support = get_theme_support( 'otter-onboarding' ); | ||
|
|
||
| /** @var array<string, array{file: string, title: string}> $archive_templates */ | ||
| $archive_templates = $support[0]['templates']['archive']; | ||
|
|
||
| $this->assertNotEmpty( $archive_templates ); | ||
|
|
||
| foreach ( $archive_templates as $slug => $template ) { | ||
| $queries = $this->find_query_blocks( parse_blocks( include $template['file'] ) ); | ||
|
|
||
| $this->assertNotEmpty( $queries, $slug ); | ||
|
|
||
| foreach ( $queries as $query ) { | ||
| $this->assertTrue( $query['attrs']['query']['inherit'], $slug ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Collect every Query block, including nested ones. | ||
| * | ||
| * @param list<ParsedBlock> $blocks Parsed blocks. | ||
| * | ||
| * @return list<ParsedBlock> | ||
| */ | ||
| private function find_query_blocks( array $blocks ): array { | ||
| $queries = array(); | ||
|
|
||
| foreach ( $blocks as $block ) { | ||
| if ( 'core/query' === $block['blockName'] ) { | ||
| $queries[] = $block; | ||
| } | ||
|
|
||
| $queries = array_merge( $queries, $this->find_query_blocks( $block['innerBlocks'] ) ); | ||
| } | ||
|
|
||
| return $queries; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
correctnessThis fixes only sites that run onboarding after the update. Otter saves the chosen variant's markup into the site'sarchivewp_templatepost at import time. Sites that already picked Archive Boxed, Cards or Rows keep"inherit":falseafter the update. Their category archives still list posts from all categories. This assumes those sites imported through the same path as Otter v3.2.8. Add a one-time upgrade routine that updates a saved Raftarchivetemplate whose Query block still matches a shipped variant with"inherit":false, and sets it totrue. Add a PHPUnit case that saves the old variant markup as awp_templatepost, runs the routine, and assertsinheritistrue.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not applied. Rewriting a site's saved
archivetemplate on upgrade would edit content the user owns and may have customised after onboarding, so the theme shouldn't change it silently. This PR fixes all new onboarding selections. Sites that already imported a variant can fix it by re-running onboarding's Archive step, or with "Inherit query from template" on the archive template's Query Loop.