Changeset 33849

Timestamp:

09/02/2015 11:28:11 AM (9 years ago)

Author:

johnbillion

Message:

Introduce wp_removable_query_args(), which returns an array of single-use query variables which can be removed from a URL.

Also applies the function to the return URL when the Customizer is closed.

Fixes #32692
Props swissspidy, Mte90

Location:

trunk/src

Files:

• wp-admin/customize.php (modified) (1 diff)
• wp-admin/includes/misc.php (modified) (1 diff)
• wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-admin/customize.php

@@ -22 +22 @@
 if ( $return ) {
     $return = wp_unslash( $return );
+    $return = remove_query_arg( wp_removable_query_args(), $return );
     $return = wp_validate_redirect( $return );
 }

trunk/src/wp-admin/includes/misc.php

@@ -866 +866 @@
  */
 function wp_admin_canonical_url() {
-    $removable_query_args = array(
-        'message', 'settings-updated', 'saved',
-        'update', 'updated', 'activated',
-        'activate', 'deactivate', 'locked',
-        'deleted', 'trashed', 'untrashed',
-        'enabled', 'disabled', 'skipped',
-        'spammed', 'unspammed',
-        'error',
-    );
-
-    /**
-     * Filter the list of URL parameters to remove.
-     *
-     * @since 4.2.0
-     *
-     * @param array $removable_query_args An array of parameters to remove from the URL.
-     */
-    $removable_query_args = apply_filters( 'removable_query_args', $removable_query_args );
+    $removable_query_args = wp_removable_query_args();
 
     if ( empty( $removable_query_args ) ) {

trunk/src/wp-includes/functions.php

@@ -823 +823 @@
     }
     return add_query_arg( $key, false, $query );
+}
+
+/**
+ * Returns an array of single-use query variable names that can be removed from a URL.
+ *
+ * @since 4.4.0
+ *
+ * @return array An array of parameters to remove from the URL.
+ */
+function wp_removable_query_args() {
+    $removable_query_args = array(
+        'activate',
+        'activated',
+        'approved',
+        'deactivate',
+        'deleted',
+        'disabled',
+        'enabled',
+        'error',
+        'locked',
+        'message',
+        'same',
+        'saved',
+        'settings-updated',
+        'skipped',
+        'spammed',
+        'trashed',
+        'unspammed',
+        'untrashed',
+        'update',
+        'updated',
+    );
+
+    /**
+     * Filter the list of query variables to remove.
+     *
+     * @since 4.2.0
+     *
+     * @param array $removable_query_args An array of query variables to remove from a URL.
+     */
+    return apply_filters( 'removable_query_args', $removable_query_args );
 }