Changeset 43364

Timestamp:

06/16/2018 01:11:57 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Make sure wp_add_privacy_policy_content() does not cause a fatal error by unintentionally flushing rewrite rules outside of the admin context.

Add a _doing_it_wrong() message describing the correct usage of the function.

Props kraftbj, azaozz, SergeyBiryukov, YuriV.
Merges [43361], [43362], [43363] to the 4.9 branch.
Fixes #44142.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/misc.php (modified) (4 diffs)
• src/wp-admin/includes/plugin.php (modified) (2 diffs)

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

@@ -195 +195 @@
  *
  * @global WP_Rewrite $wp_rewrite
+ *
+ * @return bool|null True on write success, false on failure. Null in multisite.
  */
 function save_mod_rewrite_rules() {
@@ -202 +204 @@
     global $wp_rewrite;
 
-    $home_path = get_home_path();
-    $htaccess_file = $home_path.'.htaccess';
+    // Ensure get_home_path() is declared.
+    require_once( ABSPATH . 'wp-admin/includes/file.php' );
+
+    $home_path     = get_home_path();
+    $htaccess_file = $home_path . '.htaccess';
 
     /*
@@ -227 +232 @@
  * @global WP_Rewrite $wp_rewrite
  *
- * @return bool True if web.config was updated successfully
+ * @return bool|null True on write success, false on failure. Null in multisite.
  */
 function iis7_save_url_rewrite_rules(){
@@ -235 +240 @@
     global $wp_rewrite;
 
-    $home_path = get_home_path();
+    // Ensure get_home_path() is declared.
+    require_once( ABSPATH . 'wp-admin/includes/file.php' );
+
+    $home_path       = get_home_path();
     $web_config_file = $home_path . 'web.config';
 

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

@@ -1899 +1899 @@
 
 /**
- * Helper function for adding content to the postbox shown when editing the privacy policy.
+ * Helper function for adding content to the Privacy Policy Guide.
  *
  * Plugins and themes should suggest text for inclusion in the site's privacy policy.
  * The suggested text should contain information about any functionality that affects user privacy,
- * and will be shown in the Suggested Privacy Policy Content postbox.
+ * and will be shown on the Privacy Policy Guide screen.
  *
  * A plugin or theme can use this function multiple times as long as it will help to better present
  * the suggested policy content. For example modular plugins such as WooCommerse or Jetpack
  * can add or remove suggested content depending on the modules/extensions that are enabled.
+ * For more information see the Plugin Handbook:
+ * https://developer.wordpress.org/plugins/privacy/suggesting-text-for-the-site-privacy-policy/.
  *
  * Intended for use with the `'admin_init'` action.
@@ -1915 +1917 @@
  * @param string $plugin_name The name of the plugin or theme that is suggesting content for the site's privacy policy.
  * @param string $policy_text The suggested content for inclusion in the policy.
- *                            For more information see the Plugins Handbook https://developer.wordpress.org/plugins/. 
  */
 function wp_add_privacy_policy_content( $plugin_name, $policy_text ) {
+    if ( ! is_admin() ) {
+        _doing_it_wrong(
+            __FUNCTION__,
+            sprintf(
+                /* translators: %s: admin_init */
+                __( 'The suggested privacy policy content should be added only in wp-admin by using the %s (or later) action.' ),
+                '<code>admin_init</code>'
+            ),
+            '4.9.7'
+        );
+        return;
+    } elseif ( ! doing_action( 'admin_init' ) && ! did_action( 'admin_init' ) ) {
+        _doing_it_wrong(
+            __FUNCTION__,
+            sprintf(
+                /* translators: %s: admin_init */
+                __( 'The suggested privacy policy content should be added by using the %s (or later) action. Please see the inline documentation.' ),
+                '<code>admin_init</code>'
+            ),
+            '4.9.7'
+        );
+        return;
+    }
+
     if ( ! class_exists( 'WP_Privacy_Policy_Content' ) ) {
         require_once( ABSPATH . 'wp-admin/includes/misc.php' );