/wp-includes/feed.php

Description
Description | Functions

WordPress Feed API

Many of the functions used in here belong in The Loop, or The Loop for the Feeds.

Functions
Description | Functions
atom_enclosure (line 420)

Display the atom enclosure for the current post.

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 displaying.

Also uses the function get_post_custom() to get the post's 'enclosure' metadata field and parses the value to display the enclosure(s). The enclosure(s) consist of link HTML tag(s) with a URI and other attributes.

void atom_enclosure ()
bloginfo_rss (line 48)

Display RSS container for the 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 are retrieved for use in the feeds.

  • see: get_bloginfo() For the list of possible values to display.
  • since: 0.71
  • uses: apply_filters() - Calls 'bloginfo_rss' hook with two parameters.
void bloginfo_rss ([string $show = ''])
  • string $show: See get_bloginfo() for possible values.
comments_link_feed (line 199)

Outputs the link to the comments for the current post in an xml safe way

  • since: 3.0.0
none comments_link_feed ()
comment_author_rss (line 266)

Display the current comment author in the feed.

  • since: 1.0.0
void comment_author_rss ()
comment_guid (line 212)

Display the feed GUID for the current comment.

  • since: 2.5.0
void comment_guid ([int|object  $comment_id = null])
  • int|object $comment_id: Optional comment object or id. Defaults to global comment object.
comment_link (line 240)

Display the link to the comments.

  • since: 1.5.0
void comment_link ()
comment_text_rss (line 279)

Display the current comment content for use in the feeds.

void comment_text_rss ()
feed_content_type (line 505)

Return the content type for specified feed type.

  • since: 2.8.0
void feed_content_type ([ $type = ''])
  • $type
fetch_feed (line 530)

Build SimplePie object based on RSS or Atom feed from URL.

  • return: WP_Error object on failure or SimplePie object on success
  • since: 2.8
WP_Error|SimplePie fetch_feed (string $url)
  • string $url: URL to retrieve feed
get_bloginfo_rss (line 28)

RSS container for the 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 are retrieved for use in the feeds.

  • see: get_bloginfo() For the list of possible values to display.
  • since: 1.5.1
  • uses: apply_filters() - Calls 'get_bloginfo_rss' hook with two parameters.
string get_bloginfo_rss ([string $show = ''])
  • string $show: See get_bloginfo() for possible values.
get_comment_author_rss (line 255)

Retrieve the current comment author for use in the feeds.

string get_comment_author_rss ()
get_comment_guid (line 226)

Retrieve the feed GUID for the current comment.

  • return: false on failure or guid for comment on success.
  • since: 2.5.0
bool|string get_comment_guid ([int|object  $comment_id = null])
  • int|object $comment_id: Optional comment object or id. Defaults to global comment object.
get_default_feed (line 65)

Retrieve the default feed.

The default feed is 'rss2', unless a plugin changes it through the 'default_feed' filter.

  • return: Default feed, or for example 'rss2', 'atom', etc.
  • since: 2.5
  • uses: apply_filters() - Calls 'default_feed' hook on the default feed string.
string get_default_feed ()
get_the_category_rss (line 300)

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.

  • return: All of the post categories for displaying in the feed.
  • since: 2.1.0
  • uses: apply_filters()
string get_the_category_rss ([string $type = null])
  • string $type: Optional, default is the type returned by get_default_feed().
get_the_content_feed (line 144)

Retrieve the post content for feeds.

void get_the_content_feed ([string $feed_type = null])
  • string $feed_type: The type of feed. rss2 | atom | rss | rdf
get_the_title_rss (line 115)

Retrieve the current post title for the feed.

  • return: Current post title.
  • since: 2.0.0
  • usedby: the_title_rss() - Used to retrieve current post title.
  • uses: apply_filters() - Calls 'the_title_rss' on the post title.
string get_the_title_rss ()
get_wp_title_rss (line 82)

Retrieve the blog title for the feed title.

  • return: Error message on failure or blog title on success.
  • since: 2.2.0
  • uses: wp_title() - See function for $sep parameter usage.
  • uses: apply_filters() - Calls 'get_wp_title_rss' hook on title.
string get_wp_title_rss ([string $sep = '»'])
  • string $sep: Optional.How to separate the title. See wp_title() for more info.
html_type_rss (line 357)

Display the HTML type based on the blog setting.

The two possible values are either 'xhtml' or 'html'.

  • since: 2.2.0
void html_type_rss ()
prep_atom_text_construct (line 453)

Determine 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.

In the case of WordPress, text is defined as containing no markup, xhtml is defined as "well formed", and html as tag soup (i.e., the rest).

Container div tags are added to xhtml values, per section 3.1.1.3.

array prep_atom_text_construct (string $data)
  • string $data: Input string
rss_enclosure (line 384)

Display the rss enclosure for the current post.

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 displaying.

Also uses the function get_post_custom() to get the post's 'enclosure' metadata field and parses the value to display the enclosure(s). The enclosure(s) consist of enclosure HTML tag(s) with a URI and other attributes.

void rss_enclosure ()
self_link (line 488)

Display the link for the currently displayed feed in a XSS safe way.

Generate a correct link for the atom:self element.

  • since: 2.5
void self_link ()
the_category_rss (line 344)

Display the post categories in the feed.

  • see: get_the_category_rss() For better explanation.
  • since: 0.71
void the_category_rss ([string $type = null])
  • string $type: Optional, default is the type returned by get_default_feed().
the_content_feed (line 164)

Display the post content for feeds.

void the_content_feed ([string $feed_type = null])
  • string $feed_type: The type of feed. rss2 | atom | rss | rdf
the_excerpt_rss (line 176)

Display the post excerpt for the feed.

  • since: 0.71
  • uses: apply_filters() - Calls 'the_excerpt_rss' hook on the excerpt.
void the_excerpt_rss ()
the_permalink_rss (line 189)

Display the permalink to the post for use in feeds.

  • since: 2.3.0
  • uses: apply_filters() - Call 'the_permalink_rss' on the post permalink
void the_permalink_rss ()
the_title_rss (line 129)

Display the post title in the feed.

void the_title_rss ()
wp_title_rss (line 101)

Display the blog title for display of the feed title.

  • see: wp_title() $sep parameter usage.
  • since: 2.2.0
  • uses: apply_filters() - Calls 'wp_title_rss' on the blog title.
void wp_title_rss ([string $sep = '»'])
  • string $sep: Optional.

Documentation generated on Thu, 20 Jun 2013 01:31:40 +0100 by phpDocumentor 1.4.3