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

Timestamp:

04/11/2022 10:36:02 AM (4 years ago)

Author:

gziolo

Message:

Editor: Add functionality required for theme export in the site editor

This bring across changes to theme export functionality, and related code, and tests. Relates issue in Gutenberg: ​https://github.com/WordPress/gutenberg/issues/39889.

Props scruffian, timothyblynjacobs, oandregal, ajlende, zieleadam.
See #55505.

File:

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

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

@@ -120 +120 @@
                 'home'           => array(
                         'title'       => _x( 'Home', 'Template name' ),
-                        'description' => __( 'Displays as the site\'s home page, or as the Posts page when a static home page isn\'t set.' ),
+                        'description' => __( 'Displays posts on the homepage, or on the Posts page if a static homepage is set.' ),
                 ),
                 'front-page'     => array(
                         'title'       => _x( 'Front Page', 'Template name' ),
-                        'description' => __( 'Displays as the site\'s home page.' ),
+                        'description' => __( 'Displays the homepage.' ),
                 ),
                 'singular'       => array(
@@ -163 +163 @@
                 ),
                 'attachment'     => array(
-                        'title'       => __( 'Attachment' ),
+                        'title'       => __( 'Media' ),
                         'description' => __( 'Displays individual media items or attachments.' ),
                 ),
                 'search'         => array(
                         'title'       => _x( 'Search', 'Template name' ),
-                        'description' => __( 'Template used to display search results.' ),
+                        'description' => __( 'Displays search results.' ),
                 ),
                 'privacy-policy' => array(
@@ -904 +904 @@
 
 /**
+ * Filters theme directories that should be ignored during export.
+ *
+ * @since 6.0.0
+ *
+ * @param string $path The path of the file in the theme.
+ * @return Bool Whether this file is in an ignored directory.
+ */
+function wp_is_theme_directory_ignored( $path ) {
+        $directories_to_ignore = array( '.svn', '.git', '.hg', '.bzr', 'node_modules', 'vendor' );
+        foreach ( $directories_to_ignore as $directory ) {
+                if ( strpos( $path, $directory ) === 0 ) {
+                        return true;
+                }
+        }
+
+        return false;
+}
+
+/**
  * Creates an export of the current templates and
  * template parts from the site editor at the
@@ -909 +928 @@
  *
  * @since 5.9.0
+ * @since 6.0.0 Adds the whole theme to the export archive.
  *
  * @return WP_Error|string Path of the ZIP file or error on failure.
@@ -917 +937 @@
         }
 
-        $obscura  = wp_generate_password( 12, false, false );
-        $filename = get_temp_dir() . 'edit-site-export-' . $obscura . '.zip';
+        $obscura    = wp_generate_password( 12, false, false );
+        $theme_name = wp_get_theme()->get( 'TextDomain' );
+        $filename   = get_temp_dir() . $theme_name . $obscura . '.zip';
 
         $zip = new ZipArchive();
-        if ( true !== $zip->open( $filename, ZipArchive::CREATE ) ) {
+        if ( true !== $zip->open( $filename, ZipArchive::CREATE | ZipArchive::OVERWRITE ) ) {
                 return new WP_Error( 'unable_to_create_zip', __( 'Unable to open export file (archive) for writing.' ) );
         }
 
-        $zip->addEmptyDir( 'theme' );
-        $zip->addEmptyDir( 'theme/templates' );
-        $zip->addEmptyDir( 'theme/parts' );
+        $zip->addEmptyDir( 'templates' );
+        $zip->addEmptyDir( 'parts' );
+
+        // Get path of the theme.
+        $theme_path = wp_normalize_path( get_stylesheet_directory() );
+
+        // Create recursive directory iterator.
+        $theme_files = new RecursiveIteratorIterator(
+                new RecursiveDirectoryIterator( $theme_path ),
+                RecursiveIteratorIterator::LEAVES_ONLY
+        );
+
+        // Make a copy of the current theme.
+        foreach ( $theme_files as $file ) {
+                // Skip directories as they are added automatically.
+                if ( ! $file->isDir() ) {
+                        // Get real and relative path for current file.
+                        $file_path     = wp_normalize_path( $file );
+                        $relative_path = substr( $file_path, strlen( $theme_path ) + 1 );
+
+                        if ( ! wp_is_theme_directory_ignored( $relative_path ) ) {
+                                $zip->addFile( $file_path, $relative_path );
+                        }
+                }
+        }
 
         // Load templates into the zip file.
@@ -935 +978 @@
 
                 $zip->addFromString(
-                        'theme/templates/' . $template->slug . '.html',
+                        'templates/' . $template->slug . '.html',
                         $template->content
                 );
@@ -944 +987 @@
         foreach ( $template_parts as $template_part ) {
                 $zip->addFromString(
-                        'theme/parts/' . $template_part->slug . '.html',
+                        'parts/' . $template_part->slug . '.html',
                         $template_part->content
                 );
         }
 
+        // Load theme.json into the zip file.
+        $tree = WP_Theme_JSON_Resolver::get_theme_data( array(), array( 'with_supports' => false ) );
+        // Merge with user data.
+        $tree->merge( WP_Theme_JSON_Resolver::get_user_data() );
+
+        $theme_json_raw = $tree->get_data();
+        // If a version is defined, add a schema.
+        if ( $theme_json_raw['version'] ) {
+                global $wp_version;
+                $theme_json_version = 'wp/' . substr( $wp_version, 0, 3 );
+                $schema         = array( '$schema' => 'https://schemas.wp.org/' . $theme_json_version . '/theme.json' );
+                $theme_json_raw = array_merge( $schema, $theme_json_raw );
+        }
+
+        // Convert to a string.
+        $theme_json_encoded = wp_json_encode( $theme_json_raw, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE );
+
+        // Replace 4 spaces with a tab.
+        $theme_json_tabbed = preg_replace( '~(?:^|\G)\h{4}~m', "\t", $theme_json_encoded );
+
+        // Add the theme.json file to the zip.
+        $zip->addFromString(
+                'theme.json',
+                $theme_json_tabbed
+        );
+
         // Save changes to the zip file.
         $zip->close();