5 * Many of the functions used in here belong in The Loop, or The Loop for the
13 * RSS container for the bloginfo function.
15 * You can retrieve anything that you can using the get_bloginfo() function.
16 * Everything will be stripped of tags and characters converted, when the values
17 * are retrieved for use in the feeds.
22 * @uses apply_filters() Calls 'get_bloginfo_rss' hook with two parameters.
23 * @see get_bloginfo() For the list of possible values to display.
25 * @param string $show See get_bloginfo() for possible values.
28 function get_bloginfo_rss($show = '') {
29 $info = strip_tags(get_bloginfo($show));
30 return apply_filters('get_bloginfo_rss', convert_chars($info), $show);
34 * Display RSS container for the bloginfo function.
36 * You can retrieve anything that you can using the get_bloginfo() function.
37 * Everything will be stripped of tags and characters converted, when the values
38 * are retrieved for use in the feeds.
43 * @uses apply_filters() Calls 'bloginfo_rss' hook with two parameters.
44 * @see get_bloginfo() For the list of possible values to display.
46 * @param string $show See get_bloginfo() for possible values.
48 function bloginfo_rss($show = '') {
49 echo apply_filters('bloginfo_rss', get_bloginfo_rss($show), $show);
53 * Retrieve the default feed.
55 * The default feed is 'rss2', unless a plugin changes it through the
56 * 'default_feed' filter.
61 * @uses apply_filters() Calls 'default_feed' hook on the default feed string.
63 * @return string Default feed, or for example 'rss2', 'atom', etc.
65 function get_default_feed() {
66 $default_feed = apply_filters('default_feed', 'rss2');
67 return 'rss' == $default_feed ? 'rss2' : $default_feed;
71 * Retrieve the blog title for the feed title.
76 * @uses apply_filters() Calls 'get_wp_title_rss' hook on title.
77 * @uses wp_title() See function for $sep parameter usage.
79 * @param string $sep Optional.How to separate the title. See wp_title() for more info.
80 * @return string Error message on failure or blog title on success.
82 function get_wp_title_rss($sep = '»') {
83 $title = wp_title($sep, false);
84 if ( is_wp_error( $title ) )
85 return $title->get_error_message();
86 $title = apply_filters('get_wp_title_rss', $title);
91 * Display the blog title for display of the feed title.
96 * @uses apply_filters() Calls 'wp_title_rss' on the blog title.
97 * @see wp_title() $sep parameter usage.
99 * @param string $sep Optional.
101 function wp_title_rss($sep = '»') {
102 echo apply_filters('wp_title_rss', get_wp_title_rss($sep));
106 * Retrieve the current post title for the feed.
111 * @uses apply_filters() Calls 'the_title_rss' on the post title.
113 * @return string Current post title.
115 function get_the_title_rss() {
116 $title = get_the_title();
117 $title = apply_filters('the_title_rss', $title);
122 * Display the post title in the feed.
127 * @uses get_the_title_rss() Used to retrieve current post title.
129 function the_title_rss() {
130 echo get_the_title_rss();
134 * Retrieve the post content for feeds.
139 * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
140 * @see get_the_content()
142 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
143 * @return string The filtered content.
145 function get_the_content_feed($feed_type = null) {
147 $feed_type = get_default_feed();
149 $content = apply_filters('the_content', get_the_content());
150 $content = str_replace(']]>', ']]>', $content);
151 return apply_filters('the_content_feed', $content, $feed_type);
155 * Display the post content for feeds.
160 * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
161 * @see get_the_content()
163 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
165 function the_content_feed($feed_type = null) {
166 echo get_the_content_feed($feed_type);
170 * Display the post excerpt for the feed.
175 * @uses apply_filters() Calls 'the_excerpt_rss' hook on the excerpt.
177 function the_excerpt_rss() {
178 $output = get_the_excerpt();
179 echo apply_filters('the_excerpt_rss', $output);
183 * Display the permalink to the post for use in feeds.
188 * @uses apply_filters() Call 'the_permalink_rss' on the post permalink
190 function the_permalink_rss() {
191 echo esc_url( apply_filters('the_permalink_rss', get_permalink() ));
195 * Outputs the link to the comments for the current post in an xml safe way
200 function comments_link_feed() {
201 echo esc_url( apply_filters( 'comments_link_feed', get_comments_link() ) );
205 * Display the feed GUID for the current comment.
211 * @param int|object $comment_id Optional comment object or id. Defaults to global comment object.
213 function comment_guid($comment_id = null) {
214 echo esc_url( get_comment_guid($comment_id) );
218 * Retrieve the feed GUID for the current comment.
224 * @param int|object $comment_id Optional comment object or id. Defaults to global comment object.
225 * @return bool|string false on failure or guid for comment on success.
227 function get_comment_guid($comment_id = null) {
228 $comment = get_comment($comment_id);
230 if ( !is_object($comment) )
233 return get_the_guid($comment->comment_post_ID) . '#comment-' . $comment->comment_ID;
237 * Display the link to the comments.
241 function comment_link() {
242 echo esc_url( apply_filters( 'comment_link', get_comment_link() ) );
246 * Retrieve the current comment author for use in the feeds.
251 * @uses apply_filters() Calls 'comment_author_rss' hook on comment author.
252 * @uses get_comment_author()
254 * @return string Comment Author
256 function get_comment_author_rss() {
257 return apply_filters('comment_author_rss', get_comment_author() );
261 * Display the current comment author in the feed.
267 function comment_author_rss() {
268 echo get_comment_author_rss();
272 * Display the current comment content for use in the feeds.
277 * @uses apply_filters() Calls 'comment_text_rss' filter on comment content.
278 * @uses get_comment_text()
280 function comment_text_rss() {
281 $comment_text = get_comment_text();
282 $comment_text = apply_filters('comment_text_rss', $comment_text);
287 * Retrieve all of the post categories, formatted for use in feeds.
289 * All of the categories for the current post in the feed loop, will be
290 * retrieved and have feed markup added, so that they can easily be added to the
291 * RSS2, Atom, or RSS1 and RSS0.91 RDF feeds.
296 * @uses apply_filters()
298 * @param string $type Optional, default is the type returned by get_default_feed().
299 * @return string All of the post categories for displaying in the feed.
301 function get_the_category_rss($type = null) {
303 $type = get_default_feed();
304 $categories = get_the_category();
305 $tags = get_the_tags();
307 $cat_names = array();
310 if ( 'atom' == $type )
313 if ( !empty($categories) ) foreach ( (array) $categories as $category ) {
314 $cat_names[] = sanitize_term_field('name', $category->name, $category->term_id, 'category', $filter);
317 if ( !empty($tags) ) foreach ( (array) $tags as $tag ) {
318 $cat_names[] = sanitize_term_field('name', $tag->name, $tag->term_id, 'post_tag', $filter);
321 $cat_names = array_unique($cat_names);
323 foreach ( $cat_names as $cat_name ) {
324 if ( 'rdf' == $type )
325 $the_list .= "\t\t<dc:subject><![CDATA[$cat_name]]></dc:subject>\n";
326 elseif ( 'atom' == $type )
327 $the_list .= sprintf( '<category scheme="%1$s" term="%2$s" />', esc_attr( apply_filters( 'get_bloginfo_rss', get_bloginfo( 'url' ) ) ), esc_attr( $cat_name ) );
329 $the_list .= "\t\t<category><![CDATA[" . @html_entity_decode( $cat_name, ENT_COMPAT, get_option('blog_charset') ) . "]]></category>\n";
332 return apply_filters('the_category_rss', $the_list, $type);
336 * Display the post categories in the feed.
341 * @see get_the_category_rss() For better explanation.
343 * @param string $type Optional, default is the type returned by get_default_feed().
345 function the_category_rss($type = null) {
346 echo get_the_category_rss($type);
350 * Display the HTML type based on the blog setting.
352 * The two possible values are either 'xhtml' or 'html'.
358 function html_type_rss() {
359 $type = get_bloginfo('html_type');
360 if (strpos($type, 'xhtml') !== false)
368 * Display the rss enclosure for the current post.
370 * Uses the global $post to check whether the post requires a password and if
371 * the user has the password for the post. If not then it will return before
374 * Also uses the function get_post_custom() to get the post's 'enclosure'
375 * metadata field and parses the value to display the enclosure(s). The
376 * enclosure(s) consist of enclosure HTML tag(s) with a URI and other
380 * @subpackage Template
382 * @uses apply_filters() Calls 'rss_enclosure' hook on rss enclosure.
383 * @uses get_post_custom() To get the current post enclosure metadata.
385 function rss_enclosure() {
386 if ( post_password_required() )
389 foreach ( (array) get_post_custom() as $key => $val) {
390 if ($key == 'enclosure') {
391 foreach ( (array) $val as $enc ) {
392 $enclosure = explode("\n", $enc);
394 // only get the first element, e.g. audio/mpeg from 'audio/mpeg mpga mp2 mp3'
395 $t = preg_split('/[ \t]/', trim($enclosure[2]) );
398 echo apply_filters('rss_enclosure', '<enclosure url="' . trim(htmlspecialchars($enclosure[0])) . '" length="' . trim($enclosure[1]) . '" type="' . $type . '" />' . "\n");
405 * Display the atom enclosure for the current post.
407 * Uses the global $post to check whether the post requires a password and if
408 * the user has the password for the post. If not then it will return before
411 * Also uses the function get_post_custom() to get the post's 'enclosure'
412 * metadata field and parses the value to display the enclosure(s). The
413 * enclosure(s) consist of link HTML tag(s) with a URI and other attributes.
416 * @subpackage Template
418 * @uses apply_filters() Calls 'atom_enclosure' hook on atom enclosure.
419 * @uses get_post_custom() To get the current post enclosure metadata.
421 function atom_enclosure() {
422 if ( post_password_required() )
425 foreach ( (array) get_post_custom() as $key => $val ) {
426 if ($key == 'enclosure') {
427 foreach ( (array) $val as $enc ) {
428 $enclosure = explode("\n", $enc);
429 echo apply_filters('atom_enclosure', '<link href="' . trim(htmlspecialchars($enclosure[0])) . '" rel="enclosure" length="' . trim($enclosure[1]) . '" type="' . trim($enclosure[2]) . '" />' . "\n");
436 * Determine the type of a string of data with the data formatted.
438 * Tell whether the type is text, html, or xhtml, per RFC 4287 section 3.1.
440 * In the case of WordPress, text is defined as containing no markup,
441 * xhtml is defined as "well formed", and html as tag soup (i.e., the rest).
443 * Container div tags are added to xhtml values, per section 3.1.1.3.
445 * @link http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.3.1
451 * @param string $data Input string
452 * @return array array(type, value)
454 function prep_atom_text_construct($data) {
455 if (strpos($data, '<') === false && strpos($data, '&') === false) {
456 return array('text', $data);
459 $parser = xml_parser_create();
460 xml_parse($parser, '<div>' . $data . '</div>', true);
461 $code = xml_get_error_code($parser);
462 xml_parser_free($parser);
465 if (strpos($data, '<') === false) {
466 return array('text', $data);
468 $data = "<div xmlns='http://www.w3.org/1999/xhtml'>$data</div>";
469 return array('xhtml', $data);
473 if (strpos($data, ']]>') == false) {
474 return array('html', "<![CDATA[$data]]>");
476 return array('html', htmlspecialchars($data));
481 * Display the link for the currently displayed feed in a XSS safe way.
483 * Generate a correct link for the atom:self element.
489 function self_link() {
490 $host = @parse_url(home_url());
491 echo esc_url( apply_filters( 'self_link', set_url_scheme( 'http://' . $host['host'] . wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) );
495 * Return the content type for specified feed type.
501 function feed_content_type( $type = '' ) {
503 $type = get_default_feed();
506 'rss' => 'application/rss+xml',
507 'rss2' => 'application/rss+xml',
508 'rss-http' => 'text/xml',
509 'atom' => 'application/atom+xml',
510 'rdf' => 'application/rdf+xml'
513 $content_type = ( !empty($types[$type]) ) ? $types[$type] : 'application/octet-stream';
515 return apply_filters( 'feed_content_type', $content_type, $type );
519 * Build SimplePie object based on RSS or Atom feed from URL.
523 * @param mixed $url URL of feed to retrieve. If an array of URLs, the feeds are merged
524 * using SimplePie's multifeed feature.
525 * See also {@link ​http://simplepie.org/wiki/faq/typical_multifeed_gotchas}
527 * @return WP_Error|SimplePie WP_Error object on failure or SimplePie object on success
529 function fetch_feed( $url ) {
530 require_once ( ABSPATH . WPINC . '/class-feed.php' );
532 $feed = new SimplePie();
534 $feed->set_sanitize_class( 'WP_SimplePie_Sanitize_KSES' );
535 // We must manually overwrite $feed->sanitize because SimplePie's
536 // constructor sets it before we have a chance to set the sanitization class
537 $feed->sanitize = new WP_SimplePie_Sanitize_KSES();
539 $feed->set_cache_class( 'WP_Feed_Cache' );
540 $feed->set_file_class( 'WP_SimplePie_File' );
542 $feed->set_feed_url( $url );
543 $feed->set_cache_duration( apply_filters( 'wp_feed_cache_transient_lifetime', 12 * HOUR_IN_SECONDS, $url ) );
544 do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) );
546 $feed->handle_content_type();
548 if ( $feed->error() )
549 return new WP_Error( 'simplepie-error', $feed->error() );