Make WordPress Core

Ticket #5640: general-template.phpdoc.r6597.diff

File general-template.phpdoc.r6597.diff, 19.0 KB (added by darkdragon, 16 years ago)

Incomplete documentation for general-template.php based off of r6597

  • general-template.php

     
    11<?php
     2/**
     3 * General template tags that can go anywhere in a
     4 * template.
     5 *
     6 * @package WordPress
     7 * @subpackage Template
     8 */
    29
    3 /* Note: these tags go anywhere in the template */
    4 
     10/**
     11 * get_header() - {@internal Missing Short Description}}
     12 *
     13 * {@internal Missing Long Description}}
     14 *
     15 * @since 1.5.0
     16 * @uses do_action()
     17 */
    518function get_header() {
    619        do_action( 'get_header' );
    720        if ( file_exists( TEMPLATEPATH . '/header.php') )
     
    1023                load_template( ABSPATH . 'wp-content/themes/default/header.php');
    1124}
    1225
    13 
     26/**
     27 * get_footer() - {@internal Missing Short Description}}
     28 *
     29 * {@internal Missing Long Description}}
     30 *
     31 * @since 1.5.0
     32 * @uses do_action()
     33 */
    1434function get_footer() {
    1535        do_action( 'get_footer' );
    1636        if ( file_exists( TEMPLATEPATH . '/footer.php') )
     
    1939                load_template( ABSPATH . 'wp-content/themes/default/footer.php');
    2040}
    2141
    22 
     42/**
     43 * get_sidebar() - {@internal Missing Short Description}}
     44 *
     45 * {@internal Missing Long Description}}
     46 *
     47 * @since 1.5.0
     48 * @uses do_action()
     49 */
    2350function get_sidebar() {
    2451        do_action( 'get_sidebar' );
    2552        if ( file_exists( TEMPLATEPATH . '/sidebar.php') )
     
    2855                load_template( ABSPATH . 'wp-content/themes/default/sidebar.php');
    2956}
    3057
    31 
     58/**
     59 * wp_loginout() - {@internal Missing Short Description}}
     60 *
     61 * {@internal Missing Long Description}}
     62 *
     63 * @since 1.5.0
     64 * @uses apply_filters()
     65 */
    3266function wp_loginout() {
    3367        if ( ! is_user_logged_in() )
    3468                $link = '<a href="' . get_option('siteurl') . '/wp-login.php">' . __('Log in') . '</a>';
     
    3872        echo apply_filters('loginout', $link);
    3973}
    4074
    41 
     75/**
     76 * wp_register() - {@internal Missing Short Description}}
     77 *
     78 * {@internal Missing Long Description}}
     79 *
     80 * @since 1.5.0
     81 * @uses apply_filters()
     82 *
     83 * @param unknown_type $before
     84 * @param unknown_type $after
     85 */
    4286function wp_register( $before = '<li>', $after = '</li>' ) {
    4387
    4488        if ( ! is_user_logged_in() ) {
     
    5397        echo apply_filters('register', $link);
    5498}
    5599
    56 
     100/**
     101 * wp_meta() - {@internal Missing Short Description}}
     102 *
     103 * {@internal Missing Long Description}}
     104 *
     105 * @since 1.5.0
     106 * @uses do_action()
     107 */
    57108function wp_meta() {
    58109        do_action('wp_meta');
    59110}
    60111
    61 
     112/**
     113 * bloginfo() - {@internal Missing Short Description}}
     114 *
     115 * {@internal Missing Long Description}}
     116 *
     117 * @since 0.71
     118 *
     119 * @param unknown_type $show
     120 */
    62121function bloginfo($show='') {
    63122        echo get_bloginfo($show, 'display');
    64123}
    65124
    66125/**
     126 * get_bloginfo() - {@internal Missing Short Description}}
     127 *
     128 * {@internal Missing Long Description}}
     129 *
    67130 * Note: some of these values are DEPRECATED. Meaning they could be
    68131 * taken out at any time and shouldn't be relied upon. Options
    69132 * without "// DEPRECATED" are the preferred and recommended ways
    70133 * to get the information.
     134 *
     135 * @since 0.71
     136 *
     137 * @param unknown_type $show
     138 * @param unknown_type $filter
     139 * @return unknown
    71140 */
    72141function get_bloginfo($show = '', $filter = 'raw') {
    73142
     
    158227        return $output;
    159228}
    160229
    161 
     230/**
     231 * wp_title() - {@internal Missing Short Description}}
     232 *
     233 * {@internal Missing Long Description}}
     234 *
     235 * @since 1.0.0
     236 *
     237 * @param unknown_type $sep
     238 * @param unknown_type $display
     239 * @return unknown
     240 */
    162241function wp_title($sep = '&raquo;', $display = true, $seplocation = '') {
    163242        global $wpdb, $wp_locale, $wp_query;
    164243
     
    251330
    252331}
    253332
    254 
     333/**
     334 * single_post_title() - {@internal Missing Short Description}}
     335 *
     336 * {@internal Missing Long Description}}
     337 *
     338 * @since 0.71
     339 * @uses $wpdb
     340 *
     341 * @param unknown_type $prefix
     342 * @param unknown_type $display
     343 * @return unknown
     344 */
    255345function single_post_title($prefix = '', $display = true) {
    256346        global $wpdb;
    257347        $p = get_query_var('p');
     
    270360        }
    271361}
    272362
    273 
     363/**
     364 * single_cat_title() - {@internal Missing Short Description}}
     365 *
     366 * {@internal Missing Long Description}}
     367 *
     368 * @since 0.71
     369 *
     370 * @param unknown_type $prefix
     371 * @param unknown_type $display
     372 * @return unknown
     373 */
    274374function single_cat_title($prefix = '', $display = true ) {
    275375        $cat = intval( get_query_var('cat') );
    276376        if ( !empty($cat) && !(strtoupper($cat) == 'ALL') ) {
     
    286386        }
    287387}
    288388
    289 
     389/**
     390 * single_tag_title() - {@internal Missing Short Description}}
     391 *
     392 * {@internal Missing Long Description}}
     393 *
     394 * @since 2.3.0
     395 *
     396 * @param unknown_type $prefix
     397 * @param unknown_type $display
     398 * @return unknown
     399 */
    290400function single_tag_title($prefix = '', $display = true ) {
    291401        if ( !is_tag() )
    292402                return;
     
    307417        }
    308418}
    309419
    310 
     420/**
     421 * single_month_title() - {@internal Missing Short Description}}
     422 *
     423 * {@internal Missing Long Description}}
     424 *
     425 * @since 0.71
     426 *
     427 * @param unknown_type $prefix
     428 * @param unknown_type $display
     429 * @return unknown
     430 */
    311431function single_month_title($prefix = '', $display = true ) {
    312432        global $wp_locale;
    313433
     
    333453        echo $result;
    334454}
    335455
    336 
    337 /* link navigation hack by Orien http://icecode.com/ */
     456/**
     457 * get_archives_link() - {@internal Missing Short Description}}
     458 *
     459 * {@internal Missing Long Description}}
     460 *
     461 * @since 1.0.0
     462 * @author Orien
     463 * @link http://icecode.com/ link navigation hack by Orien
     464 *
     465 * @param unknown_type $url
     466 * @param unknown_type $text
     467 * @param unknown_type $format
     468 * @param unknown_type $before
     469 * @param unknown_type $after
     470 * @return unknown
     471 */
    338472function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') {
    339473        $text = wptexturize($text);
    340474        $title_text = attribute_escape($text);
     
    350484                return "\t$before<a href='$url' title='$title_text'>$text</a>$after\n";
    351485}
    352486
    353 
     487/**
     488 * wp_get_archives() - {@internal Missing Short Description}}
     489 *
     490 * {@internal Missing Long Description}}
     491 *
     492 * @since 1.2.0
     493 *
     494 * @param unknown_type $args
     495 */
    354496function wp_get_archives($args = '') {
    355497        global $wpdb, $wp_locale;
    356498
     
    516658        }
    517659}
    518660
    519 
    520 // Used in get_calendar
     661/**
     662 * calendar_week_mod() - {@internal Missing Short Description}}
     663 *
     664 * {@internal Missing Long Description}}
     665 *
     666 * @since 1.5.0
     667 * @usedby get_calendar()
     668 *
     669 * @param unknown_type $num
     670 * @return unknown
     671 */
    521672function calendar_week_mod($num) {
    522673        $base = 7;
    523674        return ($num - $base*floor($num/$base));
    524675}
    525676
    526 
     677/**
     678 * get_calendar() - {@internal Missing Short Description}}
     679 *
     680 * {@internal Missing Long Description}}
     681 *
     682 * @since 1.0.0
     683 *
     684 * @param unknown_type $initial
     685 */
    527686function get_calendar($initial = true) {
    528687        global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
    529688
     
    716875        wp_cache_set( 'get_calendar', $cache, 'calendar' );
    717876}
    718877
     878/**
     879 * delete_get_calendar_cache() - {@internal Missing Short Description}}
     880 *
     881 * @since 2.1.0
     882 */
    719883function delete_get_calendar_cache() {
    720884        wp_cache_delete( 'get_calendar', 'calendar' );
    721885}
     
    725889add_action( 'update_option_gmt_offset', 'delete_get_calendar_cache' );
    726890add_action( 'update_option_start_of_week', 'delete_get_calendar_cache' );
    727891
    728 
     892/**
     893 * allowed_tags() - {@internal Missing Short Description}}
     894 *
     895 * {@internal Missing Long Description}}
     896 *
     897 * @since 1.0.1
     898 * @uses $allowedtags
     899 *
     900 * @return unknown
     901 */
    729902function allowed_tags() {
    730903        global $allowedtags;
    731904        $allowed = '';
     
    741914        return htmlentities($allowed);
    742915}
    743916
    744 
    745917/***** Date/Time tags *****/
    746918
    747 
     919/**
     920 * the_date_xml() - {@internal Missing Short Description}}
     921 *
     922 * {@internal Missing Long Description}}
     923 *
     924 * @since 1.0.0
     925 *
     926 */
    748927function the_date_xml() {
    749928        global $post;
    750929        echo mysql2date('Y-m-d', $post->post_date);
    751930        //echo ""+$post->post_date;
    752931}
    753932
    754 
     933/**
     934 * the_date() - {@internal Missing Short Description}}
     935 *
     936 * {@internal Missing Long Description}}
     937 *
     938 * @since 0.71
     939 *
     940 * @param unknown_type $d
     941 * @param unknown_type $before
     942 * @param unknown_type $after
     943 * @param unknown_type $echo
     944 * @return unknown
     945 */
    755946function the_date($d='', $before='', $after='', $echo = true) {
    756947        global $post, $day, $previousday;
    757948        $the_date = '';
     
    771962                return $the_date;
    772963}
    773964
    774 
     965/**
     966 * the_modified_date() - {@internal Missing Short Description}}
     967 *
     968 * {@internal Missing Long Description}}
     969 *
     970 * @since 2.1.0
     971 *
     972 * @param unknown_type $d
     973 */
    775974function the_modified_date($d = '') {
    776975        echo apply_filters('the_modified_date', get_the_modified_date($d), $d);
    777976}
    778977
    779 
     978/**
     979 * get_the_modified_date() - {@internal Missing Short Description}}
     980 *
     981 * {@internal Missing Long Description}}
     982 *
     983 * @since 2.1.0
     984 *
     985 * @param unknown_type $d
     986 * @return unknown
     987 */
    780988function get_the_modified_date($d = '') {
    781989        if ( '' == $d )
    782990                $the_time = get_post_modified_time(get_option('date_format'));
     
    785993        return apply_filters('get_the_modified_date', $the_time, $d);
    786994}
    787995
    788 
     996/**
     997 * the_time() - {@internal Missing Short Description}}
     998 *
     999 * {@internal Missing Long Description}}
     1000 *
     1001 * @since 0.71
     1002 *
     1003 * @param unknown_type $d
     1004 */
    7891005function the_time( $d = '' ) {
    7901006        echo apply_filters('the_time', get_the_time( $d ), $d);
    7911007}
    7921008
    793 
     1009/**
     1010 * get_the_time() - {@internal Missing Short Description}}
     1011 *
     1012 * {@internal Missing Long Description}}
     1013 *
     1014 * @since 1.5.0
     1015 *
     1016 * @param unknown_type $d
     1017 * @return unknown
     1018 */
    7941019function get_the_time( $d = '' ) {
    7951020        if ( '' == $d )
    7961021                $the_time = get_post_time(get_option('time_format'));
     
    7991024        return apply_filters('get_the_time', $the_time, $d);
    8001025}
    8011026
    802 
     1027/**
     1028 * get_post_time() - {@internal Missing Short Description}}
     1029 *
     1030 * {@internal Missing Long Description}}
     1031 *
     1032 * @since 1.5.0
     1033 *
     1034 * @param unknown_type $d
     1035 * @param unknown_type $gmt
     1036 * @return unknown
     1037 */
    8031038function get_post_time( $d = 'U', $gmt = false ) { // returns timestamp
    8041039        global $post;
    8051040        if ( $gmt )
     
    8111046        return apply_filters('get_the_time', $time, $d, $gmt);
    8121047}
    8131048
    814 
     1049/**
     1050 * the_modified_time() - {@internal Missing Short Description}}
     1051 *
     1052 * {@internal Missing Long Description}}
     1053 *
     1054 * @since 2.0.0
     1055 *
     1056 * @param unknown_type $d
     1057 */
    8151058function the_modified_time($d = '') {
    8161059        echo apply_filters('the_modified_time', get_the_modified_time($d), $d);
    8171060}
    8181061
    819 
     1062/**
     1063 * get_the_modified_time() - {@internal Missing Short Description}}
     1064 *
     1065 * {@internal Missing Long Description}}
     1066 *
     1067 * @since 2.0.0
     1068 *
     1069 * @param unknown_type $d
     1070 * @return unknown
     1071 */
    8201072function get_the_modified_time($d = '') {
    8211073        if ( '' == $d )
    8221074                $the_time = get_post_modified_time(get_option('time_format'));
     
    8251077        return apply_filters('get_the_modified_time', $the_time, $d);
    8261078}
    8271079
    828 
     1080/**
     1081 * get_post_modified_time() - {@internal Missing Short Description}}
     1082 *
     1083 * {@internal Missing Long Description}}
     1084 *
     1085 * @since 2.0.0
     1086 *
     1087 * @param unknown_type $d
     1088 * @param unknown_type $gmt
     1089 * @return unknown
     1090 */
    8291091function get_post_modified_time( $d = 'U', $gmt = false ) { // returns timestamp
    8301092        global $post;
    8311093
     
    8381100        return apply_filters('get_the_modified_time', $time, $d, $gmt);
    8391101}
    8401102
    841 
     1103/**
     1104 * the_weekday() - {@internal Missing Short Description}}
     1105 *
     1106 * {@internal Missing Long Description}}
     1107 *
     1108 * @since 0.71
     1109 * @uses $wp_locale
     1110 * @uses $post
     1111 */
    8421112function the_weekday() {
    8431113        global $wp_locale, $post;
    8441114        $the_weekday = $wp_locale->get_weekday(mysql2date('w', $post->post_date));
     
    8461116        echo $the_weekday;
    8471117}
    8481118
    849 
     1119/**
     1120 * the_weekday_date() - {@internal Missing Short Description}}
     1121 *
     1122 * {@internal Missing Long Description}}
     1123 *
     1124 * @since 0.71
     1125 *
     1126 * @param unknown_type $before
     1127 * @param unknown_type $after
     1128 */
    8501129function the_weekday_date($before='',$after='') {
    8511130        global $wp_locale, $post, $day, $previousweekday;
    8521131        $the_weekday_date = '';
     
    8601139        echo $the_weekday_date;
    8611140}
    8621141
     1142/**
     1143 * wp_head() - {@internal Missing Short Description}}
     1144 *
     1145 * {@internal Missing Long Description}}
     1146 *
     1147 * @since 1.2.0
     1148 * @uses do_action()
     1149 */
    8631150function wp_head() {
    8641151        do_action('wp_head');
    8651152}
    8661153
     1154/**
     1155 * wp_footer() - {@internal Missing Short Description}}
     1156 *
     1157 * {@internal Missing Long Description}}
     1158 *
     1159 * @since 1.5.1
     1160 * @uses do_action()
     1161 */
    8671162function wp_footer() {
    8681163        do_action('wp_footer');
    8691164}
    8701165
     1166/**
     1167 * rsd_link() - {@internal Missing Short Description}}
     1168 *
     1169 * {@internal Missing Long Description}}
     1170 *
     1171 * @since 2.0.0
     1172 *
     1173 */
    8711174function rsd_link() {
    8721175        echo '<link rel="EditURI" type="application/rsd+xml" title="RSD" href="' . get_bloginfo('wpurl') . "/xmlrpc.php?rsd\" />\n";
    8731176}
    8741177
     1178/**
     1179 * wlwmanifest_link() - {@internal Missing Short Description}}
     1180 *
     1181 * {@internal Missing Long Description}}
     1182 *
     1183 * @since 2.3.1
     1184 *
     1185 */
    8751186function wlwmanifest_link() {
    8761187        echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="'
    8771188                . get_bloginfo('wpurl') . '/wp-includes/wlwmanifest.xml" /> ' . "\n";
    8781189}
    8791190
     1191/**
     1192 * noindex() - {@internal Missing Short Description}}
     1193 *
     1194 * {@internal Missing Long Description}}
     1195 *
     1196 * @since 2.1.0
     1197 */
    8801198function noindex() {
    8811199        // If the blog is not public, tell robots to go away.
    8821200        if ( '0' == get_option('blog_public') )
    8831201                echo "<meta name='robots' content='noindex,nofollow' />\n";
    8841202}
    8851203
     1204/**
     1205 * rich_edit_exists() - {@internal Missing Short Description}}
     1206 *
     1207 * {@internal Missing Long Description}}
     1208 *
     1209 * @since 2.1.0
     1210 *
     1211 * @return unknown
     1212 */
    8861213function rich_edit_exists() {
    8871214        global $wp_rich_edit_exists;
    8881215        if ( !isset($wp_rich_edit_exists) )
     
    8901217        return $wp_rich_edit_exists;
    8911218}
    8921219
     1220/**
     1221 * user_can_richedit() - {@internal Missing Short Description}}
     1222 *
     1223 * {@internal Missing Long Description}}
     1224 *
     1225 * @since 2.0.0
     1226 *
     1227 * @return unknown
     1228 */
    8931229function user_can_richedit() {
    8941230        global $wp_rich_edit, $pagenow;
    8951231
     
    9071243        return apply_filters('user_can_richedit', $wp_rich_edit);
    9081244}
    9091245
     1246/**
     1247 * wp_default_editor() - {@internal Missing Short Description}}
     1248 *
     1249 * {@internal Missing Long Description}}
     1250 *
     1251 * @since 2.5.0
     1252 *
     1253 * @return string Either 'tinymce', or 'html', or 'test'
     1254 */
    9101255function wp_default_editor() {
    9111256        $r = user_can_richedit() ? 'tinymce' : 'html'; // defaults
    9121257        if ( $user = wp_get_current_user() ) { // look for cookie
     
    9161261        return apply_filters( 'wp_default_editor', $r ); // filter
    9171262}
    9181263
     1264/**
     1265 * the_editor() - {@internal Missing Short Description}}
     1266 *
     1267 * {@internal Missing Long Description}}
     1268 *
     1269 * @since 2.1.0
     1270 *
     1271 * @param unknown_type $content
     1272 * @param unknown_type $id
     1273 * @param unknown_type $prev_id
     1274 */
    9191275function the_editor($content, $id = 'content', $prev_id = 'title') {
    9201276        $rows = get_option('default_post_edit_rows');
    9211277        if (($rows < 3) || ($rows > 100))
     
    9401296        <div id='editor-toolbar' style='display:none;'>
    9411297                <div class='zerosize'><input accesskey='e' type='button' onclick='switchEditors("<?php echo $id; ?>")' /></div>
    9421298                <a id='edButtonHTML'<?php echo 'html' == $wp_default_editor ? $active : $inactive; ?>><?php _e('HTML'); ?></a>
    943                 <a id='edButtonPreview'<?php echo 'tinymce' == $wp_default_editor ? $active : $inactive; ?>><?php _e('Visual'); ?></a>
     1299                        <a id='edButtonPreview'<?php echo 'tinymce' == $wp_default_editor ? $active : $inactive; ?>><?php _e('Visual'); ?></a>
    9441300
    945                 <div id="media-buttons">
    946                 <?php _e('Add media:'); ?>
    947                 <?php do_action( 'media_buttons'); ?>
    948                 </div>
     1301                        <div id="media-buttons">
     1302                        <?php _e('Add media:'); ?>
     1303                        <?php do_action( 'media_buttons'); ?>
     1304                        </div>
    9491305        </div>
    9501306
    9511307        <script type="text/javascript">
     
    10201376        <?php
    10211377}
    10221378
     1379/**
     1380 * get_search_query() - {@internal Missing Short Description}}
     1381 *
     1382 * {@internal Missing Long Description}}
     1383 *
     1384 * @since 2.3.0
     1385 *
     1386 * @return unknown
     1387 */
    10231388function get_search_query() {
    10241389        return apply_filters( 'get_search_query', stripslashes( get_query_var( 's' ) ) );
    10251390}
    10261391
     1392/**
     1393 * the_search_query() - {@internal Missing Short Description}}
     1394 *
     1395 * {@internal Missing Long Description}}
     1396 *
     1397 * @since 2.1.0
     1398 *
     1399 */
    10271400function the_search_query() {
    10281401        echo attribute_escape( apply_filters( 'the_search_query', get_search_query() ) );
    10291402}
    10301403
     1404/**
     1405 * language_attributes() - {@internal Missing Short Description}}
     1406 *
     1407 * {@internal Missing Long Description}}
     1408 *
     1409 * @since 2.1.0
     1410 *
     1411 * @param unknown_type $doctype
     1412 */
    10311413function language_attributes($doctype = 'html') {
    10321414        $attributes = array();
    10331415        $output = '';
     
    10481430        echo $output;
    10491431}
    10501432
     1433/**
     1434 * paginate_links() - {@internal Missing Short Description}}
     1435 *
     1436 * {@internal Missing Long Description}}
     1437 *
     1438 * @since 2.1.0
     1439 *
     1440 * @param unknown_type $args
     1441 * @return unknown
     1442 */
    10511443function paginate_links( $args = '' ) {
    10521444        $defaults = array(
    10531445                'base' => '%_%', // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
     
    11281520        return $r;
    11291521}
    11301522
     1523/**
     1524 * wp_admin_css_uri() - {@internal Missing Short Description}}
     1525 *
     1526 * {@internal Missing Long Description}}
     1527 *
     1528 * @since 2.3.0
     1529 *
     1530 * @param unknown_type $file
     1531 * @return unknown
     1532 */
    11311533function wp_admin_css_uri( $file = 'wp-admin' ) {
    11321534        if ( defined('WP_INSTALLING') )
    11331535        {
     
    11381540        return apply_filters( 'wp_admin_css_uri', $_file, $file );
    11391541}
    11401542
     1543/**
     1544 * wp_admin_css() - {@internal Missing Short Description}}
     1545 *
     1546 * {@internal Missing Long Description}}
     1547 *
     1548 * @since 2.3.0
     1549 *
     1550 * @param unknown_type $file
     1551 */
    11411552function wp_admin_css( $file = 'wp-admin' ) {
    11421553        echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . wp_admin_css_uri( $file ) . "' type='text/css' />\n", $file );
    11431554        if ( 'rtl' == get_bloginfo( 'text_direction' ) ) {
     
    11471558}
    11481559
    11491560/**
    1150  * Outputs the XHTML generator that is generated on the wp_head hook.
     1561 * wp_generator() - Outputs the XHTML generator that is generated on the wp_head hook.
     1562 *
     1563 * {@internal Missing Long Description}}
     1564 *
     1565 * @since 2.5.0
     1566 * @uses apply_filters()
    11511567 */
    1152 function wp_generator()
    1153 {
     1568function wp_generator() {
    11541569        the_generator( apply_filters( 'wp_generator_type', 'xhtml' ) );
    11551570}
    11561571
    11571572/**
    1158  * Outputs the generator XML or Comment for RSS, ATOM, etc.
    1159  * @param {String} $type The type of generator to return.
     1573 * the_generator() - Outputs the generator XML or Comment for RSS, ATOM, etc.
     1574 *
     1575 * {@internal Missing Long Description}}
     1576 *
     1577 * @since 2.5
     1578 * @uses apply_filters()
     1579 *
     1580 * @param string $type The type of generator to return.
    11601581 */
    1161 function the_generator ( $type ) {
    1162         echo apply_filters('the_generator',get_the_generator($type),$type) . "\n";
     1582function the_generator( $type ) {
     1583        echo apply_filters('the_generator', get_the_generator($type), $type) . "\n";
    11631584}
    11641585
    11651586/**
    1166  * Creates the generator XML or Comment for RSS, ATOM, etc.
    1167  * @param {String} $type The type of generator to return.
     1587 * get_the_generator() - Creates the generator XML or Comment for RSS, ATOM, etc.
     1588 *
     1589 * {@internal Missing Long Description}}
     1590 *
     1591 * @since 2.5
     1592 * @uses apply_filters()
     1593 *
     1594 * @param string $type The type of generator to return.
    11681595 */
    1169 function get_the_generator ( $type ) {
     1596function get_the_generator( $type ) {
    11701597        switch ($type) {
    11711598                case 'html':
    11721599                        $gen = '<meta name="generator" content="WordPress/' . get_bloginfo( 'version' ) . '">' . "\n";
     
    11921619        }
    11931620        return apply_filters( "get_the_generator_{$type}", $gen, $type );
    11941621}
    1195 ?>
     1622
     1623?>
     1624 No newline at end of file