Changeset 8246

Timestamp:

07/03/08 15:23:22 (3 months ago)

Author:

ryan

Message:

phpdoc for feed.php from jacobsantos. fixes #5636

Files:

• trunk/wp-includes/feed.php (modified) (15 diffs)

trunk/wp-includes/feed.php

@@ -1 +1 @@
-<?php
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function get_bloginfo_rss($show = '') {
-    $info = strip_tags(get_bloginfo($show));
@@ -6 +31 @@
-}
-
+/**
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 0.71
+ * @uses apply_filters() Calls 'bloginfo_rss' hook with two parameters.
+ * @see get_bloginfo() For the list of possible values to display.
+ *
+ * @param string $show See get_bloginfo() for possible values.
+ */
-function bloginfo_rss($show = '') {
-    echo apply_filters('bloginfo_rss', get_bloginfo_rss($show), $show);
-}
-
+/**
+ * Retrieve the default feed.
+ *
+ * The default feed is 'rss2', unless a plugin changes it through the
+ * 'default_feed' filter.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 2.5
+ * @uses apply_filters() Calls 'default_feed' hook on the default feed string.
+ *
+ * @return string Default feed, or for example 'rss2', 'atom', etc.
+ */
-function get_default_feed() {
-    return apply_filters('default_feed', 'rss2');
-}
-
+/**
+ * Retrieve the blog title for the feed title.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 2.2.0
+ * @uses apply_filters() Calls 'get_wp_title_rss' hook on title.
+ * @uses wp_title() See function for $sep parameter usage.
+ *
+ * @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.
+ */
-function get_wp_title_rss($sep = '&#187;') {
-    $title = wp_title($sep, false);
@@ -22 +87 @@
-}
-
+/**
+ * Display the blog title for display of the feed title.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 2.2.0
+ * @uses apply_filters() Calls 'wp_title_rss' on the blog title.
+ * @see wp_title() $sep parameter usage.
+ *
+ * @param string $sep Optional.
+ */
-function wp_title_rss($sep = '&#187;') {
-    echo apply_filters('wp_title_rss', get_wp_title_rss($sep));
-}
-
+/**
+ * Retrieve the current post title for the feed.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 2.0.0
+ * @uses apply_filters() Calls 'the_title_rss' on the post title.
+ *
+ * @return string Current post title.
+ */
-function get_the_title_rss() {
-    $title = get_the_title();
@@ -32 +118 @@
-}
-
-
+
+
+
+
+
+
+
+
-function the_title_rss() {
-    echo get_the_title_rss();
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function the_content_rss($more_link_text='(more...)', $stripteaser=0, $more_file='', $cut = 0, $encode_html = 0) {
-    $content = get_the_content($more_link_text, $stripteaser, $more_file);
@@ -60 +182 @@
-            $use_dotdotdot = 0;
-        }
+
+        /** @todo Check performance, might be faster to use array slice instead. */
-        for ( $i=0; $i<$k; $i++ )
-            $excerpt .= $blah[$i].' ';
@@ -69 +193 @@
-}
-
-
+
+
+
+
+
+
+
+
-function the_excerpt_rss() {
-    $output = get_the_excerpt();
@@ -75 +206 @@
-}
-
+/**
+ * Display the permalink to the post for use in feeds.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 2.3.0
+ * @uses apply_filters() Call 'the_permalink_rss' on the post permalink
+ */
-function the_permalink_rss() {
-    echo apply_filters('the_permalink_rss', get_permalink());
-
-
-
+
+
+
+
+
+
+
+
+
-function comment_guid() {
-    echo get_comment_guid();
-}
-
+/**
+ * Retrieve the feed GUID for the current comment.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since unknown
+ *
+ * @return bool|string false on failure or guid for comment on success.
+ */
-function get_comment_guid() {
-    global $comment;
@@ -93 +247 @@
-}
-
+/**
+ * Display the link to the comments.
+ *
+ * @since 1.5.0
+ */
-function comment_link() {
-    echo get_comment_link();
-}
-
+/**
+ * Retrieve the current comment author for use in the feeds.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 2.0.0
+ * @uses apply_filters() Calls 'comment_author_rss' hook on comment author.
+ * @uses get_comment_author()
+ *
+ * @return string Comment Author
+ */
-function get_comment_author_rss() {
-    return apply_filters('comment_author_rss', get_comment_author() );
-}
-
+/**
+ * Display the current comment author in the feed.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 1.0.0
+ */
-function comment_author_rss() {
-    echo get_comment_author_rss();
-}
-
+/**
+ * Display the current comment content for use in the feeds.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 1.0.0
+ * @uses apply_filters() Calls 'comment_text_rss' filter on comment content.
+ * @uses get_comment_text()
+ */
-function comment_text_rss() {
-    $comment_text = get_comment_text();
@@ -111 +297 @@
-}
-
+/**
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 2.1.0
+ * @uses apply_filters() 
+ *
+ * @param string $type Optional, default is 'rss'. Either 'rss', 'atom', or 'rdf'.
+ * @return string All of the post categories for displaying in the feed.
+ */
-function get_the_category_rss($type = 'rss') {
-    $categories = get_the_category();
@@ -143 +344 @@
-}
-
+/**
+ * Display the post categories in the feed.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 0.71
+ * @see get_the_category_rss() For better explanation.
+ *
+ * @param string $type Optional, default is 'rss'. Either 'rss', 'atom', or 'rdf'.
+ */
-function the_category_rss($type = 'rss') {
-    echo get_the_category_rss($type);
-}
-
+/**
+ * Display the HTML type based on the blog setting.
+ *
+ * The two possible values are either 'xhtml' or 'html'.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ * @since 2.2.0
+ */
-function html_type_rss() {
-    $type = get_bloginfo('html_type');
@@ -156 +376 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function rss_enclosure() {
-    global $post;
@@ -172 +409 @@
-}
-
+/**
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Template
+ * @since 2.2.0
+ * @uses apply_filters() Calls 'atom_enclosure' hook on atom enclosure.
+ * @uses get_post_custom() To get the current post enclosure metadata.
+ */
-function atom_enclosure() {
-    global $post;
@@ -188 +442 @@
-
-/**
-prep_atom_text_construct() - Determine the type of a given string of data
+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.
@@ -203 +457 @@
- * @since 2.5
- *
-i
-$result 
+I
+
- */
-function prep_atom_text_construct($data) {
@@ -233 +487 @@
-
-/**
-self_link() - Generate a correct link for the atom:self elemet
-
-Echo the link for the currently displayed feed in a XSS safe way
+Display the link for the currently displayed feed in a XSS safe way.
+
+Generate a correct link for the atom:self element
- *
- * @package WordPress
- * @subpackage Feed
- * @since 2.5
- *
- */
-function self_link() {