Changeset 53087 for trunk/src/wp-includes/general-template.php

Timestamp:

04/06/2022 03:31:23 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Adjust DocBlock formatting for wp_robots_*() and related functions.

This ensures the code blocks are displayed correctly in the WordPress Code Reference.

Follow-up to [19304], [37541], [44021], [49992].

See #54729.

File:

• trunk/src/wp-includes/general-template.php (modified) (1 diff)

trunk/src/wp-includes/general-template.php

@@ -3225 +3225 @@
 
 /**
- * Displays a referrer strict-origin-when-cross-origin meta tag.
- *
- * Outputs a referrer origin-when-cross-origin meta tag that tells the browser not to send the full
- * url as a referrer to other sites when cross-origin assets are loaded.
- *
- * Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_strict_cross_origin_referrer' );
+ * Displays a referrer `strict-origin-when-cross-origin` meta tag.
+ *
+ * Outputs a referrer `strict-origin-when-cross-origin` meta tag that tells the browser not to send
+ * the full URL as a referrer to other sites when cross-origin assets are loaded.
+ *
+ * Typical usage is as a {@see 'wp_head'} callback:
+ *
+ *     add_action( 'wp_head', 'wp_strict_cross_origin_referrer' );
  *
  * @since 5.7.0