Changeset 9053

Show
Ignore:
Timestamp:
10/02/08 01:03:26 (2 months ago)
Author:
ryan
Message:

phpdoc for wp-admin/includes from jacobsantos. see #7527

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/wp-admin/includes/bookmark.php

    r8758 r9053  
    11<?php 
    2  
     2/** 
     3 * WordPress Bookmark Administration API 
     4 * 
     5 * @package WordPress 
     6 * @subpackage Administration 
     7 */ 
     8 
     9/** 
     10 * {@internal Missing Short Description}} 
     11 * 
     12 * @since unknown 
     13 * 
     14 * @return unknown 
     15 */ 
    316function add_link() { 
    417    return edit_link(); 
    518} 
    619 
     20/** 
     21 * {@internal Missing Short Description}} 
     22 * 
     23 * @since unknown 
     24 * 
     25 * @param unknown_type $link_id 
     26 * @return unknown 
     27 */ 
    728function edit_link( $link_id = '' ) { 
    829    if (!current_user_can( 'manage_links' )) 
     
    2546} 
    2647 
     48/** 
     49 * {@internal Missing Short Description}} 
     50 * 
     51 * @since unknown 
     52 * 
     53 * @return unknown 
     54 */ 
    2755function get_default_link_to_edit() { 
    2856    if ( isset( $_GET['linkurl'] ) ) 
     
    4169} 
    4270 
     71/** 
     72 * {@internal Missing Short Description}} 
     73 * 
     74 * @since unknown 
     75 * 
     76 * @param unknown_type $link_id 
     77 * @return unknown 
     78 */ 
    4379function wp_delete_link($link_id) { 
    4480    global $wpdb; 
     
    5793} 
    5894 
     95/** 
     96 * {@internal Missing Short Description}} 
     97 * 
     98 * @since unknown 
     99 * 
     100 * @param unknown_type $link_id 
     101 * @return unknown 
     102 */ 
    59103function wp_get_link_cats($link_id = 0) { 
    60104 
     
    64108} 
    65109 
     110/** 
     111 * {@internal Missing Short Description}} 
     112 * 
     113 * @since unknown 
     114 * 
     115 * @param unknown_type $link_id 
     116 * @return unknown 
     117 */ 
    66118function get_link_to_edit( $link_id ) { 
    67119    return get_bookmark( $link_id, OBJECT, 'edit' ); 
    68120} 
    69121 
     122/** 
     123 * {@internal Missing Short Description}} 
     124 * 
     125 * @since unknown 
     126 * 
     127 * @param unknown_type $linkdata 
     128 * @return unknown 
     129 */ 
    70130function wp_insert_link($linkdata, $wp_error = false) { 
    71131    global $wpdb, $current_user; 
     
    155215} 
    156216 
     217/** 
     218 * {@internal Missing Short Description}} 
     219 * 
     220 * @since unknown 
     221 * 
     222 * @param unknown_type $link_id 
     223 * @param unknown_type $link_categories 
     224 */ 
    157225function wp_set_link_cats($link_id = 0, $link_categories = array()) { 
    158226    // If $link_categories isn't already an array, make it one: 
     
    168236}   // wp_set_link_cats() 
    169237 
     238/** 
     239 * {@internal Missing Short Description}} 
     240 * 
     241 * @since unknown 
     242 * 
     243 * @param unknown_type $linkdata 
     244 * @return unknown 
     245 */ 
    170246function wp_update_link($linkdata) { 
    171247    $link_id = (int) $linkdata['link_id']; 
  • trunk/wp-admin/includes/file.php

    r8880 r9053  
    11<?php 
    2  
     2/** 
     3 * File contains all the administration image manipulation functions. 
     4 * 
     5 * @package WordPress 
     6 * @subpackage Administration 
     7 */ 
     8 
     9/** The descriptions for theme files. */ 
    310$wp_file_descriptions = array ( 
    411    'index.php' => __( 'Main Index Template' ), 
    512    'style.css' => __( 'Stylesheet' ), 
    6     'rtl.css' => __( 'RTL Stylesheet' ),  
    7     'comments.php' => __( 'Comments' ),  
    8     'comments-popup.php' => __( 'Popup Comments' ),  
    9     'footer.php' => __( 'Footer' ),  
    10     'header.php' => __( 'Header' ),  
     13    'rtl.css' => __( 'RTL Stylesheet' ), 
     14    'comments.php' => __( 'Comments' ), 
     15    'comments-popup.php' => __( 'Popup Comments' ), 
     16    'footer.php' => __( 'Footer' ), 
     17    'header.php' => __( 'Header' ), 
    1118    'sidebar.php' => __( 'Sidebar' ), 
    1219    'archive.php' => __( 'Archives' ), 
     
    2835    // Deprecated files 
    2936    'wp-layout.css' => __( 'Stylesheet' ), 'wp-comments.php' => __( 'Comments Template' ), 'wp-comments-popup.php' => __( 'Popup Comments Template' )); 
     37 
     38/** 
     39 * {@internal Missing Short Description}} 
     40 * 
     41 * @since unknown 
     42 * 
     43 * @param unknown_type $file 
     44 * @return unknown 
     45 */ 
    3046function get_file_description( $file ) { 
    3147    global $wp_file_descriptions; 
     
    4359} 
    4460 
     61/** 
     62 * {@internal Missing Short Description}} 
     63 * 
     64 * @since unknown 
     65 * 
     66 * @return unknown 
     67 */ 
    4568function get_home_path() { 
    4669    $home = get_option( 'home' ); 
     
    5780} 
    5881 
     82/** 
     83 * {@internal Missing Short Description}} 
     84 * 
     85 * @since unknown 
     86 * 
     87 * @param unknown_type $file 
     88 * @return unknown 
     89 */ 
    5990function get_real_file_to_edit( $file ) { 
    6091    if ('index.php' == $file || '.htaccess' == $file ) { 
     
    6697    return $real_file; 
    6798} 
    68 //$folder = Full path to folder 
    69 //$levels = Levels of folders to follow, Default: 100 (PHP Loop limit) 
     99 
     100/** 
     101 * {@internal Missing Short Description}} 
     102 * 
     103 * @since unknown 
     104 * 
     105 * @param string $folder Optional. Full path to folder 
     106 * @param int $levels Optional. Levels of folders to follow, Default: 100 (PHP Loop limit). 
     107 * @return bool|array 
     108 */ 
    70109function list_files( $folder = '', $levels = 100 ) { 
    71110    if( empty($folder) ) 
     
    95134} 
    96135 
     136/** 
     137 * {@internal Missing Short Description}} 
     138 * 
     139 * @since unknown 
     140 * 
     141 * @return unknown 
     142 */ 
    97143function get_temp_dir() { 
    98144    if ( defined('WP_TEMP_DIR') ) 
     
    109155} 
    110156 
     157/** 
     158 * {@internal Missing Short Description}} 
     159 * 
     160 * @since unknown 
     161 * 
     162 * @param unknown_type $filename 
     163 * @param unknown_type $dir 
     164 * @return unknown 
     165 */ 
    111166function wp_tempnam($filename = '', $dir = ''){ 
    112167    if ( empty($dir) ) 
     
    121176} 
    122177 
     178/** 
     179 * {@internal Missing Short Description}} 
     180 * 
     181 * @since unknown 
     182 * 
     183 * @param unknown_type $file 
     184 * @param unknown_type $allowed_files 
     185 * @return unknown 
     186 */ 
    123187function validate_file_to_edit( $file, $allowed_files = '' ) { 
    124188    $file = stripslashes( $file ); 
     
    141205} 
    142206 
    143 // array wp_handle_upload ( array &file [, array overrides] ) 
    144 // file: reference to a single element of $_FILES. Call the function once for each uploaded file. 
    145 // overrides: an associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE ). 
    146 // On success, returns an associative array of file attributes. 
    147 // On failure, returns $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ). 
     207/** 
     208 * {@internal Missing Short Description}} 
     209 * 
     210 * @since unknown 
     211 * 
     212 * @param array $file Reference to a single element of $_FILES. Call the function once for each uploaded file. 
     213 * @param array $overrides Optional. An associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE ). 
     214 * @return array On success, returns an associative array of file attributes. On failure, returns $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ). 
     215 */ 
    148216function wp_handle_upload( &$file, $overrides = false ) { 
    149217    // The default error handler. 
     
    237305    return $return; 
    238306} 
    239 // Pass this function an array similar to that of a $_FILES POST array. 
     307 
     308/** 
     309 * {@internal Missing Short Description}} 
     310 * 
     311 * Pass this function an array similar to that of a $_FILES POST array. 
     312 * 
     313 * @since unknown 
     314 * 
     315 * @param unknown_type $file 
     316 * @param unknown_type $overrides 
     317 * @return unknown 
     318 */ 
    240319function wp_handle_sideload( &$file, $overrides = false ) { 
    241320    // The default error handler. 
     
    335414 
    336415/** 
    337 * Downloads a url to a local file using the Snoopy HTTP Class 
    338 
    339 * @param string $url the URL of the file to download 
    340 * @return mixed WP_Error on failure, string Filename on success. 
    341 */ 
     416 * Downloads a url to a local file using the Snoopy HTTP Class. 
     417 * 
     418 * @since unknown 
     419 * @todo Transition over to using the new HTTP Request API (jacob). 
     420 * 
     421 * @param string $url the URL of the file to download 
     422 * @return mixed WP_Error on failure, string Filename on success. 
     423 */ 
    342424function download_url( $url ) { 
    343425    //WARNING: The file is not automatically deleted, The script must unlink() the file. 
     
    368450} 
    369451 
     452/** 
     453 * {@internal Missing Short Description}} 
     454 * 
     455 * @since unknown 
     456 * 
     457 * @param unknown_type $file 
     458 * @param unknown_type $to 
     459 * @return unknown 
     460 */ 
    370461function unzip_file($file, $to) { 
    371462    global $wp_filesystem; 
     
    428519} 
    429520 
     521/** 
     522 * {@internal Missing Short Description}} 
     523 * 
     524 * @since unknown 
     525 * 
     526 * @param unknown_type $from 
     527 * @param unknown_type $to 
     528 * @return unknown 
     529 */ 
    430530function copy_dir($from, $to) { 
    431531    global $wp_filesystem; 
     
    453553} 
    454554 
     555/** 
     556 * {@internal Missing Short Description}} 
     557 * 
     558 * @since unknown 
     559 * 
     560 * @param unknown_type $args 
     561 * @return unknown 
     562 */ 
    455563function WP_Filesystem( $args = false ) { 
    456564    global $wp_filesystem; 
     
    481589} 
    482590 
     591/** 
     592 * {@internal Missing Short Description}} 
     593 * 
     594 * @since unknown 
     595 * 
     596 * @param unknown_type $args 
     597 * @return unknown 
     598 */ 
    483599function get_filesystem_method($args = array()) { 
    484600    $method = false; 
     
    496612} 
    497613 
     614/** 
     615 * {@internal Missing Short Description}} 
     616 * 
     617 * @since unknown 
     618 * 
     619 * @param unknown_type $form_post 
     620 * @param unknown_type $type 
     621 * @param unknown_type $error 
     622 * @return unknown 
     623 */ 
    498624function request_filesystem_credentials($form_post, $type = '', $error = false) { 
    499625    $req_cred = apply_filters('request_filesystem_credentials', '', $form_post, $type, $error); 
  • trunk/wp-admin/includes/image.php

    r8912 r9053  
    222222 
    223223/** 
    224  * Get extended image metadata, exif or iptc as available 
     224 * Get extended image metadata, exif or iptc as available. 
    225225 * 
    226226 * @since unknown 
  • trunk/wp-admin/includes/import.php

    r6477 r9053  
    11<?php 
     2/** 
     3 * WordPress Administration Importer API. 
     4 * 
     5 * @package WordPress 
     6 * @subpackage Administration 
     7 */ 
    28 
     9/** 
     10 * {@internal Missing Short Description}} 
     11 * 
     12 * @since unknown 
     13 * 
     14 * @return unknown 
     15 */ 
    316function get_importers() { 
    417    global $wp_importers; 
     
    821} 
    922 
     23/** 
     24 * {@internal Missing Short Description}} 
     25 * 
     26 * @since unknown 
     27 * 
     28 * @param unknown_type $id 
     29 * @param unknown_type $name 
     30 * @param unknown_type $description 
     31 * @param unknown_type $callback 
     32 * @return unknown 
     33 */ 
    1034function register_importer( $id, $name, $description, $callback ) { 
    1135    global $wp_importers; 
     
    1539} 
    1640 
     41/** 
     42 * {@internal Missing Short Description}} 
     43 * 
     44 * @since unknown 
     45 * 
     46 * @param unknown_type $id 
     47 */ 
    1748function wp_import_cleanup( $id ) { 
    1849    wp_delete_attachment( $id ); 
    1950} 
    2051 
     52/** 
     53 * {@internal Missing Short Description}} 
     54 * 
     55 * @since unknown 
     56 * 
     57 * @return unknown 
     58 */ 
    2159function wp_import_handle_upload() { 
    2260    $overrides = array( 'test_form' => false, 'test_type' => false ); 
  • trunk/wp-admin/includes/media.php

    r9014 r9053  
    11<?php 
    2  
     2/** 
     3 * WordPress Administration Media API. 
     4 * 
     5 * @package WordPress 
     6 * @subpackage Administration 
     7 */ 
     8 
     9/** 
     10 * {@internal Missing Short Description}} 
     11 * 
     12 * @since unknown 
     13 * 
     14 * @return unknown 
     15 */ 
    316function media_upload_tabs() { 
    417    $_default_tabs = array( 
     
    1124} 
    1225 
     26/** 
     27 * {@internal Missing Short Description}} 
     28 * 
     29 * @since unknown 
     30 * 
     31 * @param unknown_type $tabs 
     32 * @return unknown 
     33 */ 
    1334function update_gallery_tab($tabs) { 
    1435    global $wpdb; 
     
    2647add_filter('media_upload_tabs', 'update_gallery_tab'); 
    2748 
     49/** 
     50 * {@internal Missing Short Description}} 
     51 * 
     52 * @since unknown 
     53 */ 
    2854function the_media_upload_tabs() { 
    2955    global $redir_tab; 
     
    5278} 
    5379 
     80/** 
     81 * {@internal Missing Short Description}} 
     82 * 
     83 * @since unknown 
     84 * 
     85 * @param unknown_type $id 
     86 * @param unknown_type $alt 
     87 * @param unknown_type $title 
     88 * @param unknown_type $align 
     89 * @param unknown_type $url 
     90 * @param unknown_type $rel 
     91 * @param unknown_type $size 
     92 * @return unknown 
     93 */ 
    5494function get_image_send_to_editor($id, $alt, $title, $align, $url='', $rel = false, $size='medium') { 
    5595 
     
    66106} 
    67107 
     108/** 
     109 * {@internal Missing Short Description}} 
     110 * 
     111 * @since unknown 
     112 * 
     113 * @param unknown_type $html 
     114 * @param unknown_type $id 
     115 * @param unknown_type $alt 
     116 * @param unknown_type $title 
     117 * @param unknown_type $align 
     118 * @param unknown_type $url 
     119 * @param unknown_type $size 
     120 * @return unknown 
     121 */ 
    68122function image_add_caption( $html, $id, $alt, $title, $align, $url, $size ) { 
    69123 
     
    85139add_filter( 'image_send_to_editor', 'image_add_caption', 20, 7 ); 
    86140 
     141/** 
     142 * {@internal Missing Short Description}} 
     143 * 
     144 * @since unknown 
     145 * 
     146 * @param unknown_type $html 
     147 */ 
    87148function media_send_to_editor($html) { 
    88    ?> 
     149?> 
    89150<script type="text/javascript"> 
    90151/* <![CDATA[ */ 
     
    97158} 
    98159 
    99 // this handles the file upload POST itself, creating the attachment post 
     160/** 
     161 * {@internal Missing Short Description}} 
     162 * 
     163 * This handles the file upload POST itself, creating the attachment post. 
     164 * 
     165 * @since unknown 
     166 * 
     167 * @param unknown_type $file_id 
     168 * @param unknown_type $post_id 
     169 * @param unknown_type $post_data 
     170 * @return unknown 
     171 */ 
    100172function media_handle_upload($file_id, $post_id, $post_data = array()) { 
    101173    $overrides = array('test_form'=>false); 
     
    138210} 
    139211 
     212/** 
     213 * {@internal Missing Short Description}} 
     214 * 
     215 * @since unknown 
     216 * 
     217 * @param unknown_type $file_array 
     218 * @param unknown_type $post_id 
     219 * @param unknown_type $desc 
     220 * @param unknown_type $post_data 
     221 * @return unknown 
     222 */ 
    140223function media_handle_sideload($file_array, $post_id, $desc = null, $post_data = array()) { 
    141224    $overrides = array('test_form'=>false); 
     
    179262} 
    180263 
    181  
    182 // wrap iframe content (produced by $content_func) in a doctype, html head/body etc 
    183 // any additional function args will be passed to content_func 
     264/** 
     265 * {@internal Missing Short Description}} 
     266 * 
     267 * Wrap iframe content (produced by $content_func) in a doctype, html head/body 
     268 * etc any additional function args will be passed to content_func. 
     269 * 
     270 * @since unknown 
     271 * 
     272 * @param unknown_type $content_func 
     273 */ 
    184274function wp_iframe($content_func /* ... */) { 
    185275?> 
     
    221311} 
    222312 
     313/** 
     314 * {@internal Missing Short Description}} 
     315 * 
     316 * @since unknown 
     317 */ 
    223318function media_buttons() { 
    224319    global $post_ID, $temp_ID; 
     
    246341add_action('media_upload_media', 'media_upload_handler'); 
    247342 
     343/** 
     344 * {@internal Missing Short Description}} 
     345 * 
     346 * @since unknown 
     347 * 
     348 * @return unknown 
     349 */ 
    248350function media_upload_form_handler() { 
    249351    check_admin_referer('media-form'); 
     
    295397} 
    296398 
     399/** 
     400 * {@internal Missing Short Description}} 
     401 * 
     402 * @since unknown 
     403 * 
     404 * @return unknown 
     405 */ 
    297406function media_upload_image() { 
    298407    $errors = array(); 
     
    340449} 
    341450 
     451/** 
     452 * {@internal Missing Short Description}} 
     453 * 
     454 * @since unknown 
     455 * 
     456 * @param unknown_type $file 
     457 * @param unknown_type $post_id 
     458 * @param unknown_type $desc 
     459 * @return unknown 
     460 */ 
    342461function media_sideload_image($file, $post_id, $desc = null) { 
    343462    if (!empty($file) ) { 
     
    368487} 
    369488 
     489/** 
     490 * {@internal Missing Short Description}} 
     491 * 
     492 * @since unknown 
     493 * 
     494 * @return unknown 
     495 */ 
    370496function media_upload_audio() { 
    371497    $errors = array(); 
     
    411537} 
    412538 
     539/** 
     540 * {@internal Missing Short Description}} 
     541 * 
     542 * @since unknown 
     543 * 
     544 * @return unknown 
     545 */ 
    413546function media_upload_video() { 
    414547    $errors = array(); 
     
    454587} 
    455588 
     589/** 
     590 * {@internal Missing Short Description}} 
     591 * 
     592 * @since unknown 
     593 * 
     594 * @return unknown 
     595 */ 
    456596function media_upload_file() { 
    457597    $errors = array(); 
     
    497637} 
    498638 
     639/** 
     640 * {@internal Missing Short Description}} 
     641 * 
     642 * @since unknown 
     643 * 
     644 * @return unknown 
     645 */ 
    499646function media_upload_gallery() { 
    500647    $errors = array(); 
     
    513660} 
    514661 
     662/** 
     663 * {@internal Missing Short Description}} 
     664 * 
     665 * @since unknown 
     666 * 
     667 * @return unknown 
     668 */ 
    515669function media_upload_library() { 
    516670    $errors = array(); 
     
    528682 
    529683// produce HTML for the image alignment radio buttons with the specified one checked 
     684/** 
     685 * {@internal Missing Short Description}} 
     686 * 
     687 * @since unknown 
     688 * 
     689 * @param unknown_type $post 
     690 * @param unknown_type $checked 
     691 * @return unknown 
     692 */ 
    530693function image_align_input_fields($post, $checked='') { 
    531694     
     
    545708 
    546709// produce HTML for the size radio buttons with the specified one checked 
     710/** 
     711 * {@internal Missing Short Description}} 
     712 * 
     713 * @since unknown 
     714 * 
     715 * @param unknown_type $post 
     716 * @param unknown_type $checked 
     717 * @return unknown 
     718 */ 
    547719function image_size_input_fields($post, $checked='') { 
    548720         
     
    583755 
    584756// produce HTML for the Link URL buttons with the default link type as specified 
     757/** 
     758 * {@internal Missing Short Description}} 
     759 * 
     760 * @since unknown 
     761 * 
     762 * @param unknown_type $post 
     763 * @param unknown_type $url_type 
     764 * @return unknown 
     765 */ 
    585766function image_link_input_fields($post, $url_type='') { 
    586767 
     
    603784} 
    604785 
     786/** 
     787 * {@internal Missing Short Description}} 
     788 * 
     789 * @since unknown 
     790 * 
     791 * @param unknown_type $form_fields 
     792 * @param unknown_type $post 
     793 * @return unknown 
     794 */ 
    605795function image_attachment_fields_to_edit($form_fields, $post) { 
    606796    if ( substr($post->post_mime_type, 0, 5) == 'image' ) { 
     
    625815add_filter('attachment_fields_to_edit', 'image_attachment_fields_to_edit', 10, 2); 
    626816 
     817/** 
     818 * {@internal Missing Short Description}} 
     819 * 
     820 * @since unknown 
     821 * 
     822 * @param unknown_type $form_fields 
     823 * @param unknown_type $post 
     824 * @return unknown 
     825 */ 
    627826function media_single_attachment_fields_to_edit( $form_fields, $post ) { 
    628827    unset($form_fields['url'], $form_fields['align'], $form_fields['image-size']); 
     
    630829} 
    631830 
     831/** 
     832 * {@internal Missing Short Description}} 
     833 * 
     834 * @since unknown 
     835 * 
     836 * @param unknown_type $post 
     837 * @param unknown_type $attachment 
     838 * @return unknown 
     839 */ 
    632840function image_attachment_fields_to_save($post, $attachment) { 
    633841    if ( substr($post['post_mime_type'], 0, 5) == 'image' ) { 
     
    643851add_filter('attachment_fields_to_save', 'image_attachment_fields_to_save', 10, 2); 
    644852 
     853/** 
     854 * {@internal Missing Short Description}} 
     855 * 
     856 * @since unknown 
     857 * 
     858 * @param unknown_type $html 
     859 * @param unknown_type $attachment_id 
     860 * @param unknown_type $attachment 
     861 * @return unknown 
     862 */ 
    645863function image_media_send_to_editor($html, $attachment_id, $attachment) { 
    646864    $post =& get_post($attachment_id); 
     
    668886add_filter('media_send_to_editor', 'image_media_send_to_editor', 10, 3); 
    669887 
     888/** 
     889 * {@internal Missing Short Description}} 
     890 * 
     891 * @since unknown 
     892 * 
     893 * @param unknown_type $post 
     894 * @param unknown_type $errors 
     895 * @return unknown 
     896 */ 
    670897function get_attachment_fields_to_edit($post, $errors = null) { 
    671898    if ( is_int($post) ) 
     
    733960} 
    734961 
     962/** 
     963 * {@internal Missing Short Description}} 
     964 * 
     965 * @since unknown 
     966 * 
     967 * @param unknown_type $post_id 
     968 * @param unknown_type $errors 
     969 * @return unknown 
     970 */ 
    735971function get_media_items( $post_id, $errors ) { 
    736972    if ( $post_id ) { 
     
    756992} 
    757993 
     994/** 
     995 * {@internal Missing Short Description}} 
     996 * 
     997 * @since unknown 
     998 * 
     999 * @param unknown_type $attachment_id 
     1000 * @param unknown_type $args 
     1001 * @return unknown 
     1002 */ 
    7581003function get_media_item( $attachment_id, $args = null ) { 
    7591004    global $redir_tab; 
     
    9201165} 
    9211166 
     1167/** 
     1168 * {@internal Missing Short Description}} 
     1169 * 
     1170 * @since unknown 
     1171 */ 
    9221172function media_upload_header() { 
    9231173    ?> 
     
    9291179} 
    9301180 
     1181/** 
     1182 * {@internal Missing Short Description}} 
     1183 * 
     1184 * @since unknown 
     1185 * 
     1186 * @param unknown_type $errors 
     1187 */ 
    9311188function media_upload_form( $errors = null ) { 
    9321189    global $type, $tab; 
     
    10181275} 
    10191276 
     1277/** 
     1278 * {@internal Missing Short Description}} 
     1279 * 
     1280 * @since unknown 
     1281 * 
     1282 * @param unknown_type $type 
     1283 * @param unknown_type $errors 
     1284 * @param unknown_type $id 
     1285 */ 
    10201286function media_upload_type_form($type = 'file', $errors = null, $id = null) { 
    10211287    media_upload_header(); 
     
    11451411} 
    11461412 
     1413/** 
     1414 * {@internal Missing Short Description}} 
     1415 * 
     1416 * @since unknown 
     1417 * 
     1418 * @param unknown_type $errors 
     1419 */ 
    11471420function media_upload_gallery_form($errors) { 
    11481421    global $redir_tab; 
     
    11901463} 
    11911464 
     1465/** 
     1466 * {@internal Missing Short Description}} 
     1467 * 
     1468 * @since unknown 
     1469 * 
     1470 * @param unknown_type $errors 
     1471 */ 
    11921472function media_upload_library_form($errors) { 
    11931473    global $wpdb, $wp_query, $wp_locale, $type, $tab, $post_mime_types; 
     
    13361616} 
    13371617 
     1618/** 
     1619 * {@internal Missing Short Description}} 
     1620 * 
     1621 * @since unknown 
     1622 * 
     1623 * @return unknown 
     1624 */ 
    13381625function type_form_image() { 
    13391626 
     
    14121699} 
    14131700 
     1701/** 
     1702 * {@internal Missing Short Description}} 
     1703 * 
     1704 * @since unknown 
     1705 * 
     1706 * @return unknown 
     1707 */ 
    14141708function type_form_audio() { 
    14151709    return ' 
     
    14401734} 
    14411735 
     1736/** 
     1737 * {@internal Missing Short Description}} 
     1738 * 
     1739 * @since unknown 
     1740 * 
     1741 * @return unknown 
     1742 */ 
    14421743function type_form_video() { 
    14431744    return ' 
     
    14681769} 
    14691770 
     1771/** 
     1772 * {@internal Missing Short Description}} 
     1773 * 
     1774 * @since unknown 
     1775 * 
     1776 * @return unknown 
     1777 */ 
    14701778function type_form_file() { 
    14711779    return ' 
     
    14971805 
    14981806// support a GET parameter for disabling the flash uploader 
     1807/** 
     1808 * {@internal Missing Short Description}} 
     1809 * 
     1810 * @since unknown 
     1811 * 
     1812 * @param unknown_type $flash 
     1813 * @return unknown 
     1814 */ 
    14991815function media_upload_use_flash($flash) { 
    15001816    if ( array_key_exists('flash', $_REQUEST) ) 
     
    15051821add_filter('flash_uploader', 'media_upload_use_flash'); 
    15061822 
     1823/** 
     1824 * {@internal Missing Short Description}} 
     1825 * 
     1826 * @since unknown 
     1827 */ 
    15071828function media_upload_flash_bypass() { 
    15081829    echo '<p class="upload-flash-bypass">'; 
     
    15131834add_action('post-flash-upload-ui', 'media_upload_flash_bypass'); 
    15141835 
     1836/** 
     1837 * {@internal Missing Short Description}} 
     1838 * 
     1839 * @since unknown 
     1840 */ 
    15151841function media_upload_html_bypass() { 
    15161842    echo '<p class="upload-html-bypass">'; 
     
    15291855 
    15301856// make sure the GET parameter sticks when we submit a form 
     1857/** 
     1858 * {@internal Missing Short Description}} 
     1859 * 
     1860 * @since unknown 
     1861 * 
     1862 * @param unknown_type $url 
     1863 * @return unknown 
     1864 */ 
    15311865function media_upload_bypass_url($url) { 
    15321866    if ( array_key_exists('flash', $_REQUEST) ) 
  • trunk/wp-admin/includes/misc.php

    r8802 r9053  
    11<?php 
    2  
     2/** 
     3 * Misc WordPress Administration API. 
     4 * 
     5 * @package WordPress 
     6 * @subpackage Administration 
     7 */ 
     8 
     9/** 
     10 * {@internal Missing Short Description}} 
     11 * 
     12 * @since unknown 
     13 * 
     14 * @return unknown 
     15 */ 
    316function got_mod_rewrite() { 
    417    $got_rewrite = apache_mod_loaded('mod_rewrite', true); 
     
    619} 
    720 
    8 // Returns an array of strings from a file (.htaccess ) from between BEGIN 
    9 // and END markers. 
     21/** 
     22 * {@internal Missing Short Description}} 
     23 * 
     24 * @since unknown 
     25 * 
     26 * @param unknown_type $filename 
     27 * @param unknown_type $marker 
     28 * @return array An array of strings from a file (.htaccess ) from between BEGIN and END markers. 
     29 */ 
    1030function extract_from_markers( $filename, $marker ) { 
    1131    $result = array (); 
     
    3151} 
    3252 
    33 // Inserts an array of strings into a file (.htaccess ), placing it between 
    34 // BEGIN and END markers.  Replaces existing marked info.  Retains surrounding 
    35 // data.  Creates file if none exists. 
    36 // Returns true on write success, false on failure. 
     53/** 
     54 * {@internal Missing Short Description}} 
     55 * 
     56 * Inserts an array of strings into a file (.htaccess ), placing it between 
     57 * BEGIN and END markers. Replaces existing marked info. Retains surrounding 
     58 * data. Creates file if none exists. 
     59 * 
     60 * @since unknown 
     61 * 
     62 * @param unknown_type $filename 
     63 * @param unknown_type $marker 
     64 * @param unknown_type $insertion 
     65 * @return bool True on write success, false on failure. 
     66 */ 
    3767function insert_with_markers( $filename, $marker, $insertion ) { 
    3868    if (!file_exists( $filename ) || is_writeable( $filename ) ) { 
     
    83113 * Updates the htaccess file with the current rules if it is writable. 
    84114 * 
    85  * Always writes to the file if it exists and is writable to ensure that we blank out old rules. 
    86  */ 
    87  
     115 * Always writes to the file if it exists and is writable to ensure that we 
     116 * blank out old rules. 
     117 * 
     118 * @since unknown 
     119 */ 
    88120function save_mod_rewrite_rules() { 
    89121    global $wp_rewrite; 
     
    104136} 
    105137 
     138/** 
     139 * {@internal Missing Short Description}} 
     140 * 
     141 * @since unknown 
     142 * 
     143 * @param unknown_type $file 
     144 */ 
    106145function update_recently_edited( $file ) { 
    107146    $oldfiles = (array ) get_option( 'recently_edited' ); 
     
    119158} 
    120159 
    121 // If siteurl or home changed, flush rewrite rules. 
     160/** 
     161 * If siteurl or home changed, flush rewrite rules. 
     162 * 
     163 * @since unknown 
     164 * 
     165 * @param unknown_type $old_value 
     166 * @param unknown_type $value 
     167 */ 
    122168function update_home_siteurl( $old_value, $value ) { 
    123169    global $wp_rewrite; 
     
    133179add_action( 'update_option_siteurl', 'update_home_siteurl', 10, 2 ); 
    134180 
     181/** 
     182 * {@internal Missing Short Description}} 
     183 * 
     184 * @since unknown 
     185 * 
     186 * @param unknown_type $url 
     187 * @return unknown 
     188 */ 
    135189function url_shorten( $url ) { 
    136190    $short_url = str_replace( 'http://', '', stripslashes( $url )); 
     
    143197} 
    144198 
     199/** 
     200 * {@internal Missing Short Description}} 
     201 * 
     202 * @since unknown 
     203 * 
     204 * @param unknown_type $vars 
     205 */ 
    145206function wp_reset_vars( $vars ) { 
    146207    for ( $i=0; $i<count( $vars ); $i += 1 ) { 
     
    161222} 
    162223 
     224/** 
     225 * {@internal Missing Short Description}} 
     226 * 
     227 * @since unknown 
     228 * 
     229 * @param unknown_type $message 
     230 */ 
    163231function show_message($message) { 
    164232    if( is_wp_error($message) ){ 
     
    172240 
    173241/* Whitelist functions */ 
     242 
     243/** 
     244 * {@internal Missing Short Description}} 
     245 * 
     246 * @since unknown 
     247 * 
     248 * @param unknown_type $option_group 
     249 * @param unknown_type $option_name 
     250 * @param unknown_type $sanitize_callback 
     251 * @return unknown 
     252 */ 
    174253function register_setting($option_group, $option_name, $sanitize_callback = '') { 
    175254    return add_option_update_handler($option_group, $option_name, $sanitize_callback); 
    176255} 
    177256 
     257/** 
     258 * {@internal Missing Short Description}} 
     259 * 
     260 * @since unknown 
     261 * 
     262 * @param unknown_type $option_group 
     263 * @param unknown_type $option_name 
     264 * @param unknown_type $sanitize_callback 
     265 * @return unknown 
     266 */ 
    178267function unregister_setting($option_group, $option_name, $sanitize_callback = '') { 
    179268    return remove_option_update_handler($option_group, $option_name, $sanitize_callback); 
    180269} 
    181270 
     271/** 
     272 * {@internal Missing Short Description}} 
     273 * 
     274 * @since unknown 
     275 * 
     276 * @param unknown_type $option_group 
     277 * @param unknown_type $option_name 
     278 * @param unknown_type $sanitize_callback 
     279 */ 
    182280function add_option_update_handler($option_group, $option_name, $sanitize_callback = '') { 
    183281    global $new_whitelist_options; 
     
    187285} 
    188286