X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7688c6ba71852cd89123b62b2d57683535e4702a..refs/tags/wordpress-4.3:/wp-includes/feed.php
diff --git a/wp-includes/feed.php b/wp-includes/feed.php
index 8f9219c5..f40f41a6 100644
--- a/wp-includes/feed.php
+++ b/wp-includes/feed.php
@@ -1,155 +1,374 @@
get_error_message();
- $title = apply_filters('get_wp_title_rss', $title);
+ }
+
+ if ( $title && $sep && ' ' !== substr( $title, 0, 1 ) ) {
+ $title = " $sep " . $title;
+ }
+
+ /**
+ * Filter the blog title for use as the feed title.
+ *
+ * @since 2.2.0
+ *
+ * @param string $title The current blog title.
+ * @param string $sep Separator used by wp_title().
+ */
+ $title = apply_filters( 'get_wp_title_rss', $title, $sep );
return $title;
}
-function wp_title_rss($sep = '»') {
- echo apply_filters('wp_title_rss', get_wp_title_rss($sep));
+/**
+ * Display the blog title for display of the feed title.
+ *
+ * @since 2.2.0
+ * @see wp_title() $sep parameter usage.
+ *
+ * @param string $sep Optional.
+ */
+function wp_title_rss( $sep = '»' ) {
+ /**
+ * Filter the blog title for display of the feed title.
+ *
+ * @since 2.2.0
+ *
+ * @see get_wp_title_rss()
+ *
+ * @param string $wp_title The current blog title.
+ * @param string $sep Separator used by wp_title().
+ */
+ echo apply_filters( 'wp_title_rss', get_wp_title_rss( $sep ), $sep );
}
+/**
+ * Retrieve the current post title for the feed.
+ *
+ * @since 2.0.0
+ *
+ * @return string Current post title.
+ */
function get_the_title_rss() {
$title = get_the_title();
- $title = apply_filters('the_title_rss', $title);
+ /**
+ * Filter 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.
+ *
+ * @since 0.71
+ */
function the_title_rss() {
echo get_the_title_rss();
}
-
-function the_content_rss($more_link_text='(more...)', $stripteaser=0, $more_file='', $cut = 0, $encode_html = 0) {
- $content = get_the_content($more_link_text, $stripteaser, $more_file);
- $content = apply_filters('the_content_rss', $content);
- if ( $cut && !$encode_html )
- $encode_html = 2;
- if ( 1== $encode_html ) {
- $content = wp_specialchars($content);
- $cut = 0;
- } elseif ( 0 == $encode_html ) {
- $content = make_url_footnote($content);
- } elseif ( 2 == $encode_html ) {
- $content = strip_tags($content);
- }
- if ( $cut ) {
- $blah = explode(' ', $content);
- if ( count($blah) > $cut ) {
- $k = $cut;
- $use_dotdotdot = 1;
- } else {
- $k = count($blah);
- $use_dotdotdot = 0;
- }
- for ( $i=0; $i<$k; $i++ )
- $excerpt .= $blah[$i].' ';
- $excerpt .= ($use_dotdotdot) ? '...' : '';
- $content = $excerpt;
- }
+/**
+ * Retrieve the post content for feeds.
+ *
+ * @since 2.9.0
+ * @see get_the_content()
+ *
+ * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
+ * @return string The filtered content.
+ */
+function get_the_content_feed($feed_type = null) {
+ if ( !$feed_type )
+ $feed_type = get_default_feed();
+
+ /** This filter is documented in wp-includes/post-template.php */
+ $content = apply_filters( 'the_content', get_the_content() );
$content = str_replace(']]>', ']]>', $content);
- echo $content;
+ /**
+ * Filter 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.
+ *
+ * @since 2.9.0
+ *
+ * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
+ */
+function the_content_feed($feed_type = null) {
+ echo get_the_content_feed($feed_type);
+}
+/**
+ * Display the post excerpt for the feed.
+ *
+ * @since 0.71
+ */
function the_excerpt_rss() {
$output = get_the_excerpt();
- echo apply_filters('the_excerpt_rss', $output);
+ /**
+ * Filter 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.
+ *
+ * @since 2.3.0
+ */
function the_permalink_rss() {
- echo apply_filters('the_permalink_rss', get_permalink());
+ /**
+ * Filter 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() ) );
+}
+/**
+ * Outputs the link to the comments for the current post in an xml safe way
+ *
+ * @since 3.0.0
+ * @return none
+ */
+function comments_link_feed() {
+ /**
+ * Filter 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() ) );
}
-function comment_link() {
- echo get_comment_link();
+/**
+ * Display the feed GUID for the current comment.
+ *
+ * @since 2.5.0
+ *
+ * @param int|object $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) );
}
+/**
+ * Retrieve the feed GUID for the current comment.
+ *
+ * @since 2.5.0
+ *
+ * @param int|object $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);
+
+ if ( !is_object($comment) )
+ return false;
-function get_comment_author_rss() {
- return apply_filters('comment_author_rss', get_comment_author() );
+ return get_the_guid($comment->comment_post_ID) . '#comment-' . $comment->comment_ID;
}
+/**
+ * Display the link to the comments.
+ *
+ * @since 1.5.0
+ */
+function comment_link() {
+ /**
+ * Filter 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() ) );
+}
+/**
+ * Retrieve the current comment author for use in the feeds.
+ *
+ * @since 2.0.0
+ *
+ * @return string Comment Author
+ */
+function get_comment_author_rss() {
+ /**
+ * Filter 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.
+ *
+ * @since 1.0.0
+ */
function comment_author_rss() {
echo get_comment_author_rss();
}
-
+/**
+ * Display the current comment content for use in the feeds.
+ *
+ * @since 1.0.0
+ */
function comment_text_rss() {
$comment_text = get_comment_text();
- $comment_text = apply_filters('comment_text_rss', $comment_text);
+ /**
+ * Filter 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;
}
-
-function comments_rss_link($link_text = 'Comments RSS', $commentsrssfilename = 'nolongerused') {
- $url = get_post_comments_feed_link();
- echo "$link_text";
-}
-
-
-function comments_rss($commentsrssfilename = 'nolongerused') {
- return get_post_comments_feed_link();
-}
-
-
-function get_author_rss_link($echo = false, $author_id, $author_nicename) {
- $auth_ID = (int) $author_id;
- $permalink_structure = get_option('permalink_structure');
-
- if ( '' == $permalink_structure ) {
- $link = get_option('home') . '?feed=rss2&author=' . $author_id;
- } else {
- $link = get_author_posts_url($author_id, $author_nicename);
- $link = trailingslashit($link) . user_trailingslashit('feed', 'feed');
- }
-
- $link = apply_filters('author_feed_link', $link);
-
- if ( $echo )
- echo $link;
- return $link;
-}
-
-
-function get_category_rss_link($echo = false, $cat_ID, $category_nicename) {
- $permalink_structure = get_option('permalink_structure');
-
- if ( '' == $permalink_structure ) {
- $link = get_option('home') . '?feed=rss2&cat=' . $cat_ID;
- } else {
- $link = get_category_link($cat_ID);
- $link = trailingslashit($link) . user_trailingslashit('feed', 'feed');
- }
-
- $link = apply_filters('category_feed_link', $link);
-
- if ( $echo )
- echo $link;
- return $link;
-}
-
-
-function get_the_category_rss($type = 'rss') {
+/**
+ * Retrieve all of the post categories, formatted for use in feeds.
+ *
+ * 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
+ * RSS2, Atom, or RSS1 and RSS0.91 RDF feeds.
+ *
+ * @since 2.1.0
+ *
+ * @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.
+ */
+function get_the_category_rss($type = null) {
+ if ( empty($type) )
+ $type = get_default_feed();
$categories = get_the_category();
$tags = get_the_tags();
- $home = get_bloginfo_rss('home');
$the_list = '';
$cat_names = array();
@@ -169,47 +388,44 @@ function get_the_category_rss($type = 'rss') {
foreach ( $cat_names as $cat_name ) {
if ( 'rdf' == $type )
- $the_list .= "\n\t\t