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
144 function get_the_content_feed($feed_type = null) {
146 $feed_type = get_default_feed();
148 $content = apply_filters('the_content', get_the_content());
149 $content = str_replace(']]>', ']]>', $content);
150 return apply_filters('the_content_feed', $content, $feed_type);
154 * Display the post content for feeds.
159 * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
160 * @see get_the_content()
162 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
164 function the_content_feed($feed_type = null) {
165 echo get_the_content_feed($feed_type);
169 * Display the post excerpt for the feed.
174 * @uses apply_filters() Calls 'the_excerpt_rss' hook on the excerpt.
176 function the_excerpt_rss() {
177 $output = get_the_excerpt();
178 echo apply_filters('the_excerpt_rss', $output);
182 * Display the permalink to the post for use in feeds.
187 * @uses apply_filters() Call 'the_permalink_rss' on the post permalink
189 function the_permalink_rss() {
190 echo esc_url( apply_filters('the_permalink_rss', get_permalink() ));
194 * Outputs the link to the comments for the current post in an xml safe way
199 function comments_link_feed() {
200 echo esc_url( get_comments_link() );
204 * Display the feed GUID for the current comment.
210 * @param int|object $comment_id Optional comment object or id. Defaults to global comment object.
212 function comment_guid($comment_id = null) {
213 echo esc_url( get_comment_guid($comment_id) );
217 * Retrieve the feed GUID for the current comment.
223 * @param int|object $comment_id Optional comment object or id. Defaults to global comment object.
224 * @return bool|string false on failure or guid for comment on success.
226 function get_comment_guid($comment_id = null) {
227 $comment = get_comment($comment_id);
229 if ( !is_object($comment) )
232 return get_the_guid($comment->comment_post_ID) . '#comment-' . $comment->comment_ID;
236 * Display the link to the comments.
240 function comment_link() {
241 echo esc_url( get_comment_link() );
245 * Retrieve the current comment author for use in the feeds.
250 * @uses apply_filters() Calls 'comment_author_rss' hook on comment author.
251 * @uses get_comment_author()
253 * @return string Comment Author
255 function get_comment_author_rss() {
256 return apply_filters('comment_author_rss', get_comment_author() );
260 * Display the current comment author in the feed.
266 function comment_author_rss() {
267 echo get_comment_author_rss();
271 * Display the current comment content for use in the feeds.
276 * @uses apply_filters() Calls 'comment_text_rss' filter on comment content.
277 * @uses get_comment_text()
279 function comment_text_rss() {
280 $comment_text = get_comment_text();
281 $comment_text = apply_filters('comment_text_rss', $comment_text);
286 * Retrieve all of the post categories, formatted for use in feeds.
288 * All of the categories for the current post in the feed loop, will be
289 * retrieved and have feed markup added, so that they can easily be added to the
290 * RSS2, Atom, or RSS1 and RSS0.91 RDF feeds.
295 * @uses apply_filters()
297 * @param string $type Optional, default is the type returned by get_default_feed().
298 * @return string All of the post categories for displaying in the feed.
300 function get_the_category_rss($type = null) {
302 $type = get_default_feed();
303 $categories = get_the_category();
304 $tags = get_the_tags();
306 $cat_names = array();
309 if ( 'atom' == $type )
312 if ( !empty($categories) ) foreach ( (array) $categories as $category ) {
313 $cat_names[] = sanitize_term_field('name', $category->name, $category->term_id, 'category', $filter);
316 if ( !empty($tags) ) foreach ( (array) $tags as $tag ) {
317 $cat_names[] = sanitize_term_field('name', $tag->name, $tag->term_id, 'post_tag', $filter);
320 $cat_names = array_unique($cat_names);
322 foreach ( $cat_names as $cat_name ) {
323 if ( 'rdf' == $type )
324 $the_list .= "\t\t<dc:subject><![CDATA[$cat_name]]></dc:subject>\n";
325 elseif ( 'atom' == $type )
326 $the_list .= sprintf( '<category scheme="%1$s" term="%2$s" />', esc_attr( apply_filters( 'get_bloginfo_rss', get_bloginfo( 'url' ) ) ), esc_attr( $cat_name ) );
328 $the_list .= "\t\t<category><![CDATA[" . @html_entity_decode( $cat_name, ENT_COMPAT, get_option('blog_charset') ) . "]]></category>\n";
331 return apply_filters('the_category_rss', $the_list, $type);
335 * Display the post categories in the feed.
340 * @see get_the_category_rss() For better explanation.
342 * @param string $type Optional, default is the type returned by get_default_feed().
344 function the_category_rss($type = null) {
345 echo get_the_category_rss($type);
349 * Display the HTML type based on the blog setting.
351 * The two possible values are either 'xhtml' or 'html'.
357 function html_type_rss() {
358 $type = get_bloginfo('html_type');
359 if (strpos($type, 'xhtml') !== false)
367 * Display the rss enclosure for the current post.
369 * Uses the global $post to check whether the post requires a password and if
370 * the user has the password for the post. If not then it will return before
373 * Also uses the function get_post_custom() to get the post's 'enclosure'
374 * metadata field and parses the value to display the enclosure(s). The
375 * enclosure(s) consist of enclosure HTML tag(s) with a URI and other
379 * @subpackage Template
381 * @uses apply_filters() Calls 'rss_enclosure' hook on rss enclosure.
382 * @uses get_post_custom() To get the current post enclosure metadata.
384 function rss_enclosure() {
385 if ( post_password_required() )
388 foreach ( (array) get_post_custom() as $key => $val) {
389 if ($key == 'enclosure') {
390 foreach ( (array) $val as $enc ) {
391 $enclosure = explode("\n", $enc);
393 //only get the the first element eg, audio/mpeg from 'audio/mpeg mpga mp2 mp3'
394 $t = preg_split('/[ \t]/', trim($enclosure[2]) );
397 echo apply_filters('rss_enclosure', '<enclosure url="' . trim(htmlspecialchars($enclosure[0])) . '" length="' . trim($enclosure[1]) . '" type="' . $type . '" />' . "\n");
404 * Display the atom enclosure for the current post.
406 * Uses the global $post to check whether the post requires a password and if
407 * the user has the password for the post. If not then it will return before
410 * Also uses the function get_post_custom() to get the post's 'enclosure'
411 * metadata field and parses the value to display the enclosure(s). The
412 * enclosure(s) consist of link HTML tag(s) with a URI and other attributes.
415 * @subpackage Template
417 * @uses apply_filters() Calls 'atom_enclosure' hook on atom enclosure.
418 * @uses get_post_custom() To get the current post enclosure metadata.
420 function atom_enclosure() {
421 if ( post_password_required() )
424 foreach ( (array) get_post_custom() as $key => $val ) {
425 if ($key == 'enclosure') {
426 foreach ( (array) $val as $enc ) {
427 $enclosure = split("\n", $enc);
428 echo apply_filters('atom_enclosure', '<link href="' . trim(htmlspecialchars($enclosure[0])) . '" rel="enclosure" length="' . trim($enclosure[1]) . '" type="' . trim($enclosure[2]) . '" />' . "\n");
435 * Determine the type of a string of data with the data formatted.
437 * Tell whether the type is text, html, or xhtml, per RFC 4287 section 3.1.
439 * In the case of WordPress, text is defined as containing no markup,
440 * xhtml is defined as "well formed", and html as tag soup (i.e., the rest).
442 * Container div tags are added to xhtml values, per section 3.1.1.3.
444 * @link http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.3.1
450 * @param string $data Input string
451 * @return array array(type, value)
453 function prep_atom_text_construct($data) {
454 if (strpos($data, '<') === false && strpos($data, '&') === false) {
455 return array('text', $data);
458 $parser = xml_parser_create();
459 xml_parse($parser, '<div>' . $data . '</div>', true);
460 $code = xml_get_error_code($parser);
461 xml_parser_free($parser);
464 if (strpos($data, '<') === false) {
465 return array('text', $data);
467 $data = "<div xmlns='http://www.w3.org/1999/xhtml'>$data</div>";
468 return array('xhtml', $data);
472 if (strpos($data, ']]>') == false) {
473 return array('html', "<![CDATA[$data]]>");
475 return array('html', htmlspecialchars($data));
480 * Display the link for the currently displayed feed in a XSS safe way.
482 * Generate a correct link for the atom:self element.
488 function self_link() {
489 $host = @parse_url(home_url());
490 $host = $host['host'];
493 . ( (isset($_SERVER['https']) && $_SERVER['https'] == 'on') ? 's' : '' ) . '://'
495 . stripslashes($_SERVER['REQUEST_URI'])
500 * Return the content type for specified feed type.
506 function feed_content_type( $type = '' ) {
508 $type = get_default_feed();
511 'rss' => 'application/rss+xml',
512 'rss2' => 'application/rss+xml',
513 'rss-http' => 'text/xml',
514 'atom' => 'application/atom+xml',
515 'rdf' => 'application/rdf+xml'
518 $content_type = ( !empty($types[$type]) ) ? $types[$type] : 'application/octet-stream';
520 return apply_filters( 'feed_content_type', $content_type, $type );
524 * Build SimplePie object based on RSS or Atom feed from URL.
528 * @param string $url URL to retrieve feed
529 * @return WP_Error|SimplePie WP_Error object on failure or SimplePie object on success
531 function fetch_feed($url) {
532 require_once (ABSPATH . WPINC . '/class-feed.php');
534 $feed = new SimplePie();
535 $feed->set_feed_url($url);
536 $feed->set_cache_class('WP_Feed_Cache');
537 $feed->set_file_class('WP_SimplePie_File');
538 $feed->set_cache_duration(apply_filters('wp_feed_cache_transient_lifetime', 43200, $url));
539 do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) );
541 $feed->handle_content_type();
543 if ( $feed->error() )
544 return new WP_Error('simplepie-error', $feed->error());