Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-23 01:27:36 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
See #43620.
Built from https://develop.svn.wordpress.org/trunk@43003


git-svn-id: http://core.svn.wordpress.org/trunk@42832 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Andrew Ozz 2018-04-25 18:10:21 +00:00
parent c9c3c61a53
commit 41a82d6078
3 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
wp-admin/includes/misc.php
View File

@ -1281,14 +1281,18 @@ final class WP_Privacy_Policy_Content {
private function __construct() {}
/**
* 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
* $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.
*/
public static function add( $plugin_name, $policy_text ) {
if ( empty( $plugin_name ) || empty( $policy_text ) ) {

14
wp-admin/includes/plugin.php
View File

@ -2016,14 +2016,22 @@ function plugin_sandbox_scrape( $plugin ) {
}
/**
* 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.
*
* @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/.
*/
function wp_add_privacy_policy_content( $plugin_name, $policy_text ) {

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.0-alpha-43002';
$wp_version = '5.0-alpha-43003';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.