WP_Privacy_Policy_Content::get_default_content( bool $description = false, bool $blocks = true ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$descriptionbooloptional

Whether to include the descriptions under the section headings. Default false.Default: false

$blocksbooloptional

Whether to format the content for the block editor. Default true.Default: true

Return value

string

The default policy content.

Performance profile

How much work a call to WP_Privacy_Policy_Content::get_default_content() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

211–341

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 505.

Plugin surface

1 hook

Third-party callbacks on 'wp_get_default_privacy_policy_content' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters_deprecated()called directly
• optionoption read or writeget_option()one call below WP_Privacy_Policy_Content::get_default_content()

Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 18 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Privacy_Policy_Content::get_default_content() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while WP_Privacy_Policy_Content::get_default_content() runs, in this order:

1. 1
   do_action( wp_get_default_privacy_policy_content )filter_deprecatedline 689 (+231 into the body)

   Filters the default content suggested for inclusion in a privacy policy.

Uses · 4

• __()Retrieves the translation of $text.
• get_bloginfo()Retrieves information about the current site.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• apply_filters_deprecated()Fires functions attached to a deprecated filter hook.

Used by · 2

• WP_Privacy_Policy_Content::add_suggested_content()Adds the suggested privacy policy text to the policy postbox.
• wp_install_defaults()Creates the initial content for a newly-installed site.

Source code

View on Trac ↗View on GitHub ↗

458	public static function get_default_content( $description = false, $blocks = true ) {459		$suggested_text = '<strong class="privacy-policy-tutorial">' . __( 'Suggested text:' ) . ' </strong>';460		$content        = '';461		$strings        = array();462 463		// Start of the suggested privacy policy text.464		if ( $description ) {465			$strings[] = '<div class="wp-suggested-text">';466		}467 468		/* translators: Default privacy policy heading. */469		$strings[] = '<h2 class="wp-block-heading">' . __( 'Who we are' ) . '</h2>';470 471		if ( $description ) {472			/* translators: Privacy policy tutorial. */473			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'In this section you should note your site URL, as well as the name of the company, organization, or individual behind it, and some accurate contact information.' ) . '</p>';474			/* translators: Privacy policy tutorial. */475			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'The amount of information you may be required to show will vary depending on your local or national business regulations. You may, for example, be required to display a physical address, a registered address, or your company registration number.' ) . '</p>';476		} else {477			/* translators: Default privacy policy text. %s: Site URL. */478			$strings[] = '<p>' . $suggested_text . sprintf( __( 'Our website address is: %s.' ), get_bloginfo( 'url', 'display' ) ) . '</p>';479		}480 481		if ( $description ) {482			/* translators: Default privacy policy heading. */483			$strings[] = '<h2>' . __( 'What personal data we collect and why we collect it' ) . '</h2>';484			/* translators: Privacy policy tutorial. */485			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'In this section you should note what personal data you collect from users and site visitors. This may include personal data, such as name, email address, personal account preferences; transactional data, such as purchase information; and technical data, such as information about cookies.' ) . '</p>';486			/* translators: Privacy policy tutorial. */487			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'You should also note any collection and retention of sensitive personal data, such as data concerning health.' ) . '</p>';488			/* translators: Privacy policy tutorial. */489			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'In addition to listing what personal data you collect, you need to note why you collect it. These explanations must note either the legal basis for your data collection and retention or the active consent the user has given.' ) . '</p>';490			/* translators: Privacy policy tutorial. */491			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'Personal data is not just created by a user&#8217;s interactions with your site. Personal data is also generated from technical processes such as contact forms, comments, cookies, analytics, and third party embeds.' ) . '</p>';492			/* translators: Privacy policy tutorial. */493			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'By default WordPress does not collect any personal data about visitors, and only collects the data shown on the User Profile screen from registered users. However some of your plugins may collect personal data. You should add the relevant information below.' ) . '</p>';494		}495 496		/* translators: Default privacy policy heading. */497		$strings[] = '<h2 class="wp-block-heading">' . __( 'Comments' ) . '</h2>';498 499		if ( $description ) {500			/* translators: Privacy policy tutorial. */501			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should note what information is captured through comments. We have noted the data which WordPress collects by default.' ) . '</p>';502		} else {503			/* translators: Default privacy policy text. */504			$strings[] = '<p>' . $suggested_text . __( 'When visitors leave comments on the site we collect the data shown in the comments form, and also the visitor&#8217;s IP address and browser user agent string to help spam detection.' ) . '</p>';505			/* translators: Default privacy policy text. */506			$strings[] = '<p>' . __( 'An anonymized string created from your email address (also called a hash) may be provided to the Gravatar service to see if you are using it. The Gravatar service privacy policy is available here: https://automattic.com/privacy/. After approval of your comment, your profile picture is visible to the public in the context of your comment.' ) . '</p>';507		}508 509		/* translators: Default privacy policy heading. */510		$strings[] = '<h2 class="wp-block-heading">' . __( 'Media' ) . '</h2>';511 512		if ( $description ) {513			/* translators: Privacy policy tutorial. */514			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should note what information may be disclosed by users who can upload media files. All uploaded files are usually publicly accessible.' ) . '</p>';515		} else {516			/* translators: Default privacy policy text. */517			$strings[] = '<p>' . $suggested_text . __( 'If you upload images to the website, you should avoid uploading images with embedded location data (EXIF GPS) included. Visitors to the website can download and extract any location data from images on the website.' ) . '</p>';518		}519 520		if ( $description ) {521			/* translators: Default privacy policy heading. */522			$strings[] = '<h2>' . __( 'Contact forms' ) . '</h2>';523			/* translators: Privacy policy tutorial. */524			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'By default, WordPress does not include a contact form. If you use a contact form plugin, use this subsection to note what personal data is captured when someone submits a contact form, and how long you keep it. For example, you may note that you keep contact form submissions for a certain period for customer service purposes, but you do not use the information submitted through them for marketing purposes.' ) . '</p>';525		}526 527		/* translators: Default privacy policy heading. */528		$strings[] = '<h2 class="wp-block-heading">' . __( 'Cookies' ) . '</h2>';529 530		if ( $description ) {531			/* translators: Privacy policy tutorial. */532			$strings[] = '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should list the cookies your website uses, including those set by your plugins, social media, and analytics. We have provided the cookies which WordPress installs by default.' ) . '</p>';533		} else {534			/* translators: Default privacy policy text. */535			$strings[] = '<p>' . $suggested_text . __( 'If you leave a comment on our site you may opt-in to saving your name, email address and website in cookies. These are for your convenience so that you do not have to fill in your details again when you leave another comment. These cookies will last for one year.' ) . '</p>';536			/* translators: Default privacy policy text. */537			$strings[] = '<p>' . __( 'If you visit our login page, we will set a temporary cookie to determine if your browser accepts cookies. This cookie contains no personal data and is discarded when you close your browser.' ) . '</p>';

Changelog

Introduced in 4.9.6. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/class-wp-privacy-policy-content.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.