W3cubDocs

/WordPress

WP_Privacy_Policy_Content::notice( WP_Post|null $post = null )

Add a notice with a link to the guide when editing the privacy policy page.

Parameters

$post

(WP_Post|null) (Optional) The currently edited post.

Default value: null

Source

File: wp-admin/includes/class-wp-privacy-policy-content.php 

public static function notice( $post = null ) {
		if ( is_null( $post ) ) {
			global $post;
		} else {
			$post = get_post( $post );
		}

		if ( ! ( $post instanceof WP_Post ) ) {
			return;
		}

		if ( ! current_user_can( 'manage_privacy_options' ) ) {
			return;
		}

		$current_screen = get_current_screen();
		$policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' );

		if ( 'post' !== $current_screen->base || $policy_page_id !== $post->ID ) {
			return;
		}

		$message = __( 'Need help putting together your new Privacy Policy page? Check out our guide for recommendations on what content to include, along with policies suggested by your plugins and theme.' );
		$url     = esc_url( admin_url( 'privacy-policy-guide.php' ) );
		$label   = __( 'View Privacy Policy Guide.' );

		if ( get_current_screen()->is_block_editor() ) {
			wp_enqueue_script( 'wp-notices' );
			$action = array(
				'url'   => $url,
				'label' => $label,
			);
			wp_add_inline_script(
				'wp-notices',
				sprintf(
					'wp.data.dispatch( "core/notices" ).createWarningNotice( "%s", { actions: [ %s ], isDismissible: false } )',
					$message,
					wp_json_encode( $action )
				),
				'after'
			);
		} else {
			?>
			<div class="notice notice-warning inline wp-pp-notice">
				<p>
				<?php
				echo $message;
				printf(
					' <a href="%s" target="_blank">%s <span class="screen-reader-text">%s</span></a>',
					$url,
					$label,
					/* translators: Accessibility text. */
					__( '(opens in a new tab)' )
				);
				?>
				</p>
			</div>
			<?php
		}
	}

Uses

Uses Description
wp-admin/includes/class-wp-screen.php: WP_Screen::is_block_editor()

Sets or returns whether the block editor is loading on the current screen.
wp-includes/functions.wp-scripts.php: wp_add_inline_script()

Adds extra code to a registered script.
wp-includes/functions.php: wp_json_encode()

Encode a variable into JSON, with some sanity checks.
wp-admin/includes/screen.php: get_current_screen()

Get the current screen object
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
wp-includes/functions.wp-scripts.php: wp_enqueue_script()

Enqueue a script.
wp-includes/link-template.php: admin_url()

Retrieves the URL to the admin area for the current site.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.

Changelog

Version Description
5.0.0 The $post parameter was made optional.
4.9.6 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_privacy_policy_content/notice