Make WordPress Core


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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 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.