Changeset 43285

Timestamp:

05/15/2018 08:32:01 PM (7 years ago)

Author:

azaozz

Message:

Privacy: Rename exports folder to avoid deleting other files.

Previously, personal data exports were stored in wp-content/uploads/exports, which is generic enough that it's likely there are existing folders with that name, either created by plugins or manually by administrators. If that folder were reused by Core, then wp_privacy_delete_old_export_files() would delete all of the existing files inside it, which is almost certainly not what the site owner wants or expects.

To avoid that, the folder is being renamed to include a specific reference to Core, and a more verbose description of its purpose. With those factored in, it's very unlikely that there will be any conflicts with existing folders.

The wp_privacy_exports_dir() and wp_privacy_exports_url() functions were introduced to provide a canonical source for the location, and the wp_privacy_exports_dir and wp_privacy_exports_url filters were introduced to allow plugins to customize it.

Props johnjamesjacoby, allendav.
Merges [43284] to the 4.9 branch.
Fixes #44091.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/file.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (2 diffs)

branches/4.9/src/wp-admin/includes/file.php

@@ -1887 +1887 @@
 
     // Create the exports folder if needed.
-    $upload_dir  = wp_upload_dir();
-    $exports_dir = trailingslashit( $upload_dir['basedir'] . '/exports' );
-    $exports_url = trailingslashit( $upload_dir['baseurl'] . '/exports' );
+    $exports_dir = wp_privacy_exports_dir();
+    $exports_url = wp_privacy_exports_url();
 
     $result = wp_mkdir_p( $exports_dir );

branches/4.9/src/wp-includes/functions.php

@@ -5938 +5938 @@
 
 /**
+ * Returns the directory used to store personal data export files.
+ *
+ * @since 4.9.6
+ *
+ * @see wp_privacy_exports_url
+ *
+ * @return string Exports directory.
+ */
+function wp_privacy_exports_dir() {
+    $upload_dir  = wp_upload_dir();
+    $exports_dir = trailingslashit( $upload_dir['basedir'] ) . 'wp-personal-data-exports/';
+
+    /**
+     * Filters the directory used to store personal data export files.
+     *
+     * @since 4.9.6
+     *
+     * @param string $exports_dir Exports directory.
+     */
+    return apply_filters( 'wp_privacy_exports_dir', $exports_dir );
+}
+
+/**
+ * Returns the URL of the directory used to store personal data export files.
+ *
+ * @since 4.9.6
+ *
+ * @see wp_privacy_exports_dir
+ *
+ * @return string Exports directory URL.
+ */
+function wp_privacy_exports_url() {
+    $upload_dir  = wp_upload_dir();
+    $exports_url = trailingslashit( $upload_dir['baseurl'] ) . 'wp-personal-data-exports/';
+
+    /**
+     * Filters the URL of the directory used to store personal data export files.
+     *
+     * @since 4.9.6
+     *
+     * @param string $exports_url Exports directory URL.
+     */
+    return apply_filters( 'wp_privacy_exports_url', $exports_url );
+}
+
+/**
  * Schedule a `WP_Cron` job to delete expired export files.
  *
@@ -5966 +6012 @@
     require_once( ABSPATH . 'wp-admin/includes/file.php' );
 
-    $upload_dir   = wp_upload_dir();
-    $exports_dir  = trailingslashit( $upload_dir['basedir'] . '/exports' );
+    $exports_dir  = wp_privacy_exports_dir();
     $export_files = list_files( $exports_dir, 100, array( 'index.html' ) );