Changeset 53087 for trunk/src/wp-includes/deprecated.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/deprecated.php (modified) (3 diffs)

trunk/src/wp-includes/deprecated.php

@@ -4126 +4126 @@
 
 /**
- * Displays a noindex meta tag if required by the blog configuration.
- *
- * If a blog is marked as not being public then the noindex meta tag will be
- * output to tell web robots not to index the page content. Add this to the
- * {@see 'wp_head'} action.
+ * Displays a `noindex` meta tag if required by the blog configuration.
+ *
+ * If a blog is marked as not being public then the `noindex` meta tag will be
+ * output to tell web robots not to index the page content.
  *
  * Typical usage is as a {@see 'wp_head'} callback:
@@ -4151 +4150 @@
 
 /**
- * Display a noindex meta tag.
- *
- * Outputs a noindex meta tag that tells web robots not to index the page content.
- * Typical usage is as a {@see 'wp_head'} callback. add_action( 'wp_head', 'wp_no_robots' );
+ * Display a `noindex` meta tag.
+ *
+ * Outputs a `noindex` meta tag that tells web robots not to index the page content.
+ *
+ * Typical usage is as a {@see 'wp_head'} callback:
+ *
+ *     add_action( 'wp_head', 'wp_no_robots' );
  *
  * @since 3.3.0
- * @since 5.3.0 Echo "noindex,nofollow" if search engine visibility is discouraged.
+ * @since 5.3.0 Echo `noindex,nofollow` if search engine visibility is discouraged.
  * @deprecated 5.7.0 Use wp_robots_no_robots() instead on 'wp_robots' filter.
  */
@@ -4172 +4174 @@
 
 /**
- * Display a noindex,noarchive meta tag and referrer origin-when-cross-origin meta tag.
- *
- * Outputs a noindex,noarchive meta tag that tells web robots not to index or cache the page content.
- * 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_sensitive_page_meta' );
+ * Display a `noindex,noarchive` meta tag and referrer `strict-origin-when-cross-origin` meta tag.
+ *
+ * Outputs a `noindex,noarchive` meta tag that tells web robots not to index or cache the page content.
+ * 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_sensitive_page_meta' );
  *
  * @since 5.0.1