-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update: Remove need for template prefix in gutenberg_get_template_hie…
…rarchy. (#46257)
- Loading branch information
1 parent
9cbaa94
commit a33c214
Showing
4 changed files
with
226 additions
and
24 deletions.
There are no files selected for viewing
This file contains 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 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,112 @@ | ||
| <?php | ||
| /** | ||
| * Temporary compatibility shims for features present in Gutenberg. | ||
| * This file should be removed when WordPress 6.1.0 becomes the lowest | ||
| * supported version by this plugin. | ||
| * | ||
| * @package gutenberg | ||
| */ | ||
|
|
||
| /** | ||
| * Helper function to get the Template Hierarchy for a given slug. | ||
| * We need to Handle special cases here like `front-page`, `singular` and `archive` templates. | ||
| * | ||
| * Noting that we always add `index` as the last fallback template. | ||
| * | ||
| * @param string $slug The template slug to be created. | ||
| * @param boolean $is_custom Indicates if a template is custom or part of the template hierarchy. | ||
| * @param string $template_prefix The template prefix for the created template. This is used to extract the main template type ex. in `taxonomy-books` we extract the `taxonomy`. | ||
| * | ||
| * @return array<string> The template hierarchy. | ||
| */ | ||
| function gutenberg_get_template_hierarchy( $slug, $is_custom = false, $template_prefix = '' ) { | ||
| if ( 'index' === $slug ) { | ||
| return array( 'index' ); | ||
| } | ||
| if ( $is_custom ) { | ||
| return array( 'page', 'singular', 'index' ); | ||
| } | ||
| if ( 'front-page' === $slug ) { | ||
| return array( 'front-page', 'home', 'index' ); | ||
| } | ||
|
|
||
| $template_hierarchy = array( $slug ); | ||
| // Most default templates don't have `$template_prefix` assigned. | ||
| if ( ! empty( $template_prefix ) ) { | ||
| list($type) = explode( '-', $template_prefix ); | ||
| // We need these checks because we always add the `$slug` above. | ||
| if ( ! in_array( $template_prefix, array( $slug, $type ), true ) ) { | ||
| $template_hierarchy[] = $template_prefix; | ||
| } | ||
| if ( $slug !== $type ) { | ||
| $template_hierarchy[] = $type; | ||
| } | ||
| } else { | ||
| $matches = array(); | ||
| if ( preg_match( '/^(author|category|archive|tag|page)-(.+)$/', $slug, $matches ) ) { | ||
| $template_hierarchy[] = $matches[1]; | ||
| } elseif ( preg_match( '/^(single|taxonomy)-(.+)$/', $slug, $matches ) ) { | ||
| $type = $matches[1]; | ||
| $slug_remaining = $matches[2]; | ||
| if ( 'single' === $type ) { | ||
| $post_types = get_post_types(); | ||
| foreach ( $post_types as $post_type ) { | ||
| if ( str_starts_with( $slug_remaining, $post_type ) ) { | ||
| // If $slug_remaining is equal to $post_type we have the single-$post_type template. | ||
| if ( $slug_remaining === $post_type ) { | ||
| $template_hierarchy[] = 'single'; | ||
| break; | ||
| } | ||
| // If $slug_remaining is single-$post_type-$slug template. | ||
| if ( str_starts_with( $slug_remaining, $post_type . '-' ) && strlen( $slug_remaining ) > strlen( $post_type ) + 1 ) { | ||
| $template_hierarchy[] = "single-$post_type"; | ||
| $template_hierarchy[] = 'single'; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| } elseif ( 'taxonomy' === $type ) { | ||
| $taxonomies = get_taxonomies(); | ||
| foreach ( $taxonomies as $taxonomy ) { | ||
| if ( str_starts_with( $slug_remaining, $taxonomy ) ) { | ||
| // If $slug_remaining is equal to $taxonomy we have the taxonomy-$taxonomy template. | ||
| if ( $slug_remaining === $taxonomy ) { | ||
| $template_hierarchy[] = 'taxonomy'; | ||
| break; | ||
| } | ||
| // If $slug_remaining is taxonomy-$taxonomy-$term template. | ||
| if ( str_starts_with( $slug_remaining, $taxonomy . '-' ) && strlen( $slug_remaining ) > strlen( $taxonomy ) + 1 ) { | ||
| $template_hierarchy[] = "taxonomy-$taxonomy"; | ||
| $template_hierarchy[] = 'taxonomy'; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // Handle `archive` template. | ||
| if ( | ||
| str_starts_with( $slug, 'author' ) || | ||
| str_starts_with( $slug, 'taxonomy' ) || | ||
| str_starts_with( $slug, 'category' ) || | ||
| str_starts_with( $slug, 'tag' ) || | ||
| 'date' === $slug | ||
| ) { | ||
| $template_hierarchy[] = 'archive'; | ||
| } | ||
| // Handle `single` template. | ||
| if ( 'attachment' === $slug ) { | ||
| $template_hierarchy[] = 'single'; | ||
| } | ||
| // Handle `singular` template. | ||
| if ( | ||
| str_starts_with( $slug, 'single' ) || | ||
| str_starts_with( $slug, 'page' ) || | ||
| 'attachment' === $slug | ||
| ) { | ||
| $template_hierarchy[] = 'singular'; | ||
| } | ||
| $template_hierarchy[] = 'index'; | ||
| return $template_hierarchy; | ||
| } |
This file contains 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 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
a33c214There 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.
Flaky tests detected.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.
🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3739789056
📝 Reported issues:
Browse all#45332 inspecs/editor/various/inserting-blocks.test.js/test/e2e/specs/editor/various/preview.spec.js