Index: general-template.php =================================================================== --- general-template.php (revision 6597) +++ general-template.php (working copy) @@ -1,7 +1,20 @@ ' . __('Log in') . ''; @@ -38,7 +72,17 @@ echo apply_filters('loginout', $link); } - +/** + * wp_register() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.5.0 + * @uses apply_filters() + * + * @param unknown_type $before + * @param unknown_type $after + */ function wp_register( $before = '
  • ', $after = '
    • ' ) { if ( ! is_user_logged_in() ) { @@ -53,21 +97,46 @@ echo apply_filters('register', $link); } - +/** + * wp_meta() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.5.0 + * @uses do_action() + */ function wp_meta() { do_action('wp_meta'); } - +/** + * bloginfo() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 0.71 + * + * @param unknown_type $show + */ function bloginfo($show='') { echo get_bloginfo($show, 'display'); } /** + * get_bloginfo() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * * Note: some of these values are DEPRECATED. Meaning they could be * taken out at any time and shouldn't be relied upon. Options * without "// DEPRECATED" are the preferred and recommended ways * to get the information. + * + * @since 0.71 + * + * @param unknown_type $show + * @param unknown_type $filter + * @return unknown */ function get_bloginfo($show = '', $filter = 'raw') { @@ -158,7 +227,17 @@ return $output; } - +/** + * wp_title() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.0.0 + * + * @param unknown_type $sep + * @param unknown_type $display + * @return unknown + */ function wp_title($sep = '»', $display = true, $seplocation = '') { global $wpdb, $wp_locale, $wp_query; @@ -251,7 +330,18 @@ } - +/** + * single_post_title() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 0.71 + * @uses $wpdb + * + * @param unknown_type $prefix + * @param unknown_type $display + * @return unknown + */ function single_post_title($prefix = '', $display = true) { global $wpdb; $p = get_query_var('p'); @@ -270,7 +360,17 @@ } } - +/** + * single_cat_title() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 0.71 + * + * @param unknown_type $prefix + * @param unknown_type $display + * @return unknown + */ function single_cat_title($prefix = '', $display = true ) { $cat = intval( get_query_var('cat') ); if ( !empty($cat) && !(strtoupper($cat) == 'ALL') ) { @@ -286,7 +386,17 @@ } } - +/** + * single_tag_title() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.3.0 + * + * @param unknown_type $prefix + * @param unknown_type $display + * @return unknown + */ function single_tag_title($prefix = '', $display = true ) { if ( !is_tag() ) return; @@ -307,7 +417,17 @@ } } - +/** + * single_month_title() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 0.71 + * + * @param unknown_type $prefix + * @param unknown_type $display + * @return unknown + */ function single_month_title($prefix = '', $display = true ) { global $wp_locale; @@ -333,8 +453,22 @@ echo $result; } - -/* link navigation hack by Orien http://icecode.com/ */ +/** + * get_archives_link() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.0.0 + * @author Orien + * @link http://icecode.com/ link navigation hack by Orien + * + * @param unknown_type $url + * @param unknown_type $text + * @param unknown_type $format + * @param unknown_type $before + * @param unknown_type $after + * @return unknown + */ function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') { $text = wptexturize($text); $title_text = attribute_escape($text); @@ -350,7 +484,15 @@ return "\t$before$text$after\n"; } - +/** + * wp_get_archives() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.2.0 + * + * @param unknown_type $args + */ function wp_get_archives($args = '') { global $wpdb, $wp_locale; @@ -516,14 +658,31 @@ } } - -// Used in get_calendar +/** + * calendar_week_mod() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.5.0 + * @usedby get_calendar() + * + * @param unknown_type $num + * @return unknown + */ function calendar_week_mod($num) { $base = 7; return ($num - $base*floor($num/$base)); } - +/** + * get_calendar() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.0.0 + * + * @param unknown_type $initial + */ function get_calendar($initial = true) { global $wpdb, $m, $monthnum, $year, $wp_locale, $posts; @@ -716,6 +875,11 @@ wp_cache_set( 'get_calendar', $cache, 'calendar' ); } +/** + * delete_get_calendar_cache() - {@internal Missing Short Description}} + * + * @since 2.1.0 + */ function delete_get_calendar_cache() { wp_cache_delete( 'get_calendar', 'calendar' ); } @@ -725,7 +889,16 @@ add_action( 'update_option_gmt_offset', 'delete_get_calendar_cache' ); add_action( 'update_option_start_of_week', 'delete_get_calendar_cache' ); - +/** + * allowed_tags() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.0.1 + * @uses $allowedtags + * + * @return unknown + */ function allowed_tags() { global $allowedtags; $allowed = ''; @@ -741,17 +914,35 @@ return htmlentities($allowed); } - /***** Date/Time tags *****/ - +/** + * the_date_xml() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.0.0 + * + */ function the_date_xml() { global $post; echo mysql2date('Y-m-d', $post->post_date); //echo ""+$post->post_date; } - +/** + * the_date() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 0.71 + * + * @param unknown_type $d + * @param unknown_type $before + * @param unknown_type $after + * @param unknown_type $echo + * @return unknown + */ function the_date($d='', $before='', $after='', $echo = true) { global $post, $day, $previousday; $the_date = ''; @@ -771,12 +962,29 @@ return $the_date; } - +/** + * the_modified_date() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.1.0 + * + * @param unknown_type $d + */ function the_modified_date($d = '') { echo apply_filters('the_modified_date', get_the_modified_date($d), $d); } - +/** + * get_the_modified_date() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.1.0 + * + * @param unknown_type $d + * @return unknown + */ function get_the_modified_date($d = '') { if ( '' == $d ) $the_time = get_post_modified_time(get_option('date_format')); @@ -785,12 +993,29 @@ return apply_filters('get_the_modified_date', $the_time, $d); } - +/** + * the_time() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 0.71 + * + * @param unknown_type $d + */ function the_time( $d = '' ) { echo apply_filters('the_time', get_the_time( $d ), $d); } - +/** + * get_the_time() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.5.0 + * + * @param unknown_type $d + * @return unknown + */ function get_the_time( $d = '' ) { if ( '' == $d ) $the_time = get_post_time(get_option('time_format')); @@ -799,7 +1024,17 @@ return apply_filters('get_the_time', $the_time, $d); } - +/** + * get_post_time() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.5.0 + * + * @param unknown_type $d + * @param unknown_type $gmt + * @return unknown + */ function get_post_time( $d = 'U', $gmt = false ) { // returns timestamp global $post; if ( $gmt ) @@ -811,12 +1046,29 @@ return apply_filters('get_the_time', $time, $d, $gmt); } - +/** + * the_modified_time() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.0.0 + * + * @param unknown_type $d + */ function the_modified_time($d = '') { echo apply_filters('the_modified_time', get_the_modified_time($d), $d); } - +/** + * get_the_modified_time() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.0.0 + * + * @param unknown_type $d + * @return unknown + */ function get_the_modified_time($d = '') { if ( '' == $d ) $the_time = get_post_modified_time(get_option('time_format')); @@ -825,7 +1077,17 @@ return apply_filters('get_the_modified_time', $the_time, $d); } - +/** + * get_post_modified_time() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.0.0 + * + * @param unknown_type $d + * @param unknown_type $gmt + * @return unknown + */ function get_post_modified_time( $d = 'U', $gmt = false ) { // returns timestamp global $post; @@ -838,7 +1100,15 @@ return apply_filters('get_the_modified_time', $time, $d, $gmt); } - +/** + * the_weekday() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 0.71 + * @uses $wp_locale + * @uses $post + */ function the_weekday() { global $wp_locale, $post; $the_weekday = $wp_locale->get_weekday(mysql2date('w', $post->post_date)); @@ -846,7 +1116,16 @@ echo $the_weekday; } - +/** + * the_weekday_date() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 0.71 + * + * @param unknown_type $before + * @param unknown_type $after + */ function the_weekday_date($before='',$after='') { global $wp_locale, $post, $day, $previousweekday; $the_weekday_date = ''; @@ -860,29 +1139,77 @@ echo $the_weekday_date; } +/** + * wp_head() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.2.0 + * @uses do_action() + */ function wp_head() { do_action('wp_head'); } +/** + * wp_footer() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 1.5.1 + * @uses do_action() + */ function wp_footer() { do_action('wp_footer'); } +/** + * rsd_link() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.0.0 + * + */ function rsd_link() { echo '\n"; } +/** + * wlwmanifest_link() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.3.1 + * + */ function wlwmanifest_link() { echo ' ' . "\n"; } +/** + * noindex() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.1.0 + */ function noindex() { // If the blog is not public, tell robots to go away. if ( '0' == get_option('blog_public') ) echo "\n"; } +/** + * rich_edit_exists() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.1.0 + * + * @return unknown + */ function rich_edit_exists() { global $wp_rich_edit_exists; if ( !isset($wp_rich_edit_exists) ) @@ -890,6 +1217,15 @@ return $wp_rich_edit_exists; } +/** + * user_can_richedit() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.0.0 + * + * @return unknown + */ function user_can_richedit() { global $wp_rich_edit, $pagenow; @@ -907,6 +1243,15 @@ return apply_filters('user_can_richedit', $wp_rich_edit); } +/** + * wp_default_editor() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.5.0 + * + * @return string Either 'tinymce', or 'html', or 'test' + */ function wp_default_editor() { $r = user_can_richedit() ? 'tinymce' : 'html'; // defaults if ( $user = wp_get_current_user() ) { // look for cookie @@ -916,6 +1261,17 @@ return apply_filters( 'wp_default_editor', $r ); // filter } +/** + * the_editor() - {@internal Missing Short Description}} + * + * {@internal Missing Long Description}} + * + * @since 2.1.0 + * + * @param unknown_type $content + * @param unknown_type $id + * @param unknown_type $prev_id + */ function the_editor($content, $id = 'content', $prev_id = 'title') { $rows = get_option('default_post_edit_rows'); if (($rows < 3) || ($rows > 100)) @@ -940,12 +1296,12 @@