| [ Index ] |
PHP Cross Reference of Wordpress 2.7.1 |
[Source view] [Print] [Project Stats]
WordPress Feed API Many of the functions used in here belong in The Loop, or The Loop for the Feeds.
| File Size: | 514 lines (15 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| 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. param: string $show See get_bloginfo() for possible values. return: string |
| 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 'default_feed' filter. return: string Default feed, or for example 'rss2', 'atom', etc. |
| get_wp_title_rss($sep = '&) X-Ref |
| Retrieve the blog title for the feed title. param: string $sep Optional.How to separate the title. See wp_title() for more info. return: string Error message on failure or blog title on success. |
| wp_title_rss($sep = '&) X-Ref |
| Display the blog title for display of the feed title. param: string $sep Optional. |
| 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. |
| the_content_rss($more_link_text='(more...) X-Ref |
| Display the post content for the feed. For encoding the html or the $encode_html parameter, there are three possible values. '0' will make urls footnotes and use make_url_footnote(). '1' will encode special characters and automatically display all of the content. The value of '2' will strip all HTML tags from the content. Also note that you cannot set the amount of words and not set the html encoding. If that is the case, then the html encoding will default to 2, which will strip all HTML tags. To restrict the amount of words of the content, you can use the cut parameter. If the content is less than the amount, then there won't be any dots added to the end. If there is content left over, then dots will be added and the rest of the content will be removed. param: string $more_link_text Optional. Text to display when more content is available but not displayed. param: int|bool $stripteaser Optional. Default is 0. param: string $more_file Optional. param: int $cut Optional. Amount of words to keep for the content. param: int $encode_html Optional. How to encode the content. |
| 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. |
| comment_guid($comment_id = null) X-Ref |
| Display the feed GUID for the current comment. param: int|object $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. param: int|object $comment_id Optional comment object or id. Defaults to global comment object. return: bool|string false on failure or guid for comment on success. |
| comment_link() X-Ref |
| Display the link to the comments. |
| 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 = 'rss') 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. param: string $type Optional, default is 'rss'. Either 'rss', 'atom', or 'rdf'. return: string All of the post categories for displaying in the feed. |
| the_category_rss($type = 'rss') X-Ref |
| Display the post categories in the feed. param: string $type Optional, default is 'rss'. Either 'rss', 'atom', or 'rdf'. |
| 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. param: string $data Input string return: array array(type, value) |
| 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. |
| Generated: Mon Mar 23 16:23:02 2009 | Cross-referenced by PHPXref 0.7 |