wp_add_privacy_policy_content() WordPress Function
The wp_add_privacy_policy_content() function allows you to add content to the default WordPress privacy policy. This is useful if you have additional privacy information that you need to include in your policy.
wp_add_privacy_policy_content( string $plugin_name, string $policy_text ) #
Declares a helper function for adding content to the Privacy Policy Guide.
Description
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 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/.
The HTML contents of the $policy_text supports use of a specialized .privacy-policy-tutorial CSS class which can be used to provide supplemental information. Any content contained within HTML elements that have the .privacy-policy-tutorial CSS class applied will be omitted from the clipboard when the section content is copied.
Intended for use with the 'admin_init' action.
Parameters
- $plugin_name
(string)(Required)The name of the plugin or theme that is suggesting content for the site's privacy policy.
- $policy_text
(string)(Required)The suggested content for inclusion in the policy.
Source
File: wp-admin/includes/plugin.php
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/class-wp-privacy-policy-content.php';
}
WP_Privacy_Policy_Content::add( $plugin_name, $policy_text );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.9.6 | Introduced. |