[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-includes/ -> feed.php (summary)

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

File Size: 783 lines (22 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 5 files
 wp-includes/class-simplepie.php
 wp-includes/class-wp-feed-cache-transient.php
 wp-includes/class-wp-simplepie-sanitize-kses.php
 wp-includes/class-wp-feed-cache.php
 wp-includes/class-wp-simplepie-file.php

Defines 31 functions

  get_bloginfo_rss()
  bloginfo_rss()
  get_default_feed()
  get_wp_title_rss()
  wp_title_rss()
  get_the_title_rss()
  the_title_rss()
  get_the_content_feed()
  the_content_feed()
  the_excerpt_rss()
  the_permalink_rss()
  comments_link_feed()
  comment_guid()
  get_comment_guid()
  comment_link()
  get_comment_author_rss()
  comment_author_rss()
  comment_text_rss()
  get_the_category_rss()
  the_category_rss()
  html_type_rss()
  rss_enclosure()
  atom_enclosure()
  prep_atom_text_construct()
  atom_site_icon()
  rss2_site_icon()
  get_self_link()
  self_link()
  get_feed_build_date()
  feed_content_type()
  fetch_feed()

Functions
Functions that are not part of a class:

get_bloginfo_rss( $show = '' )   X-Ref
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.

return: string
param: string $show See get_bloginfo() for possible values.

bloginfo_rss( $show = '' )   X-Ref
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.

param: string $show See get_bloginfo() for possible values.

get_default_feed()   X-Ref
Retrieve the default feed.

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

return: string Default feed, or for example 'rss2', 'atom', etc.

get_wp_title_rss( $deprecated = '&)   X-Ref
Retrieve the blog title for the feed title.

return: string The document title.
param: string $deprecated Unused..

wp_title_rss( $deprecated = '&)   X-Ref
Display the blog title for display of the feed title.

param: string $deprecated Unused.

get_the_title_rss()   X-Ref
Retrieve the current post title for the feed.

return: string Current post title.

the_title_rss()   X-Ref
Display the post title in the feed.


get_the_content_feed( $feed_type = null )   X-Ref
Retrieve the post content for feeds.

return: string The filtered content.
param: string $feed_type The type of feed. rss2 | atom | rss | rdf

the_content_feed( $feed_type = null )   X-Ref
Display the post content for feeds.

param: string $feed_type The type of feed. rss2 | atom | rss | rdf

the_excerpt_rss()   X-Ref
Display the post excerpt for the feed.


the_permalink_rss()   X-Ref
Display the permalink to the post for use in feeds.


comments_link_feed()   X-Ref
Outputs the link to the comments for the current post in an xml safe way

return: none

comment_guid( $comment_id = null )   X-Ref
Display the feed GUID for the current comment.

param: int|WP_Comment $comment_id Optional comment object or id. Defaults to global comment object.

get_comment_guid( $comment_id = null )   X-Ref
Retrieve the feed GUID for the current comment.

return: false|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.

comment_link( $comment = null )   X-Ref
Display the link to the comments.

param: int|WP_Comment $comment Optional. Comment object or id. Defaults to global comment object.

get_comment_author_rss()   X-Ref
Retrieve the current comment author for use in the feeds.

return: string Comment Author

comment_author_rss()   X-Ref
Display the current comment author in the feed.


comment_text_rss()   X-Ref
Display the current comment content for use in the feeds.


get_the_category_rss( $type = null )   X-Ref
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: string All of the post categories for displaying in the feed.
param: string $type Optional, default is the type returned by get_default_feed().

the_category_rss( $type = null )   X-Ref
Display the post categories in the feed.

param: string $type Optional, default is the type returned by get_default_feed().

html_type_rss()   X-Ref
Display the HTML type based on the blog setting.

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


rss_enclosure()   X-Ref
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.


atom_enclosure()   X-Ref
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.


prep_atom_text_construct( $data )   X-Ref
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.

return: array array(type, value)
param: string $data Input string

atom_site_icon()   X-Ref
Displays Site Icon in atom feeds.


rss2_site_icon()   X-Ref
Displays Site Icon in RSS2.


get_self_link()   X-Ref
Returns the link for the currently displayed feed.

return: string Correct link for the atom:self element.

self_link()   X-Ref
Display the link for the currently displayed feed in a XSS safe way.

Generate a correct link for the atom:self element.


get_feed_build_date( $format )   X-Ref
Get the timestamp of the most recently modified post from WP_Query.

If viewing a comment feed, the timestamp of the most recently modified
comment will be returned.

return: string The timestamp.
param: string $format Format of the timestamp to return, passed to mysql2date.

feed_content_type( $type = '' )   X-Ref
Return the content type for specified feed type.

param: string $type Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'.

fetch_feed( $url )   X-Ref
Build SimplePie object based on RSS or Atom feed from URL.

return: WP_Error|SimplePie WP_Error object on failure or SimplePie object on success
param: mixed $url URL of feed to retrieve. If an array of URLs, the feeds are merged



Generated: Fri Oct 25 08:20:01 2019 Cross-referenced by PHPXref 0.7