vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 22:30:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

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

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

See #54729.

git-svn-id: https://develop.svn.wordpress.org/trunk@53087 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2022-04-06 15:31:23 +00:00
parent 6620cef12d
commit 342cd8ca52
3 changed files with 29 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/wp-includes/deprecated.php
View File

@@ -4125,11 +4125,10 @@ function addslashes_strings_only( $value ) {
}
/**
* Displays a noindex meta tag if required by the blog configuration.
* 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.
* 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:
*
@@ -4150,13 +4149,16 @@ function noindex() {
}
/**
* Display a noindex meta tag.
* 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' );
* 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.
*/
function wp_no_robots() {
@@ -4171,13 +4173,15 @@ function wp_no_robots() {
}
/**
* Display a noindex,noarchive meta tag and referrer origin-when-cross-origin meta tag.
* 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 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.
* 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 wp_head callback. add_action( 'wp_head', 'wp_sensitive_page_meta' );
* Typical usage is as a {@see 'wp_head'} callback:
*
* add_action( 'wp_head', 'wp_sensitive_page_meta' );
*
* @since 5.0.1
* @deprecated 5.7.0 Use wp_robots_sensitive_page() instead on 'wp_robots' filter