Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-20 19:41:28 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Use third-person singular verbs for function descriptions in the Feed API, as per docblock standards.

Browse Source 
See #55646.

Built from https://develop.svn.wordpress.org/trunk@53539


git-svn-id: http://core.svn.wordpress.org/trunk@53128 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2022-06-20 21:46:16 +00:00
parent 30836ec0bd
commit fa3ed002e1
2 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
wp-includes/feed.php
View File

@ -11,7 +11,7 @@
*/ */
/** /**
* RSS container for the bloginfo function. * Retrieves RSS container for the bloginfo function.
* *
* You can retrieve anything that you can using the get_bloginfo() function. * You can retrieve anything that you can using the get_bloginfo() function.
* Everything will be stripped of tags and characters converted, when the values * Everything will be stripped of tags and characters converted, when the values
@ -41,7 +41,7 @@ function get_bloginfo_rss( $show = '' ) {
} }
/** /**
* Display RSS container for the bloginfo function. * Displays RSS container for the bloginfo function.
* *
* You can retrieve anything that you can using the get_bloginfo() function. * You can retrieve anything that you can using the get_bloginfo() function.
* Everything will be stripped of tags and characters converted, when the values * Everything will be stripped of tags and characters converted, when the values
@ -68,7 +68,7 @@ function bloginfo_rss( $show = '' ) {
} }
/** /**
* Retrieve the default feed. * Retrieves the default feed.
* *
* The default feed is 'rss2', unless a plugin changes it through the * The default feed is 'rss2', unless a plugin changes it through the
* {@see 'default_feed'} filter. * {@see 'default_feed'} filter.
@ -92,12 +92,12 @@ function get_default_feed() {
} }
/** /**
* Retrieve the blog title for the feed title. * Retrieves the blog title for the feed title.
* *
* @since 2.2.0 * @since 2.2.0
* @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`. * @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`.
* *
* @param string $deprecated Unused.. * @param string $deprecated Unused.
* @return string The document title. * @return string The document title.
*/ */
function get_wp_title_rss( $deprecated = '–' ) { function get_wp_title_rss( $deprecated = '–' ) {
@ -119,7 +119,7 @@ function get_wp_title_rss( $deprecated = '–' ) {
} }
/** /**
* Display the blog title for display of the feed title. * Displays the blog title for display of the feed title.
* *
* @since 2.2.0 * @since 2.2.0
* @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`. * @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`.
@ -147,7 +147,7 @@ function wp_title_rss( $deprecated = '–' ) {
} }
/** /**
* Retrieve the current post title for the feed. * Retrieves the current post title for the feed.
* *
* @since 2.0.0 * @since 2.0.0
* *
@ -167,7 +167,7 @@ function get_the_title_rss() {
} }
/** /**
* Display the post title in the feed. * Displays the post title in the feed.
* *
* @since 0.71 * @since 0.71
*/ */
@ -176,7 +176,7 @@ function the_title_rss() {
} }
/** /**
* Retrieve the post content for feeds. * Retrieves the post content for feeds.
* *
* @since 2.9.0 * @since 2.9.0
* *
@ -207,7 +207,7 @@ function get_the_content_feed( $feed_type = null ) {
} }
/** /**
* Display the post content for feeds. * Displays the post content for feeds.
* *
* @since 2.9.0 * @since 2.9.0
* *
@ -218,7 +218,7 @@ function the_content_feed( $feed_type = null ) {
} }
/** /**
* Display the post excerpt for the feed. * Displays the post excerpt for the feed.
* *
* @since 0.71 * @since 0.71
*/ */
@ -235,7 +235,7 @@ function the_excerpt_rss() {
} }
/** /**
* Display the permalink to the post for use in feeds. * Displays the permalink to the post for use in feeds.
* *
* @since 2.3.0 * @since 2.3.0
*/ */
@ -251,7 +251,7 @@ function the_permalink_rss() {
} }
/** /**
* Outputs the link to the comments for the current post in an xml safe way * Outputs the link to the comments for the current post in an XML safe way.
* *
* @since 3.0.0 * @since 3.0.0
*/ */
@ -268,7 +268,7 @@ function comments_link_feed() {
} }
/** /**
* Display the feed GUID for the current comment. * Displays the feed GUID for the current comment.
* *
* @since 2.5.0 * @since 2.5.0
* *
@ -279,7 +279,7 @@ function comment_guid( $comment_id = null ) {
} }
/** /**
* Retrieve the feed GUID for the current comment. * Retrieves the feed GUID for the current comment.
* *
* @since 2.5.0 * @since 2.5.0
* *
@ -297,7 +297,7 @@ function get_comment_guid( $comment_id = null ) {
} }
/** /**
* Display the link to the comments. * Displays the link to the comments.
* *
* @since 1.5.0 * @since 1.5.0
* @since 4.4.0 Introduced the `$comment` argument. * @since 4.4.0 Introduced the `$comment` argument.
@ -318,11 +318,11 @@ function comment_link( $comment = null ) {
} }
/** /**
* Retrieve the current comment author for use in the feeds. * Retrieves the current comment author for use in the feeds.
* *
* @since 2.0.0 * @since 2.0.0
* *
* @return string Comment Author * @return string Comment Author.
*/ */
function get_comment_author_rss() { function get_comment_author_rss() {
/** /**
@ -338,7 +338,7 @@ function get_comment_author_rss() {
} }
/** /**
* Display the current comment author in the feed. * Displays the current comment author in the feed.
* *
* @since 1.0.0 * @since 1.0.0
*/ */
@ -347,7 +347,7 @@ function comment_author_rss() {
} }
/** /**
* Display the current comment content for use in the feeds. * Displays the current comment content for use in the feeds.
* *
* @since 1.0.0 * @since 1.0.0
*/ */
@ -365,7 +365,7 @@ function comment_text_rss() {
} }
/** /**
* Retrieve all of the post categories, formatted for use in feeds. * Retrieves all of the post categories, formatted for use in feeds.
* *
* All of the categories for the current post in the feed loop, will be * All of the categories for the current post in the feed loop, will be
* retrieved and have feed markup added, so that they can easily be added to the * retrieved and have feed markup added, so that they can easily be added to the
@ -427,7 +427,7 @@ function get_the_category_rss( $type = null ) {
} }
/** /**
* Display the post categories in the feed. * Displays the post categories in the feed.
* *
* @since 0.71 * @since 0.71
* *
@ -440,7 +440,7 @@ function the_category_rss( $type = null ) {
} }
/** /**
* Display the HTML type based on the blog setting. * Displays the HTML type based on the blog setting.
* *
* The two possible values are either 'xhtml' or 'html'. * The two possible values are either 'xhtml' or 'html'.
* *
@ -457,7 +457,7 @@ function html_type_rss() {
} }
/** /**
* Display the rss enclosure for the current post. * Displays the rss enclosure for the current post.
* *
* Uses the global $post to check whether the post requires a password and if * Uses the global $post to check whether the post requires a password and if
* the user has the password for the post. If not then it will return before * the user has the password for the post. If not then it will return before
@ -498,7 +498,7 @@ function rss_enclosure() {
} }
/** /**
* Display the atom enclosure for the current post. * Displays the atom enclosure for the current post.
* *
* Uses the global $post to check whether the post requires a password and if * Uses the global $post to check whether the post requires a password and if
* the user has the password for the post. If not then it will return before * the user has the password for the post. If not then it will return before
@ -563,7 +563,7 @@ function atom_enclosure() {
} }
/** /**
* Determine the type of a string of data with the data formatted. * Determines the type of a string of data with the data formatted.
* *
* Tell whether the type is text, HTML, or XHTML, per RFC 4287 section 3.1. * Tell whether the type is text, HTML, or XHTML, per RFC 4287 section 3.1.
* *
@ -576,7 +576,7 @@ function atom_enclosure() {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param string $data Input string * @param string $data Input string.
* @return array array(type, value) * @return array array(type, value)
*/ */
function prep_atom_text_construct( $data ) { function prep_atom_text_construct( $data ) {
@ -663,7 +663,7 @@ function get_self_link() {
} }
/** /**
* Display the link for the currently displayed feed in a XSS safe way. * Displays the link for the currently displayed feed in a XSS safe way.
* *
* Generate a correct link for the atom:self element. * Generate a correct link for the atom:self element.
* *
@ -684,7 +684,7 @@ function self_link() {
} }
/** /**
* Get the UTC time of the most recently modified post from WP_Query. * Gets the UTC time of the most recently modified post from WP_Query.
* *
* If viewing a comment feed, the time of the most recently modified * If viewing a comment feed, the time of the most recently modified
* comment will be returned. * comment will be returned.
@ -742,7 +742,7 @@ function get_feed_build_date( $format ) {
} }
/** /**
* Return the content type for specified feed type. * Returns the content type for specified feed type.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -775,7 +775,7 @@ function feed_content_type( $type = '' ) {
} }
/** /**
* Build SimplePie object based on RSS or Atom feed from URL. * Builds SimplePie object based on RSS or Atom feed from URL.
* *
* @since 2.8.0 * @since 2.8.0
* *

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.1-alpha-53538'; $wp_version = '6.1-alpha-53539';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.