Changeset 54269 for trunk/src/wp-includes/block-template-utils.php

Timestamp:

09/20/2022 09:19:10 PM (2 years ago)

Author:

hellofromTonya

Message:

Editor: Adds template types, is_wp_suggestion, and fallback template content.

This commit improves site editor templates by:

• Adds a post meta is_wp_suggestion to templates created from the site editor.

Why? To differentiate the templates created from the post editor in the Template panel in inspector controls and the templates suggested in site editor.

See ​Gutenberg PR 41387 for more details.

• Expands the template types that can be added to the site editor to include single custom post type and specific posts templates.

See ​Gutenberg PR 41189 for more details.

• Adds fallback template content on creation in site editor:
  • Introduces get_template_hierarchy() to get the template hierarchy for a given template slug to be created.
  • Adds a lookup route to WP_REST_Templates_Controller to get the fallback template content.

See ​Gutenberg PR 42520 for more details.

• Fixes a typo in default category template's description within get_default_block_template_types().

See ​Gutenberg PR 42586 for more details.

• Changes field checks from in_array() to rest_is_field_included() in WP_REST_Post_Types_Controller.
• Adds an icon field to WP_REST_Post_Types_Controller

Follow-up to [53129], [52331], [52275], [52062], [51962], [43087].

Props ntsekouras, spacedmonkey, mamaduka, mburridge, jameskoster, bernhard-reiter, mcsf, hellofromTonya.
See #56467.

File:

• trunk/src/wp-includes/block-template-utils.php (modified) (6 diffs)

trunk/src/wp-includes/block-template-utils.php

@@ -148 +148 @@
         'category'       => array(
             'title'       => _x( 'Category', 'Template name' ),
-            'description' => __( 'Displays latest posts in single post category.' ),
+            'description' => __( 'Displays latest posts from a single post category.' ),
         ),
         'taxonomy'       => array(
@@ -556 +556 @@
     $has_theme_file = wp_get_theme()->get_stylesheet() === $theme && null !== $template_file;
 
-    $origin = get_post_meta( $post->ID, 'origin', true );
+    $origin           = get_post_meta( $post->ID, 'origin', true );
+    $is_wp_suggestion = get_post_meta( $post->ID, 'is_wp_suggestion', true );
 
     $template                 = new WP_Block_Template();
@@ -571 +572 @@
     $template->status         = $post->post_status;
     $template->has_theme_file = $has_theme_file;
-    $template->is_custom      = true;
+    $template->is_custom      = empty( $is_wp_suggestion );
     $template->author         = $post->post_author;
 
@@ -680 +681 @@
         }
 
-        if ( $post_type &&
+        if (
+            $post_type &&
             isset( $template->post_types ) &&
             ! in_array( $post_type, $template->post_types, true )
@@ -913 +915 @@
  */
 function wp_is_theme_directory_ignored( $path ) {
-    $directories_to_ignore = array( '.svn', '.git', '.hg', '.bzr', 'node_modules', 'vendor' );
+    $directories_to_ignore = array( '.DS_Store', '.svn', '.git', '.hg', '.bzr', 'node_modules', 'vendor' );
+
     foreach ( $directories_to_ignore as $directory ) {
-        if ( strpos( $path, $directory ) === 0 ) {
+        if ( str_starts_with( $path, $directory ) ) {
             return true;
         }
@@ -1024 +1027 @@
     return $filename;
 }
+
+/**
+ * Gets the template hierarchy for the given template slug to be created.
+ *
+ *
+ * Note: Always add `index` as the last fallback template.
+ *
+ * @since 6.1.0
+ *
+ * @param string  $slug           The template slug to be created.
+ * @param boolean $is_custom      Optional. Indicates if a template is custom or
+ *                                part of the template hierarchy. Default false.
+ * @param string $template_prefix Optional. The template prefix for the created template.
+ *                                Used to extract the main template type, e.g.
+ *                                in `taxonomy-books` the `taxonomy` is extracted.
+ *                                Default empty string.
+ * @return string[] The template hierarchy.
+ */
+function 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 ( $template_prefix ) {
+        list( $type ) = explode( '-', $template_prefix );
+        // These checks are needed because the `$slug` above is always added.
+        if ( ! in_array( $template_prefix, array( $slug, $type ), true ) ) {
+            $template_hierarchy[] = $template_prefix;
+        }
+        if ( $slug !== $type ) {
+            $template_hierarchy[] = $type;
+        }
+    }
+
+    // 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;
+};