WordPress.org

Make WordPress Core

Changeset 43115


Ignore:
Timestamp:
05/02/2018 03:56:03 AM (19 months 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:
3 edited

Legend:

Unmodified
Added
Removed
  • branches/4.9

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

    r43114 r43115  
    12331233
    12341234    /**
    1235      * Add privacy information to the postbox shown when editing the privacy policy.
     1235     * Add content to the postbox shown when editing the privacy policy.
     1236     *
     1237     * Plugins and themes should suggest text for inclusion in the site's privacy policy.
     1238     * The suggested text should contain information about any functionality that affects user privacy,
     1239     * and will be shown in the Suggested Privacy Policy Content postbox.
    12361240     *
    12371241     * Intended for use from `wp_add_privacy_policy_content()`.
    12381242     *
    1239      * $since 5.0.0
    1240      *
    1241      * @param string $plugin_name The plugin'as name. Will be shown in the privacy policy metabox.
    1242      * @param string $policy_text The content that should appear in the site's privacy policy.
     1243     * $since 4.9.6
     1244     *
     1245     * @param string $plugin_name The name of the plugin or theme that is suggesting content for the site's privacy policy.
     1246     * @param string $policy_text The suggested content for inclusion in the policy.
    12431247     */
    12441248    public static function add( $plugin_name, $policy_text ) {
  • branches/4.9/src/wp-admin/includes/plugin.php

    r43101 r43115  
    18991899
    19001900/**
    1901  * Helper function for adding plugin specific information to the postbox shown when editing the privacy policy.
     1901 * Helper function for adding content to the postbox shown when editing the privacy policy.
     1902 *
     1903 * Plugins and themes should suggest text for inclusion in the site's privacy policy.
     1904 * The suggested text should contain information about any functionality that affects user privacy,
     1905 * and will be shown in the Suggested Privacy Policy Content postbox.
     1906 *
     1907 * A plugin or theme can use this function multiple times as long as it will help to better present
     1908 * the suggested policy content. For example modular plugins such as WooCommerse or Jetpack
     1909 * can add or remove suggested content depending on the modules/extensions that are enabled.
    19021910 *
    19031911 * Intended for use with the `'admin_init'` action.
     
    19051913 * @since 4.9.6
    19061914 *
    1907  * @param string $plugin_name The plugin'as name. Will be shown in the privacy policy metabox.
    1908  * @param string $policy_text The content that should appear in the site's privacy policy.
     1915 * @param string $plugin_name The name of the plugin or theme that is suggesting content for the site's privacy policy.
     1916 * @param string $policy_text The suggested content for inclusion in the policy.
    19091917 *                            For more information see the Plugins Handbook https://developer.wordpress.org/plugins/.
    19101918 */
Note: See TracChangeset for help on using the changeset viewer.