WordPress.org
Get WordPress

Make WordPress Core

Ticket #5636: feed.phpdoc.r6597.diff

File feed.phpdoc.r6597.diff, 6.7 KB (added by darkdragon, 19 years ago)

Incomplete documentation for feed.php based off of r6597

  • feed.php

     
    11<?php
     2/**
     3 * WordPress Feed API
     4 *
     5 * @package WordPress
     6 * @subpackage Feed
     7 */
    28
     9/**
     10 * get_bloginfo_rss() - {@internal Missing Short Description}}
     11 *
     12 * {@internal Missing Long Description}}
     13 *
     14 * @since 1.5.1
     15 * @uses apply_filters()
     16 *
     17 * @param unknown_type $show
     18 * @return unknown
     19 */
    320function get_bloginfo_rss($show = '') {
    421        $info = strip_tags(get_bloginfo($show));
    522        return apply_filters('get_bloginfo_rss', convert_chars($info));
    623}
    724
     25/**
     26 * bloginfo_rss() - {@internal Missing Short Description}}
     27 *
     28 * {@internal Missing Long Description}}
     29 *
     30 * @since 0.71
     31 * @uses apply_filters()
     32 *
     33 * @param unknown_type $show
     34 */
    835function bloginfo_rss($show = '') {
    936        echo apply_filters('bloginfo_rss', get_bloginfo_rss($show));
    1037}
    1138
     39/**
     40 * get_default_feed() - {@internal Missing Short Description}}
     41 *
     42 * {@internal Missing Long Description}}
     43 *
     44 * @since 2.5
     45 * @uses apply_filters()
     46 *
     47 * @return unknown
     48 */
    1249function get_default_feed() {
    1350        return apply_filters('default_feed', 'rss2');
    1451}
    1552
     53/**
     54 * get_wp_title_rss() - {@internal Missing Short Description}}
     55 *
     56 * {@internal Missing Long Description}}
     57 *
     58 * @since 2.2.0
     59 * @uses apply_filters()
     60 *
     61 * @param unknown_type $sep
     62 * @return unknown
     63 */
    1664function get_wp_title_rss($sep = '&#187;') {
    1765        $title = wp_title($sep, false);
    1866        if ( is_wp_error( $title ) )
    … …  
    2169        return $title;
    2270}
    2371
     72/**
     73 * wp_title_rss() - {@internal Missing Short Description}}
     74 *
     75 * {@internal Missing Long Description}}
     76 *
     77 * @since 2.2.0
     78 * @uses apply_filters()
     79 *
     80 * @param unknown_type $sep
     81 */
    2482function wp_title_rss($sep = '&#187;') {
    2583        echo apply_filters('wp_title_rss', get_wp_title_rss($sep));
    2684}
    2785
     86/**
     87 * get_the_title_rss() - {@internal Missing Short Description}}
     88 *
     89 * {@internal Missing Long Description}}
     90 *
     91 * @since 2.0.0
     92 * @uses apply_filters()
     93 *
     94 * @return unknown
     95 */
    2896function get_the_title_rss() {
    2997        $title = get_the_title();
    3098        $title = apply_filters('the_title_rss', $title);
    3199        return $title;
    32100}
    33101
    34 
     102/**
     103 * the_title_rss() - {@internal Missing Short Description}}
     104 *
     105 * {@internal Missing Long Description}}
     106 *
     107 * @since 0.71
     108 */
    35109function the_title_rss() {
    36110        echo get_the_title_rss();
    37111}
    38112
    39 
     113/**
     114 * the_content_rss() - {@internal Missing Short Description}}
     115 *
     116 * {@internal Missing Long Description}}
     117 *
     118 * @since 0.71
     119 * @uses apply_filters()
     120 *
     121 * @param unknown_type $more_link_text
     122 * @param unknown_type $stripteaser
     123 * @param unknown_type $more_file
     124 * @param unknown_type $cut
     125 * @param unknown_type $encode_html
     126 */
    40127function the_content_rss($more_link_text='(more...)', $stripteaser=0, $more_file='', $cut = 0, $encode_html = 0) {
    41128        $content = get_the_content($more_link_text, $stripteaser, $more_file);
    42129        $content = apply_filters('the_content_rss', $content);
    … …  
    68155        echo $content;
    69156}
    70157
    71 
     158/**
     159 * the_excerpt_rss() - {@internal Missing Short Description}}
     160 *
     161 * {@internal Missing Long Description}}
     162 *
     163 * @since 0.71
     164 * @uses apply_filters()
     165 */
    72166function the_excerpt_rss() {
    73167        $output = get_the_excerpt();
    74168        echo apply_filters('the_excerpt_rss', $output);
    75169}
    76170
     171/**
     172 * the_permalink_rss() - {@internal Missing Short Description}}
     173 *
     174 * {@internal Missing Long Description}}
     175 *
     176 * @since 2.3.0
     177 * @uses apply_filters()
     178 */
    77179function the_permalink_rss() {
    78180        echo apply_filters('the_permalink_rss', get_permalink());
    79 
    80181}
    81182
     183/**
     184 * comment_link() - {@internal Missing Short Description}}
     185 *
     186 * {@internal Missing Long Description}}
     187 *
     188 * @since 1.5.0
     189 */
    82190function comment_link() {
    83191        echo get_comment_link();
    84192}
    85193
     194/**
     195 * get_comment_author_rss() - {@internal Missing Short Description}}
     196 *
     197 * {@internal Missing Long Description}}
     198 *
     199 * @since 2.0.0
     200 * @uses apply_filters()
     201 *
     202 * @return unknown
     203 */
    86204function get_comment_author_rss() {
    87205        return apply_filters('comment_author_rss', get_comment_author() );
    88206}
    89207
     208/**
     209 * comment_author_rss() - {@internal Missing Short Description}}
     210 *
     211 * {@internal Missing Long Description}}
     212 *
     213 * @since 1.0.0
     214 */
    90215function comment_author_rss() {
    91216        echo get_comment_author_rss();
    92217}
    93218
     219/**
     220 * comment_text_rss() - {@internal Missing Short Description}}
     221 *
     222 * {@internal Missing Long Description}}
     223 *
     224 * @since 1.0.0
     225 * @uses apply_filters()
     226 */
    94227function comment_text_rss() {
    95228        $comment_text = get_comment_text();
    96229        $comment_text = apply_filters('comment_text_rss', $comment_text);
    97230        echo $comment_text;
    98231}
    99232
     233/**
     234 * get_the_category_rss() - {@internal Missing Short Description}}
     235 *
     236 * {@internal Missing Long Description}}
     237 *
     238 * @since 2.1.0
     239 * @uses apply_filters()
     240 *
     241 * @param unknown_type $type
     242 * @return unknown
     243 */
    100244function get_the_category_rss($type = 'rss') {
    101245        $categories = get_the_category();
    102246        $tags = get_the_tags();
    … …  
    129273        return apply_filters('the_category_rss', $the_list, $type);
    130274}
    131275
     276/**
     277 * the_category_rss() - {@internal Missing Short Description}}
     278 *
     279 * {@internal Missing Long Description}}
     280 *
     281 * @since 0.71
     282 *
     283 * @param unknown_type $type
     284 */
    132285function the_category_rss($type = 'rss') {
    133286        echo get_the_category_rss($type);
    134287}
    135288
     289/**
     290 * html_type_rss() - {@internal Missing Short Description}}
     291 *
     292 * {@internal Missing Long Description}}
     293 *
     294 * @since 2.2.0
     295 */
    136296function html_type_rss() {
    137297        $type = get_bloginfo('html_type');
    138298        if (strpos($type, 'xhtml') !== false)
    … …  
    142302        echo $type;
    143303}
    144304
    145 
     305/**
     306 * rss_enclosure() - {@internal Missing Short Description}}
     307 *
     308 * {@internal Missing Long Description}}
     309 *
     310 * @since 1.5.0
     311 * @uses apply_filters()
     312 */
    146313function rss_enclosure() {
    147314        global $post;
    148315        if ( !empty($post->post_password) && ($_COOKIE['wp-postpass_'.COOKIEHASH] != $post->post_password) )
    … …  
    158325        }
    159326}
    160327
     328/**
     329 * atom_enclosure() - {@internal Missing Short Description}}
     330 *
     331 * {@internal Missing Long Description}}
     332 *
     333 * @since 2.2.0
     334 * @uses apply_filters()
     335 */
    161336function atom_enclosure() {
    162337        global $post;
    163338        if ( !empty($post->post_password) && ($_COOKIE['wp-postpass_'.COOKIEHASH] != $post->post_password) )
    … …  
    174349}
    175350
    176351/**
    177  * prep_atom_text_construct() - Determine the type of a given string of data
     352 * prep_atom_text_construct() - Determine the type of a string of data
    178353 *
    179354 * Tell whether the type is text, html, or xhtml, per RFC 4287 section 3.1.
    180355 *
    … …  
    185360 *
    186361 * @link http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.3.1
    187362 *
    188  * @package WordPress
    189  * @subpackage Feed
    190  * @since 2.4
     363 * @since 2.5
    191364 *
    192365 * @param string $data input string
    193366 * @return array $result array(type, value)