Changeset 43115

Timestamp:

05/02/2018 03:56:03 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Privacy: add better docs for wp_add_privacy_policy_content() and WP_Privacy_Policy_Content::add().

Props azaozz.
Merges [43003] to the 4.9 branch.
See #43620.

Location:

branches/4.9

Files:

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

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

@@ -1233 +1233 @@
 
     /**
-     * Add privacy information to the postbox shown when editing the privacy policy.
+     * Add content to the postbox shown when editing the privacy policy.
+     *
+     * 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.
      *
      * Intended for use from `wp_add_privacy_policy_content()`.
      *
-     * $since 5.0.0
-     *
-     * @param string $plugin_name The plugin'as name. Will be shown in the privacy policy metabox.
-     * @param string $policy_text The content that should appear in the site's privacy policy.
+     * $since 4.9.6
+     *
+     * @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.
      */
     public static function add( $plugin_name, $policy_text ) {

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

@@ -1899 +1899 @@
 
 /**
- * Helper function for adding plugin specific information to the postbox shown when editing the privacy policy.
+ * Helper function for adding content to the postbox shown when editing the privacy policy.
+ *
+ * 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.
+ *
+ * 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.
  *
  * Intended for use with the `'admin_init'` action.
@@ -1905 +1913 @@
  * @since 4.9.6
  *
- * @param string $plugin_name The plugin'as name. Will be shown in the privacy policy metabox.
- * @param string $policy_text The content that should appear in the site's privacy policy.
+ * @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/. 
  */