X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..refs/heads/pristine:/wp-includes/feed.php
diff --git a/wp-includes/feed.php b/wp-includes/feed.php
index 99e2286c..dbeb3a0f 100644
--- a/wp-includes/feed.php
+++ b/wp-includes/feed.php
@@ -7,6 +7,7 @@
*
* @package WordPress
* @subpackage Feed
+ * @since 2.1.0
*/
/**
@@ -16,10 +17,7 @@
* Everything will be stripped of tags and characters converted, when the values
* are retrieved for use in the feeds.
*
- * @package WordPress
- * @subpackage Feed
* @since 1.5.1
- * @uses apply_filters() Calls 'get_bloginfo_rss' hook with two parameters.
* @see get_bloginfo() For the list of possible values to display.
*
* @param string $show See get_bloginfo() for possible values.
@@ -27,7 +25,18 @@
*/
function get_bloginfo_rss($show = '') {
$info = strip_tags(get_bloginfo($show));
- return apply_filters('get_bloginfo_rss', convert_chars($info), $show);
+ /**
+ * Filters the bloginfo for use in RSS feeds.
+ *
+ * @since 2.2.0
+ *
+ * @see convert_chars()
+ * @see get_bloginfo()
+ *
+ * @param string $info Converted string value of the blog information.
+ * @param string $show The type of blog information to retrieve.
+ */
+ return apply_filters( 'get_bloginfo_rss', convert_chars( $info ), $show );
}
/**
@@ -37,94 +46,128 @@ function get_bloginfo_rss($show = '') {
* Everything will be stripped of tags and characters converted, when the values
* are retrieved for use in the feeds.
*
- * @package WordPress
- * @subpackage Feed
* @since 0.71
- * @uses apply_filters() Calls 'bloginfo_rss' hook with two parameters.
* @see get_bloginfo() For the list of possible values to display.
*
* @param string $show See get_bloginfo() for possible values.
*/
function bloginfo_rss($show = '') {
- echo apply_filters('bloginfo_rss', get_bloginfo_rss($show), $show);
+ /**
+ * Filters the bloginfo for display in RSS feeds.
+ *
+ * @since 2.1.0
+ *
+ * @see get_bloginfo()
+ *
+ * @param string $rss_container RSS container for the blog information.
+ * @param string $show The type of blog information to retrieve.
+ */
+ echo apply_filters( 'bloginfo_rss', get_bloginfo_rss( $show ), $show );
}
/**
* Retrieve the default feed.
*
* The default feed is 'rss2', unless a plugin changes it through the
- * 'default_feed' filter.
+ * {@see 'default_feed'} filter.
*
- * @package WordPress
- * @subpackage Feed
- * @since 2.5
- * @uses apply_filters() Calls 'default_feed' hook on the default feed string.
+ * @since 2.5.0
*
* @return string Default feed, or for example 'rss2', 'atom', etc.
*/
function get_default_feed() {
- $default_feed = apply_filters('default_feed', 'rss2');
+ /**
+ * Filters the default feed type.
+ *
+ * @since 2.5.0
+ *
+ * @param string $feed_type Type of default feed. Possible values include 'rss2', 'atom'.
+ * Default 'rss2'.
+ */
+ $default_feed = apply_filters( 'default_feed', 'rss2' );
return 'rss' == $default_feed ? 'rss2' : $default_feed;
}
/**
* Retrieve the blog title for the feed title.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.2.0
- * @uses apply_filters() Calls 'get_wp_title_rss' hook on title.
- * @uses wp_title() See function for $sep parameter usage.
+ * @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`.
*
- * @param string $sep Optional.How to separate the title. See wp_title() for more info.
- * @return string Error message on failure or blog title on success.
+ * @param string $deprecated Unused..
+ * @return string The document title.
*/
-function get_wp_title_rss($sep = '»') {
- $title = wp_title($sep, false);
- if ( is_wp_error( $title ) )
- return $title->get_error_message();
- $title = apply_filters( 'get_wp_title_rss', $title, $sep );
- return $title;
+function get_wp_title_rss( $deprecated = '–' ) {
+ if ( '–' !== $deprecated ) {
+ /* translators: %s: 'document_title_separator' filter name */
+ _deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), 'document_title_separator
' ) );
+ }
+
+ /**
+ * Filters the blog title for use as the feed title.
+ *
+ * @since 2.2.0
+ * @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`.
+ *
+ * @param string $title The current blog title.
+ * @param string $deprecated Unused.
+ */
+ return apply_filters( 'get_wp_title_rss', wp_get_document_title(), $deprecated );
}
/**
* Display the blog title for display of the feed title.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.2.0
- * @uses apply_filters() Calls 'wp_title_rss' on the blog title.
- * @see wp_title() $sep parameter usage.
+ * @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`.
*
- * @param string $sep Optional.
+ * @param string $deprecated Unused.
*/
-function wp_title_rss( $sep = '»' ) {
- echo apply_filters( 'wp_title_rss', get_wp_title_rss( $sep ), $sep );
+function wp_title_rss( $deprecated = '–' ) {
+ if ( '–' !== $deprecated ) {
+ /* translators: %s: 'document_title_separator' filter name */
+ _deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), 'document_title_separator
' ) );
+ }
+
+ /**
+ * Filters the blog title for display of the feed title.
+ *
+ * @since 2.2.0
+ * @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`.
+ *
+ * @see get_wp_title_rss()
+ *
+ * @param string $wp_title_rss The current blog title.
+ * @param string $deprecated Unused.
+ */
+ echo apply_filters( 'wp_title_rss', get_wp_title_rss(), $deprecated );
}
/**
* Retrieve the current post title for the feed.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.0.0
- * @uses apply_filters() Calls 'the_title_rss' on the post title.
*
* @return string Current post title.
*/
function get_the_title_rss() {
$title = get_the_title();
- $title = apply_filters('the_title_rss', $title);
+
+ /**
+ * Filters the post title for use in a feed.
+ *
+ * @since 1.2.0
+ *
+ * @param string $title The current post title.
+ */
+ $title = apply_filters( 'the_title_rss', $title );
return $title;
}
/**
* Display the post title in the feed.
*
- * @package WordPress
- * @subpackage Feed
* @since 0.71
- * @uses get_the_title_rss() Used to retrieve current post title.
*/
function the_title_rss() {
echo get_the_title_rss();
@@ -133,10 +176,7 @@ function the_title_rss() {
/**
* Retrieve the post content for feeds.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.9.0
- * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
* @see get_the_content()
*
* @param string $feed_type The type of feed. rss2 | atom | rss | rdf
@@ -146,19 +186,25 @@ function get_the_content_feed($feed_type = null) {
if ( !$feed_type )
$feed_type = get_default_feed();
- $content = apply_filters('the_content', get_the_content());
+ /** This filter is documented in wp-includes/post-template.php */
+ $content = apply_filters( 'the_content', get_the_content() );
$content = str_replace(']]>', ']]>', $content);
- return apply_filters('the_content_feed', $content, $feed_type);
+ /**
+ * Filters the post content for use in feeds.
+ *
+ * @since 2.9.0
+ *
+ * @param string $content The current post content.
+ * @param string $feed_type Type of feed. Possible values include 'rss2', 'atom'.
+ * Default 'rss2'.
+ */
+ return apply_filters( 'the_content_feed', $content, $feed_type );
}
/**
* Display the post content for feeds.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.9.0
- * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
- * @see get_the_content()
*
* @param string $feed_type The type of feed. rss2 | atom | rss | rdf
*/
@@ -169,26 +215,34 @@ function the_content_feed($feed_type = null) {
/**
* Display the post excerpt for the feed.
*
- * @package WordPress
- * @subpackage Feed
* @since 0.71
- * @uses apply_filters() Calls 'the_excerpt_rss' hook on the excerpt.
*/
function the_excerpt_rss() {
$output = get_the_excerpt();
- echo apply_filters('the_excerpt_rss', $output);
+ /**
+ * Filters the post excerpt for a feed.
+ *
+ * @since 1.2.0
+ *
+ * @param string $output The current post excerpt.
+ */
+ echo apply_filters( 'the_excerpt_rss', $output );
}
/**
* Display the permalink to the post for use in feeds.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.3.0
- * @uses apply_filters() Call 'the_permalink_rss' on the post permalink
*/
function the_permalink_rss() {
- echo esc_url( apply_filters('the_permalink_rss', get_permalink() ));
+ /**
+ * Filters the permalink to the post for use in feeds.
+ *
+ * @since 2.3.0
+ *
+ * @param string $post_permalink The current post permalink.
+ */
+ echo esc_url( apply_filters( 'the_permalink_rss', get_permalink() ) );
}
/**
@@ -198,17 +252,23 @@ function the_permalink_rss() {
* @return none
*/
function comments_link_feed() {
+ /**
+ * Filters the comments permalink for the current post.
+ *
+ * @since 3.6.0
+ *
+ * @param string $comment_permalink The current comment permalink with
+ * '#comments' appended.
+ */
echo esc_url( apply_filters( 'comments_link_feed', get_comments_link() ) );
}
/**
* Display the feed GUID for the current comment.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.5.0
*
- * @param int|object $comment_id Optional comment object or id. Defaults to global comment object.
+ * @param int|WP_Comment $comment_id Optional comment object or id. Defaults to global comment object.
*/
function comment_guid($comment_id = null) {
echo esc_url( get_comment_guid($comment_id) );
@@ -217,12 +277,10 @@ function comment_guid($comment_id = null) {
/**
* Retrieve the feed GUID for the current comment.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.5.0
*
- * @param int|object $comment_id Optional comment object or id. Defaults to global comment object.
- * @return bool|string false on failure or guid for comment on success.
+ * @param int|WP_Comment $comment_id Optional comment object or id. Defaults to global comment object.
+ * @return false|string false on failure or guid for comment on success.
*/
function get_comment_guid($comment_id = null) {
$comment = get_comment($comment_id);
@@ -237,31 +295,46 @@ function get_comment_guid($comment_id = null) {
* Display the link to the comments.
*
* @since 1.5.0
+ * @since 4.4.0 Introduced the `$comment` argument.
+ *
+ * @param int|WP_Comment $comment Optional. Comment object or id. Defaults to global comment object.
*/
-function comment_link() {
- echo esc_url( apply_filters( 'comment_link', get_comment_link() ) );
+function comment_link( $comment = null ) {
+ /**
+ * Filters the current comment's permalink.
+ *
+ * @since 3.6.0
+ *
+ * @see get_comment_link()
+ *
+ * @param string $comment_permalink The current comment permalink.
+ */
+ echo esc_url( apply_filters( 'comment_link', get_comment_link( $comment ) ) );
}
/**
* Retrieve the current comment author for use in the feeds.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.0.0
- * @uses apply_filters() Calls 'comment_author_rss' hook on comment author.
- * @uses get_comment_author()
*
* @return string Comment Author
*/
function get_comment_author_rss() {
- return apply_filters('comment_author_rss', get_comment_author() );
+ /**
+ * Filters the current comment author for use in a feed.
+ *
+ * @since 1.5.0
+ *
+ * @see get_comment_author()
+ *
+ * @param string $comment_author The current comment author.
+ */
+ return apply_filters( 'comment_author_rss', get_comment_author() );
}
/**
* Display the current comment author in the feed.
*
- * @package WordPress
- * @subpackage Feed
* @since 1.0.0
*/
function comment_author_rss() {
@@ -271,15 +344,18 @@ function comment_author_rss() {
/**
* Display the current comment content for use in the feeds.
*
- * @package WordPress
- * @subpackage Feed
* @since 1.0.0
- * @uses apply_filters() Calls 'comment_text_rss' filter on comment content.
- * @uses get_comment_text()
*/
function comment_text_rss() {
$comment_text = get_comment_text();
- $comment_text = apply_filters('comment_text_rss', $comment_text);
+ /**
+ * Filters the current comment content for use in a feed.
+ *
+ * @since 1.5.0
+ *
+ * @param string $comment_text The content of the current comment.
+ */
+ $comment_text = apply_filters( 'comment_text_rss', $comment_text );
echo $comment_text;
}
@@ -290,10 +366,7 @@ function comment_text_rss() {
* retrieved and have feed markup added, so that they can easily be added to the
* RSS2, Atom, or RSS1 and RSS0.91 RDF feeds.
*
- * @package WordPress
- * @subpackage Feed
* @since 2.1.0
- * @uses apply_filters()
*
* @param string $type Optional, default is the type returned by get_default_feed().
* @return string All of the post categories for displaying in the feed.
@@ -324,19 +397,26 @@ function get_the_category_rss($type = null) {
if ( 'rdf' == $type )
$the_list .= "\t\t