Show
Ignore:
Timestamp:
10/10/08 18:21:16 (2 months ago)
Author:
ryan
Message:

phpdoc for wp-admin. Props jacobsantos. see #7527

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/wp-admin/edit-form-advanced.php

    r9103 r9119  
    5656 
    5757// All meta boxes should be defined and added before the first do_meta_boxes() call (or potentially during the do_meta_boxes action). 
     58 
     59/** 
     60 * Display post submit form fields. 
     61 * 
     62 * @since 2.7.0 
     63 * 
     64 * @param object $post 
     65 */ 
    5866function post_submit_meta_box($post) { 
    5967    global $action; 
     
    187195add_meta_box('submitdiv', __('Publish'), 'post_submit_meta_box', 'post', 'side', 'core'); 
    188196 
     197/** 
     198 * Display post tags form fields. 
     199 * 
     200 * @since 2.6.0 
     201 * 
     202 * @param object $post 
     203 */ 
    189204function post_tags_meta_box($post) { 
    190205?> 
     
    196211add_meta_box('tagsdiv', __('Tags'), 'post_tags_meta_box', 'post', 'side', 'core'); 
    197212 
     213/** 
     214 * Display add post media and current post media form fields and images. 
     215 * 
     216 * @todo Complete. 
     217 * @since 2.7.0 
     218 * 
     219 * @param object $post 
     220 */ 
    198221function post_media_meta_box($post) { 
    199222    echo "<p><small><em>This feature isn't fully functional in this prototype.</em></small></p>"; 
     
    232255add_meta_box( 'mediadiv', __('Media' ), 'post_media_meta_box', 'post', 'side', 'core' ); 
    233256 
     257/** 
     258 * Display post categories form fields. 
     259 * 
     260 * @since 2.6.0 
     261 * 
     262 * @param object $post 
     263 */ 
    234264function post_categories_meta_box($post) { 
    235265?> 
     
    266296add_meta_box('categorydiv', __('Categories'), 'post_categories_meta_box', 'post', 'side', 'core'); 
    267297 
     298/** 
     299 * Display post excerpt form fields. 
     300 * 
     301 * @since 2.6.0 
     302 * 
     303 * @param object $post 
     304 */ 
    268305function post_excerpt_meta_box($post) { 
    269306?> 
     
    274311add_meta_box('postexcerpt', __('Excerpt'), 'post_excerpt_meta_box', 'post', 'normal', 'core'); 
    275312 
     313/** 
     314 * Display trackback links form fields. 
     315 * 
     316 * @since 2.6.0 
     317 * 
     318 * @param object $post 
     319 */ 
    276320function post_trackback_meta_box($post) { 
    277321    $form_trackback = '<input type="text" name="trackback_url" id="trackback_url" tabindex="7" value="'. attribute_escape( str_replace("\n", ' ', $post->to_ping) ) .'" />'; 
     
    297341add_meta_box('trackbacksdiv', __('Trackbacks and Pings'), 'post_trackback_meta_box', 'post', 'normal', 'core'); 
    298342 
     343/** 
     344 * Display custom fields for the post form fields. 
     345 * 
     346 * @since 2.6.0 
     347 * 
     348 * @param object $post 
     349 */ 
    299350function post_custom_meta_box($post) { 
    300351?> 
     
    319370do_action('dbx_post_advanced'); 
    320371 
     372/** 
     373 * Display comment status for post form fields. 
     374 * 
     375 * @since 2.6.0 
     376 * 
     377 * @param object $post 
     378 */ 
    321379function post_comment_status_meta_box($post) { 
    322380    global $wpdb, $post_ID; 
     
    358416add_meta_box('commentstatusdiv', __('Comments on this Post'), 'post_comment_status_meta_box', 'post', 'normal', 'core'); 
    359417 
     418/** 
     419 * Display post password form fields. 
     420 * 
     421 * @since 2.6.0 
     422 * 
     423 * @param object $post 
     424 */ 
    360425function post_password_meta_box($post) { 
    361426?> 
     
    370435add_meta_box('passworddiv', __('Privacy Options'), 'post_password_meta_box', 'post', 'normal', 'core'); 
    371436 
     437/** 
     438 * Display post slug form fields. 
     439 * 
     440 * @since 2.6.0 
     441 * 
     442 * @param object $post 
     443 */ 
    372444function post_slug_meta_box($post) { 
    373445?> 
     
    382454    $authors[] = $post->post_author; 
    383455if ( $authors && count( $authors ) > 1 ) : 
     456/** 
     457 * Display form field with list of authors. 
     458 * 
     459 * @since 2.6.0 
     460 * 
     461 * @param object $post 
     462 */ 
    384463function post_author_meta_box($post) { 
    385464    global $current_user, $user_ID; 
     
    395474 
    396475if ( 0 < $post_ID && wp_get_post_revisions( $post_ID ) ) : 
     476/** 
     477 * Display list of post revisions. 
     478 * 
     479 * @since 2.6.0 
     480 * 
     481 * @param object $post 
     482 */ 
    397483function post_revisions_meta_box($post) { 
    398484    wp_list_post_revisions();