WordPress.org

Make WordPress Core

Changeset 43003


Ignore:
Timestamp:
04/25/2018 06:10:00 PM (20 months ago)
Author:
azaozz
Message:

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

See #43620.

Location:
trunk/src/wp-admin/includes
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/misc.php

    r42999 r43003  
    12821282
    12831283    /**
    1284      * Add privacy information to the postbox shown when editing the privacy policy.
     1284     * Add content to the postbox shown when editing the privacy policy.
     1285     *
     1286     * Plugins and themes should suggest text for inclusion in the site's privacy policy.
     1287     * The suggested text should contain information about any functionality that affects user privacy,
     1288     * and will be shown in the Suggested Privacy Policy Content postbox.
    12851289     *
    12861290     * Intended for use from `wp_add_privacy_policy_content()`.
    12871291     *
    1288      * $since 5.0.0
    1289      *
    1290      * @param string $plugin_name The plugin'as name. Will be shown in the privacy policy metabox.
    1291      * @param string $policy_text The content that should appear in the site's privacy policy.
     1292     * $since 4.9.6
     1293     *
     1294     * @param string $plugin_name The name of the plugin or theme that is suggesting content for the site's privacy policy.
     1295     * @param string $policy_text The suggested content for inclusion in the policy.
    12921296     */
    12931297    public static function add( $plugin_name, $policy_text ) {
  • trunk/src/wp-admin/includes/plugin.php

    r42980 r43003  
    20172017
    20182018/**
    2019  * Helper function for adding plugin specific information to the postbox shown when editing the privacy policy.
     2019 * Helper function for adding content to the postbox shown when editing the privacy policy.
     2020 *
     2021 * Plugins and themes should suggest text for inclusion in the site's privacy policy.
     2022 * The suggested text should contain information about any functionality that affects user privacy,
     2023 * and will be shown in the Suggested Privacy Policy Content postbox.
     2024 *
     2025 * A plugin or theme can use this function multiple times as long as it will help to better present
     2026 * the suggested policy content. For example modular plugins such as WooCommerse or Jetpack
     2027 * can add or remove suggested content depending on the modules/extensions that are enabled.
    20202028 *
    20212029 * Intended for use with the `'admin_init'` action.
     
    20232031 * @since 4.9.6
    20242032 *
    2025  * @param string $plugin_name The plugin'as name. Will be shown in the privacy policy metabox.
    2026  * @param string $policy_text The content that should appear in the site's privacy policy.
     2033 * @param string $plugin_name The name of the plugin or theme that is suggesting content for the site's privacy policy.
     2034 * @param string $policy_text The suggested content for inclusion in the policy.
    20272035 *                            For more information see the Plugins Handbook https://developer.wordpress.org/plugins/.
    20282036 */
Note: See TracChangeset for help on using the changeset viewer.