WordPress.org

Make WordPress Core

Changeset 8809


Ignore:
Timestamp:
09/04/08 23:12:08 (7 years ago)
Author:
ryan
Message:

Skeleton phpdoc for post-template.php. Props jacobsantos. see #7659

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/post-template.php

    r8800 r8809  
    11<?php 
    2  
    3 // 
    4 // "The Loop" post functions 
    5 // 
    6  
     2/** 
     3 * WordPress Post Template Functions 
     4 * 
     5 * Gets content for the current post in the loop. 
     6 * 
     7 * @package WordPress 
     8 * @subpackage Template 
     9 */ 
     10 
     11/** 
     12 * the_ID() - {@internal Missing Short Description}} 
     13 * 
     14 * {@internal Missing Long Description}} 
     15 * 
     16 * @since 0.71 
     17 * @uses $id 
     18 */ 
    719function the_ID() { 
    820    global $id; 
     
    1022} 
    1123 
    12  
     24/** 
     25 * get_the_ID() - {@internal Missing Short Description}} 
     26 * 
     27 * {@internal Missing Long Description}} 
     28 * 
     29 * @since 2.1.0 
     30 * @uses $id 
     31 * 
     32 * @return unknown 
     33 */ 
    1334function get_the_ID() { 
    1435    global $id; 
     
    1637} 
    1738 
    18  
     39/** 
     40 * the_title() - {@internal Missing Short Description}} 
     41 * 
     42 * {@internal Missing Long Description}} 
     43 * 
     44 * @since 0.71 
     45 * 
     46 * @param unknown_type $before 
     47 * @param unknown_type $after 
     48 * @param unknown_type $echo 
     49 * @return unknown 
     50 */ 
    1951function the_title($before = '', $after = '', $echo = true) { 
    2052    $title = get_the_title(); 
     
    3163} 
    3264 
     65/** 
     66 * the_title_attribute() - {@internal Missing Short Description}} 
     67 * 
     68 * {@internal Missing Long Description}} 
     69 * 
     70 * @since 2.3.0 
     71 * 
     72 * @param unknown_type $args 
     73 * @return unknown 
     74 */ 
    3375function the_title_attribute( $args = '' ) { 
    3476    $title = get_the_title(); 
     
    5193} 
    5294 
     95/** 
     96 * get_the_title() - {@internal Missing Short Description}} 
     97 * 
     98 * {@internal Missing Long Description}} 
     99 * 
     100 * @since 0.71 
     101 * 
     102 * @param unknown_type $id 
     103 * @return unknown 
     104 */ 
    53105function get_the_title( $id = 0 ) { 
    54106    $post = &get_post($id); 
     
    65117} 
    66118 
     119/** 
     120 * the_guid() - {@internal Missing Short Description}} 
     121 * 
     122 * {@internal Missing Long Description}} 
     123 * 
     124 * @since 1.5.0 
     125 * 
     126 * @param unknown_type $id 
     127 */ 
    67128function the_guid( $id = 0 ) { 
    68129    echo get_the_guid($id); 
    69130} 
    70131 
     132/** 
     133 * get_the_guid() - {@internal Missing Short Description}} 
     134 * 
     135 * {@internal Missing Long Description}} 
     136 * 
     137 * @since 1.5.0 
     138 * 
     139 * @param unknown_type $id 
     140 * @return unknown 
     141 */ 
    71142function get_the_guid( $id = 0 ) { 
    72143    $post = &get_post($id); 
     
    75146} 
    76147 
     148/** 
     149 * the_content() - {@internal Missing Short Description}} 
     150 * 
     151 * {@internal Missing Long Description}} 
     152 * 
     153 * @since 0.71 
     154 * 
     155 * @param unknown_type $more_link_text 
     156 * @param unknown_type $stripteaser 
     157 * @param unknown_type $more_file 
     158 */ 
    77159function the_content($more_link_text = NULL, $stripteaser = 0, $more_file = '') { 
    78160    $content = get_the_content($more_link_text, $stripteaser, $more_file); 
     
    82164} 
    83165 
    84  
     166/** 
     167 * get_the_content() - {@internal Missing Short Description}} 
     168 * 
     169 * {@internal Missing Long Description}} 
     170 * 
     171 * @since 0.71 
     172 * 
     173 * @param unknown_type $more_link_text 
     174 * @param unknown_type $stripteaser 
     175 * @param unknown_type $more_file 
     176 * @return unknown 
     177 */ 
    85178function get_the_content($more_link_text = NULL, $stripteaser = 0, $more_file = '') { 
    86179    global $id, $post, $more, $page, $pages, $multipage, $preview, $pagenow; 
     
    134227} 
    135228 
    136  
     229/** 
     230 * the_excerpt() - {@internal Missing Short Description}} 
     231 * 
     232 * {@internal Missing Long Description}} 
     233 * 
     234 * @since 0.71 
     235 * @uses apply_filters() -  
     236 */ 
    137237function the_excerpt() { 
    138238    echo apply_filters('the_excerpt', get_the_excerpt()); 
    139239} 
    140240 
    141  
     241/** 
     242 * get_the_excerpt() - {@internal Missing Short Description}} 
     243 * 
     244 * {@internal Missing Long Description}} 
     245 * 
     246 * @since 0.71 
     247 * 
     248 * @param unknown_type $deprecated 
     249 * @return unknown 
     250 */ 
    142251function get_the_excerpt($deprecated = '') { 
    143252    global $post; 
     
    152261} 
    153262 
     263/** 
     264 * has_excerpt() - {@internal Missing Short Description}} 
     265 * 
     266 * {@internal Missing Long Description}} 
     267 * 
     268 * @since 2.3.0 
     269 * 
     270 * @param unknown_type $id 
     271 * @return unknown 
     272 */ 
    154273function has_excerpt( $id = 0 ) { 
    155274    $post = &get_post( $id ); 
     
    269388} 
    270389 
     390/** 
     391 * wp_link_pages() - {@internal Missing Short Description}} 
     392 * 
     393 * {@internal Missing Long Description}} 
     394 * 
     395 * @since 1.2.0 
     396 * 
     397 * @param unknown_type $args 
     398 * @return unknown 
     399 */ 
    271400function wp_link_pages($args = '') { 
    272401    $defaults = array( 
     
    349478// 
    350479 
    351  
     480/** 
     481 * post_custom() - {@internal Missing Short Description}} 
     482 * 
     483 * {@internal Missing Long Description}} 
     484 * 
     485 * @since 1.5.0 
     486 * 
     487 * @param unknown_type $key 
     488 * @return unknown 
     489 */ 
    352490function post_custom( $key = '' ) { 
    353491    $custom = get_post_custom(); 
     
    361499 
    362500// this will probably change at some point... 
     501/** 
     502 * the_meta() - {@internal Missing Short Description}} 
     503 * 
     504 * {@internal Missing Long Description}} 
     505 * 
     506 * @since 1.2.0 
     507 * @uses apply_filters()  
     508 */ 
    363509function the_meta() { 
    364510    if ( $keys = get_post_custom_keys() ) { 
     
    381527// 
    382528 
     529/** 
     530 * wp_dropdown_pages() - {@internal Missing Short Description}} 
     531 * 
     532 * {@internal Missing Long Description}} 
     533 * 
     534 * @since 2.1.0 
     535 * 
     536 * @param unknown_type $args 
     537 * @return unknown 
     538 */ 
    383539function wp_dropdown_pages($args = '') { 
    384540    $defaults = array( 
     
    410566} 
    411567 
     568/** 
     569 * wp_list_pages() - {@internal Missing Short Description}} 
     570 * 
     571 * {@internal Missing Long Description}} 
     572 * 
     573 * @since 1.5.0 
     574 * 
     575 * @param unknown_type $args 
     576 * @return unknown 
     577 */ 
    412578function wp_list_pages($args = '') { 
    413579    $defaults = array( 
     
    460626// 
    461627 
     628/** 
     629 * walk_page_tree() - {@internal Missing Short Description}} 
     630 * 
     631 * {@internal Missing Long Description}} 
     632 * 
     633 * @since 2.1.0 
     634 * 
     635 * @return unknown 
     636 */ 
    462637function walk_page_tree() { 
    463638    $walker = new Walker_Page; 
     
    466641} 
    467642 
     643/** 
     644 * walk_page_dropdown_tree() - {@internal Missing Short Description}} 
     645 * 
     646 * {@internal Missing Long Description}} 
     647 * 
     648 * @since 2.1.0 
     649 * 
     650 * @return unknown 
     651 */ 
    468652function walk_page_dropdown_tree() { 
    469653    $walker = new Walker_PageDropdown; 
     
    476660// 
    477661 
     662/** 
     663 * the_attachment_link() - {@internal Missing Short Description}} 
     664 * 
     665 * {@internal Missing Long Description}} 
     666 * 
     667 * @since 2.0.0 
     668 * 
     669 * @param unknown_type $id 
     670 * @param unknown_type $fullsize 
     671 * @param unknown_type $max_dims 
     672 */ 
    478673function the_attachment_link($id = 0, $fullsize = false, $deprecated = false, $permalink = false) { 
    479674    if ( $fullsize ) 
     
    523718 
    524719// deprecated: use wp_get_attachment_image_src() 
     720/** 
     721 * get_attachment_icon_src() - {@internal Missing Short Description}} 
     722 * 
     723 * {@internal Missing Long Description}} 
     724 * 
     725 * @since 2.1.0 
     726 * 
     727 * @param unknown_type $id 
     728 * @param unknown_type $fullsize 
     729 * @return unknown 
     730 */ 
    525731function get_attachment_icon_src( $id = 0, $fullsize = false ) { 
    526732    $id = (int) $id; 
     
    555761 
    556762// deprecated: use wp_get_attachment_image() 
     763/** 
     764 * get_attachment_icon() - {@internal Missing Short Description}} 
     765 * 
     766 * {@internal Missing Long Description}} 
     767 * 
     768 * @since 2.0.0 
     769 * 
     770 * @param unknown_type $id 
     771 * @param unknown_type $fullsize 
     772 * @param unknown_type $max_dims 
     773 * @return unknown 
     774 */ 
    557775function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) { 
    558776    $id = (int) $id; 
     
    599817 
    600818// deprecated: use wp_get_attachment_image() 
     819/** 
     820 * get_attachment_innerHTML() - {@internal Missing Short Description}} 
     821 * 
     822 * {@internal Missing Long Description}} 
     823 * 
     824 * @since 2.0.0 
     825 * 
     826 * @param unknown_type $id 
     827 * @param unknown_type $fullsize 
     828 * @param unknown_type $max_dims 
     829 * @return unknown 
     830 */ 
    601831function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) { 
    602832    $id = (int) $id; 
     
    613843} 
    614844 
     845/** 
     846 * prepend_attachment() - {@internal Missing Short Description}} 
     847 * 
     848 * {@internal Missing Long Description}} 
     849 * 
     850 * @since 2.0.0 
     851 * 
     852 * @param unknown_type $content 
     853 * @return unknown 
     854 */ 
    615855function prepend_attachment($content) { 
    616856    global $post; 
     
    632872// 
    633873 
     874/** 
     875 * get_the_password_form() - {@internal Missing Short Description}} 
     876 * 
     877 * {@internal Missing Long Description}} 
     878 * 
     879 * @since 1.0.0 
     880 * 
     881 * @return unknown 
     882 */ 
    634883function get_the_password_form() { 
    635884    global $post; 
     
    650899 * that template. 
    651900 * 
    652  * @package Template Tags 
    653  * @global object $wp_query 
     901 * @since 2.5.0 
     902 * @uses $wp_query 
     903 * 
    654904 * @param string $template The specific template name if specific matching is required 
     905 * @return bool False on failure, true if success 
    655906 */ 
    656907function is_page_template($template = '') { 
Note: See TracChangeset for help on using the changeset viewer.