WordPress.org
Get WordPress

Make WordPress Core

Changeset 53087


Ignore:
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.

Location:
trunk/src/wp-includes
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/deprecated.php

    r53086 r53087  
    41264126
    41274127/**
    4128  * Displays a noindex meta tag if required by the blog configuration.
    4129  *
    4130  * If a blog is marked as not being public then the noindex meta tag will be
    4131  * output to tell web robots not to index the page content. Add this to the
    4132  * {@see 'wp_head'} action.
     4128 * Displays a `noindex` meta tag if required by the blog configuration.
     4129 *
     4130 * If a blog is marked as not being public then the `noindex` meta tag will be
     4131 * output to tell web robots not to index the page content.
    41334132 *
    41344133 * Typical usage is as a {@see 'wp_head'} callback:
    … …  
    41514150
    41524151/**
    4153  * Display a noindex meta tag.
    4154  *
    4155  * Outputs a noindex meta tag that tells web robots not to index the page content.
    4156  * Typical usage is as a {@see 'wp_head'} callback. add_action( 'wp_head', 'wp_no_robots' );
     4152 * Display a `noindex` meta tag.
     4153 *
     4154 * Outputs a `noindex` meta tag that tells web robots not to index the page content.
     4155 *
     4156 * Typical usage is as a {@see 'wp_head'} callback:
     4157 *
     4158 *     add_action( 'wp_head', 'wp_no_robots' );
    41574159 *
    41584160 * @since 3.3.0
    4159  * @since 5.3.0 Echo "noindex,nofollow" if search engine visibility is discouraged.
     4161 * @since 5.3.0 Echo `noindex,nofollow` if search engine visibility is discouraged.
    41604162 * @deprecated 5.7.0 Use wp_robots_no_robots() instead on 'wp_robots' filter.
    41614163 */
    … …  
    41724174
    41734175/**
    4174  * Display a noindex,noarchive meta tag and referrer origin-when-cross-origin meta tag.
    4175  *
    4176  * Outputs a noindex,noarchive meta tag that tells web robots not to index or cache the page content.
    4177  * Outputs a referrer origin-when-cross-origin meta tag that tells the browser not to send the full
    4178  * url as a referrer to other sites when cross-origin assets are loaded.
    4179  *
    4180  * Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_sensitive_page_meta' );
     4176 * Display a `noindex,noarchive` meta tag and referrer `strict-origin-when-cross-origin` meta tag.
     4177 *
     4178 * Outputs a `noindex,noarchive` meta tag that tells web robots not to index or cache the page content.
     4179 * Outputs a referrer `strict-origin-when-cross-origin` meta tag that tells the browser not to send
     4180 * the full URL as a referrer to other sites when cross-origin assets are loaded.
     4181 *
     4182 * Typical usage is as a {@see 'wp_head'} callback:
     4183 *
     4184 *     add_action( 'wp_head', 'wp_sensitive_page_meta' );
    41814185 *
    41824186 * @since 5.0.1

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

    r53041 r53087  
    32253225
    32263226/**
    3227  * Displays a referrer strict-origin-when-cross-origin meta tag.
    3228  *
    3229  * Outputs a referrer origin-when-cross-origin meta tag that tells the browser not to send the full
    3230  * url as a referrer to other sites when cross-origin assets are loaded.
    3231  *
    3232  * Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_strict_cross_origin_referrer' );
     3227 * Displays a referrer `strict-origin-when-cross-origin` meta tag.
     3228 *
     3229 * Outputs a referrer `strict-origin-when-cross-origin` meta tag that tells the browser not to send
     3230 * the full URL as a referrer to other sites when cross-origin assets are loaded.
     3231 *
     3232 * Typical usage is as a {@see 'wp_head'} callback:
     3233 *
     3234 *     add_action( 'wp_head', 'wp_strict_cross_origin_referrer' );
    32333235 *
    32343236 * @since 5.7.0

  • trunk/src/wp-includes/robots-template.php

    r50566 r53087  
    5151
    5252/**
    53  * Adds noindex to the robots meta tag if required by the site configuration.
     53 * Adds `noindex` to the robots meta tag if required by the site configuration.
    5454 *
    5555 * If a blog is marked as not being public then noindex will be output to
    … …  
    7777
    7878/**
    79  * Adds noindex to the robots meta tag for embeds.
     79 * Adds `noindex` to the robots meta tag for embeds.
    8080 *
    8181 * Typical usage is as a {@see 'wp_robots'} callback:
    … …  
    9999
    100100/**
    101  * Adds noindex to the robots meta tag if a search is being performed.
     101 * Adds `noindex` to the robots meta tag if a search is being performed.
    102102 *
    103103 * If a search is being performed then noindex will be output to
    … …  
    125125
    126126/**
    127  * Adds noindex to the robots meta tag.
     127 * Adds `noindex` to the robots meta tag.
    128128 *
    129129 * This directive tells web robots not to index the page content.
    … …  
    151151
    152152/**
    153  * Adds noindex and noarchive to the robots meta tag.
     153 * Adds `noindex` and `noarchive` to the robots meta tag.
    154154 *
    155155 * This directive tells web robots not to index or archive the page content and
    … …  
    172172
    173173/**
    174  * Adds 'max-image-preview:large' to the robots meta tag.
     174 * Adds `max-image-preview:large` to the robots meta tag.
    175175 *
    176176 * This directive tells web robots that large image previews are allowed to be
Note: See TracChangeset for help on using the changeset viewer.