wp-includes/post-template.php

   1 <?php
   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  * Display the ID of the current item in the WordPress Loop.
  13  *
  14  * @since 0.71
  15  */
  16 function the_ID() {
  17         echo get_the_ID();
  18 }
  19
  20 /**
  21  * Retrieve the ID of the current item in the WordPress Loop.
  22  *
  23  * @since 2.1.0
  24  * @uses $post
  25  *
  26  * @return int
  27  */
  28 function get_the_ID() {
  29         global $post;
  30         return $post->ID;
  31 }
  32
  33 /**
  34  * Display or retrieve the current post title with optional content.
  35  *
  36  * @since 0.71
  37  *
  38  * @param string $before Optional. Content to prepend to the title.
  39  * @param string $after Optional. Content to append to the title.
  40  * @param bool $echo Optional, default to true.Whether to display or return.
  41  * @return null|string Null on no title. String if $echo parameter is false.
  42  */
  43 function the_title($before = '', $after = '', $echo = true) {
  44         $title = get_the_title();
  45
  46         if ( strlen($title) == 0 )
  47                 return;
  48
  49         $title = $before . $title . $after;
  50
  51         if ( $echo )
  52                 echo $title;
  53         else
  54                 return $title;
  55 }
  56
  57 /**
  58  * Sanitize the current title when retrieving or displaying.
  59  *
  60  * Works like {@link the_title()}, except the parameters can be in a string or
  61  * an array. See the function for what can be override in the $args parameter.
  62  *
  63  * The title before it is displayed will have the tags stripped and {@link
  64  * esc_attr()} before it is passed to the user or displayed. The default
  65  * as with {@link the_title()}, is to display the title.
  66  *
  67  * @since 2.3.0
  68  *
  69  * @param string|array $args Optional. Override the defaults.
  70  * @return string|null Null on failure or display. String when echo is false.
  71  */
  72 function the_title_attribute( $args = '' ) {
  73         $title = get_the_title();
  74
  75         if ( strlen($title) == 0 )
  76                 return;
  77
  78         $defaults = array('before' => '', 'after' =>  '', 'echo' => true);
  79         $r = wp_parse_args($args, $defaults);
  80         extract( $r, EXTR_SKIP );
  81
  82
  83         $title = $before . $title . $after;
  84         $title = esc_attr(strip_tags($title));
  85
  86         if ( $echo )
  87                 echo $title;
  88         else
  89                 return $title;
  90 }
  91
  92 /**
  93  * Retrieve post title.
  94  *
  95  * If the post is protected and the visitor is not an admin, then "Protected"
  96  * will be displayed before the post title. If the post is private, then
  97  * "Private" will be located before the post title.
  98  *
  99  * @since 0.71
 100  *
 101  * @param int $id Optional. Post ID.
 102  * @return string
 103  */
 104 function get_the_title( $id = 0 ) {
 105         $post = &get_post($id);
 106
 107         $title = isset($post->post_title) ? $post->post_title : '';
 108         $id = isset($post->ID) ? $post->ID : (int) $id;
 109
 110         if ( !is_admin() ) {
 111                 if ( !empty($post->post_password) ) {
 112                         $protected_title_format = apply_filters('protected_title_format', __('Protected: %s'));
 113                         $title = sprintf($protected_title_format, $title);
 114                 } else if ( isset($post->post_status) && 'private' == $post->post_status ) {
 115                         $private_title_format = apply_filters('private_title_format', __('Private: %s'));
 116                         $title = sprintf($private_title_format, $title);
 117                 }
 118         }
 119         return apply_filters( 'the_title', $title, $id );
 120 }
 121
 122 /**
 123  * Display the Post Global Unique Identifier (guid).
 124  *
 125  * The guid will appear to be a link, but should not be used as an link to the
 126  * post. The reason you should not use it as a link, is because of moving the
 127  * blog across domains.
 128  *
 129  * Url is escaped to make it xml safe
 130  *
 131  * @since 1.5.0
 132  *
 133  * @param int $id Optional. Post ID.
 134  */
 135 function the_guid( $id = 0 ) {
 136         echo esc_url( get_the_guid( $id ) );
 137 }
 138
 139 /**
 140  * Retrieve the Post Global Unique Identifier (guid).
 141  *
 142  * The guid will appear to be a link, but should not be used as an link to the
 143  * post. The reason you should not use it as a link, is because of moving the
 144  * blog across domains.
 145  *
 146  * @since 1.5.0
 147  *
 148  * @param int $id Optional. Post ID.
 149  * @return string
 150  */
 151 function get_the_guid( $id = 0 ) {
 152         $post = &get_post($id);
 153
 154         return apply_filters('get_the_guid', $post->guid);
 155 }
 156
 157 /**
 158  * Display the post content.
 159  *
 160  * @since 0.71
 161  *
 162  * @param string $more_link_text Optional. Content for when there is more text.
 163  * @param string $stripteaser Optional. Teaser content before the more text.
 164  */
 165 function the_content($more_link_text = null, $stripteaser = 0) {
 166         $content = get_the_content($more_link_text, $stripteaser);
 167         $content = apply_filters('the_content', $content);
 168         $content = str_replace(']]>', ']]&gt;', $content);
 169         echo $content;
 170 }
 171
 172 /**
 173  * Retrieve the post content.
 174  *
 175  * @since 0.71
 176  *
 177  * @param string $more_link_text Optional. Content for when there is more text.
 178  * @param string $stripteaser Optional. Teaser content before the more text.
 179  * @return string
 180  */
 181 function get_the_content($more_link_text = null, $stripteaser = 0) {
 182         global $post, $more, $page, $pages, $multipage, $preview;
 183
 184         if ( null === $more_link_text )
 185                 $more_link_text = __( '(more...)' );
 186
 187         $output = '';
 188         $hasTeaser = false;
 189
 190         // If post password required and it doesn't match the cookie.
 191         if ( post_password_required($post) ) {
 192                 $output = get_the_password_form();
 193                 return $output;
 194         }
 195
 196         if ( $page > count($pages) ) // if the requested page doesn't exist
 197                 $page = count($pages); // give them the highest numbered page that DOES exist
 198
 199         $content = $pages[$page-1];
 200         if ( preg_match('/<!--more(.*?)?-->/', $content, $matches) ) {
 201                 $content = explode($matches[0], $content, 2);
 202                 if ( !empty($matches[1]) && !empty($more_link_text) )
 203                         $more_link_text = strip_tags(wp_kses_no_null(trim($matches[1])));
 204
 205                 $hasTeaser = true;
 206         } else {
 207                 $content = array($content);
 208         }
 209         if ( (false !== strpos($post->post_content, '<!--noteaser-->') && ((!$multipage) || ($page==1))) )
 210                 $stripteaser = 1;
 211         $teaser = $content[0];
 212         if ( ($more) && ($stripteaser) && ($hasTeaser) )
 213                 $teaser = '';
 214         $output .= $teaser;
 215         if ( count($content) > 1 ) {
 216                 if ( $more ) {
 217                         $output .= '<span id="more-' . $post->ID . '"></span>' . $content[1];
 218                 } else {
 219                         if ( ! empty($more_link_text) )
 220                                 $output .= apply_filters( 'the_content_more_link', ' <a href="' . get_permalink() . "#more-{$post->ID}\" class=\"more-link\">$more_link_text</a>", $more_link_text );
 221                         $output = force_balance_tags($output);
 222                 }
 223
 224         }
 225         if ( $preview ) // preview fix for javascript bug with foreign languages
 226                 $output =       preg_replace_callback('/\%u([0-9A-F]{4})/', '_convert_urlencoded_to_entities', $output);
 227
 228         return $output;
 229 }
 230
 231 /**
 232  * Preview fix for javascript bug with foreign languages
 233  *
 234  * @since 3.1.0
 235  * @access private
 236  * @param array $match Match array from preg_replace_callback
 237  * @returns string
 238  */
 239 function _convert_urlencoded_to_entities( $match ) {
 240         return '&#' . base_convert( $match[1], 16, 10 ) . ';';
 241 }
 242
 243 /**
 244  * Display the post excerpt.
 245  *
 246  * @since 0.71
 247  * @uses apply_filters() Calls 'the_excerpt' hook on post excerpt.
 248  */
 249 function the_excerpt() {
 250         echo apply_filters('the_excerpt', get_the_excerpt());
 251 }
 252
 253 /**
 254  * Retrieve the post excerpt.
 255  *
 256  * @since 0.71
 257  *
 258  * @param mixed $deprecated Not used.
 259  * @return string
 260  */
 261 function get_the_excerpt( $deprecated = '' ) {
 262         if ( !empty( $deprecated ) )
 263                 _deprecated_argument( __FUNCTION__, '2.3' );
 264
 265         global $post;
 266         $output = $post->post_excerpt;
 267         if ( post_password_required($post) ) {
 268                 $output = __('There is no excerpt because this is a protected post.');
 269                 return $output;
 270         }
 271
 272         return apply_filters('get_the_excerpt', $output);
 273 }
 274
 275 /**
 276  * Whether post has excerpt.
 277  *
 278  * @since 2.3.0
 279  *
 280  * @param int $id Optional. Post ID.
 281  * @return bool
 282  */
 283 function has_excerpt( $id = 0 ) {
 284         $post = &get_post( $id );
 285         return ( !empty( $post->post_excerpt ) );
 286 }
 287
 288 /**
 289  * Display the classes for the post div.
 290  *
 291  * @since 2.7.0
 292  *
 293  * @param string|array $class One or more classes to add to the class list.
 294  * @param int $post_id An optional post ID.
 295  */
 296 function post_class( $class = '', $post_id = null ) {
 297         // Separates classes with a single space, collates classes for post DIV
 298         echo 'class="' . join( ' ', get_post_class( $class, $post_id ) ) . '"';
 299 }
 300
 301 /**
 302  * Retrieve the classes for the post div as an array.
 303  *
 304  * The class names are add are many. If the post is a sticky, then the 'sticky'
 305  * class name. The class 'hentry' is always added to each post. For each
 306  * category, the class will be added with 'category-' with category slug is
 307  * added. The tags are the same way as the categories with 'tag-' before the tag
 308  * slug. All classes are passed through the filter, 'post_class' with the list
 309  * of classes, followed by $class parameter value, with the post ID as the last
 310  * parameter.
 311  *
 312  * @since 2.7.0
 313  *
 314  * @param string|array $class One or more classes to add to the class list.
 315  * @param int $post_id An optional post ID.
 316  * @return array Array of classes.
 317  */
 318 function get_post_class( $class = '', $post_id = null ) {
 319         $post = get_post($post_id);
 320
 321         $classes = array();
 322
 323         if ( empty($post) )
 324                 return $classes;
 325
 326         $classes[] = 'post-' . $post->ID;
 327         $classes[] = $post->post_type;
 328         $classes[] = 'type-' . $post->post_type;
 329         $classes[] = 'status-' . $post->post_status;
 330
 331         // Post Format
 332         $post_format = get_post_format( $post->ID );
 333
 334         if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
 335                 if ( $post_format && !is_wp_error($post_format) )
 336                         $classes[] = 'format-' . sanitize_html_class( $post_format );
 337                 else
 338                         $classes[] = 'format-standard';
 339         }
 340
 341         // post requires password
 342         if ( post_password_required($post->ID) )
 343                 $classes[] = 'post-password-required';
 344
 345         // sticky for Sticky Posts
 346         if ( is_sticky($post->ID) && is_home() && !is_paged() )
 347                 $classes[] = 'sticky';
 348
 349         // hentry for hAtom compliance
 350         $classes[] = 'hentry';
 351
 352         // Categories
 353         if ( is_object_in_taxonomy( $post->post_type, 'category' ) ) {
 354                 foreach ( (array) get_the_category($post->ID) as $cat ) {
 355                         if ( empty($cat->slug ) )
 356                                 continue;
 357                         $classes[] = 'category-' . sanitize_html_class($cat->slug, $cat->term_id);
 358                 }
 359         }
 360
 361         // Tags
 362         if ( is_object_in_taxonomy( $post->post_type, 'post_tag' ) ) {
 363                 foreach ( (array) get_the_tags($post->ID) as $tag ) {
 364                         if ( empty($tag->slug ) )
 365                                 continue;
 366                         $classes[] = 'tag-' . sanitize_html_class($tag->slug, $tag->term_id);
 367                 }
 368         }
 369
 370         if ( !empty($class) ) {
 371                 if ( !is_array( $class ) )
 372                         $class = preg_split('#\s+#', $class);
 373                 $classes = array_merge($classes, $class);
 374         }
 375
 376         $classes = array_map('esc_attr', $classes);
 377
 378         return apply_filters('post_class', $classes, $class, $post->ID);
 379 }
 380
 381 /**
 382  * Display the classes for the body element.
 383  *
 384  * @since 2.8.0
 385  *
 386  * @param string|array $class One or more classes to add to the class list.
 387  */
 388 function body_class( $class = '' ) {
 389         // Separates classes with a single space, collates classes for body element
 390         echo 'class="' . join( ' ', get_body_class( $class ) ) . '"';
 391 }
 392
 393 /**
 394  * Retrieve the classes for the body element as an array.
 395  *
 396  * @since 2.8.0
 397  *
 398  * @param string|array $class One or more classes to add to the class list.
 399  * @return array Array of classes.
 400  */
 401 function get_body_class( $class = '' ) {
 402         global $wp_query, $wpdb;
 403
 404         $classes = array();
 405
 406         if ( is_rtl() )
 407                 $classes[] = 'rtl';
 408
 409         if ( is_front_page() )
 410                 $classes[] = 'home';
 411         if ( is_home() )
 412                 $classes[] = 'blog';
 413         if ( is_archive() )
 414                 $classes[] = 'archive';
 415         if ( is_date() )
 416                 $classes[] = 'date';
 417         if ( is_search() )
 418                 $classes[] = 'search';
 419         if ( is_paged() )
 420                 $classes[] = 'paged';
 421         if ( is_attachment() )
 422                 $classes[] = 'attachment';
 423         if ( is_404() )
 424                 $classes[] = 'error404';
 425
 426         if ( is_single() ) {
 427                 $post_id = $wp_query->get_queried_object_id();
 428                 $post = $wp_query->get_queried_object();
 429
 430                 $classes[] = 'single';
 431                 $classes[] = 'single-' . sanitize_html_class($post->post_type, $post_id);
 432                 $classes[] = 'postid-' . $post_id;
 433
 434                 // Post Format
 435                 $post_format = get_post_format( $post->ID );
 436
 437                 if ( $post_format && !is_wp_error($post_format) )
 438                         $classes[] = 'single-format-' . sanitize_html_class( $post_format );
 439                 else
 440                         $classes[] = 'single-format-standard';
 441
 442                 if ( is_attachment() ) {
 443                         $mime_type = get_post_mime_type($post_id);
 444                         $mime_prefix = array( 'application/', 'image/', 'text/', 'audio/', 'video/', 'music/' );
 445                         $classes[] = 'attachmentid-' . $post_id;
 446                         $classes[] = 'attachment-' . str_replace( $mime_prefix, '', $mime_type );
 447                 }
 448         } elseif ( is_archive() ) {
 449                 if ( is_post_type_archive() ) {
 450                         $classes[] = 'post-type-archive';
 451                         $classes[] = 'post-type-archive-' . sanitize_html_class( get_query_var( 'post_type' ) );
 452                 } else if ( is_author() ) {
 453                         $author = $wp_query->get_queried_object();
 454                         $classes[] = 'author';
 455                         $classes[] = 'author-' . sanitize_html_class( $author->user_nicename , $author->ID );
 456                         $classes[] = 'author-' . $author->ID;
 457                 } elseif ( is_category() ) {
 458                         $cat = $wp_query->get_queried_object();
 459                         $classes[] = 'category';
 460                         $classes[] = 'category-' . sanitize_html_class( $cat->slug, $cat->term_id );
 461                         $classes[] = 'category-' . $cat->term_id;
 462                 } elseif ( is_tag() ) {
 463                         $tags = $wp_query->get_queried_object();
 464                         $classes[] = 'tag';
 465                         $classes[] = 'tag-' . sanitize_html_class( $tags->slug, $tags->term_id );
 466                         $classes[] = 'tag-' . $tags->term_id;
 467                 } elseif ( is_tax() ) {
 468                         $term = $wp_query->get_queried_object();
 469                         $classes[] = 'tax-' . sanitize_html_class( $term->taxonomy );
 470                         $classes[] = 'term-' . sanitize_html_class( $term->slug, $term->term_id );
 471                         $classes[] = 'term-' . $term->term_id;
 472                 }
 473         } elseif ( is_page() ) {
 474                 $classes[] = 'page';
 475
 476                 $page_id = $wp_query->get_queried_object_id();
 477
 478                 $post = get_page($page_id);
 479
 480                 $classes[] = 'page-id-' . $page_id;
 481
 482                 if ( $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status = 'publish' LIMIT 1", $page_id) ) )
 483                         $classes[] = 'page-parent';
 484
 485                 if ( $post->post_parent ) {
 486                         $classes[] = 'page-child';
 487                         $classes[] = 'parent-pageid-' . $post->post_parent;
 488                 }
 489                 if ( is_page_template() ) {
 490                         $classes[] = 'page-template';
 491                         $classes[] = 'page-template-' . sanitize_html_class( str_replace( '.', '-', get_post_meta( $page_id, '_wp_page_template', true ) ), '' );
 492                 }
 493         } elseif ( is_search() ) {
 494                 if ( !empty( $wp_query->posts ) )
 495                         $classes[] = 'search-results';
 496                 else
 497                         $classes[] = 'search-no-results';
 498         }
 499
 500         if ( is_user_logged_in() )
 501                 $classes[] = 'logged-in';
 502
 503         if ( is_admin_bar_showing() )
 504                 $classes[] = 'admin-bar';
 505
 506         $page = $wp_query->get( 'page' );
 507
 508         if ( !$page || $page < 2)
 509                 $page = $wp_query->get( 'paged' );
 510
 511         if ( $page && $page > 1 ) {
 512                 $classes[] = 'paged-' . $page;
 513
 514                 if ( is_single() )
 515                         $classes[] = 'single-paged-' . $page;
 516                 elseif ( is_page() )
 517                         $classes[] = 'page-paged-' . $page;
 518                 elseif ( is_category() )
 519                         $classes[] = 'category-paged-' . $page;
 520                 elseif ( is_tag() )
 521                         $classes[] = 'tag-paged-' . $page;
 522                 elseif ( is_date() )
 523                         $classes[] = 'date-paged-' . $page;
 524                 elseif ( is_author() )
 525                         $classes[] = 'author-paged-' . $page;
 526                 elseif ( is_search() )
 527                         $classes[] = 'search-paged-' . $page;
 528                 elseif ( is_post_type_archive() )
 529                         $classes[] = 'post-type-paged-' . $page;
 530         }
 531
 532         if ( ! empty( $class ) ) {
 533                 if ( !is_array( $class ) )
 534                         $class = preg_split( '#\s+#', $class );
 535                 $classes = array_merge( $classes, $class );
 536         } else {
 537                 // Ensure that we always coerce class to being an array.
 538                 $class = array();
 539         }
 540
 541         $classes = array_map( 'esc_attr', $classes );
 542
 543         return apply_filters( 'body_class', $classes, $class );
 544 }
 545
 546 /**
 547  * Whether post requires password and correct password has been provided.
 548  *
 549  * @since 2.7.0
 550  *
 551  * @param int|object $post An optional post.  Global $post used if not provided.
 552  * @return bool false if a password is not required or the correct password cookie is present, true otherwise.
 553  */
 554 function post_password_required( $post = null ) {
 555         $post = get_post($post);
 556
 557         if ( empty($post->post_password) )
 558                 return false;
 559
 560         if ( !isset($_COOKIE['wp-postpass_' . COOKIEHASH]) )
 561                 return true;
 562
 563         if ( $_COOKIE['wp-postpass_' . COOKIEHASH] != $post->post_password )
 564                 return true;
 565
 566         return false;
 567 }
 568
 569 /**
 570  * Display "sticky" CSS class, if a post is sticky.
 571  *
 572  * @since 2.7.0
 573  *
 574  * @param int $post_id An optional post ID.
 575  */
 576 function sticky_class( $post_id = null ) {
 577         if ( !is_sticky($post_id) )
 578                 return;
 579
 580         echo " sticky";
 581 }
 582
 583 /**
 584  * Page Template Functions for usage in Themes
 585  *
 586  * @package WordPress
 587  * @subpackage Template
 588  */
 589
 590 /**
 591  * The formatted output of a list of pages.
 592  *
 593  * Displays page links for paginated posts (i.e. includes the <!--nextpage-->.
 594  * Quicktag one or more times). This tag must be within The Loop.
 595  *
 596  * The defaults for overwriting are:
 597  * 'next_or_number' - Default is 'number' (string). Indicates whether page
 598  *      numbers should be used. Valid values are number and next.
 599  * 'nextpagelink' - Default is 'Next Page' (string). Text for link to next page.
 600  *      of the bookmark.
 601  * 'previouspagelink' - Default is 'Previous Page' (string). Text for link to
 602  *      previous page, if available.
 603  * 'pagelink' - Default is '%' (String).Format string for page numbers. The % in
 604  *      the parameter string will be replaced with the page number, so Page %
 605  *      generates "Page 1", "Page 2", etc. Defaults to %, just the page number.
 606  * 'before' - Default is '<p> Pages:' (string). The html or text to prepend to
 607  *      each bookmarks.
 608  * 'after' - Default is '</p>' (string). The html or text to append to each
 609  *      bookmarks.
 610  * 'link_before' - Default is '' (string). The html or text to prepend to each
 611  *      Pages link inside the <a> tag. Also prepended to the current item, which
 612  *      is not linked.
 613  * 'link_after' - Default is '' (string). The html or text to append to each
 614  *      Pages link inside the <a> tag. Also appended to the current item, which
 615  *      is not linked.
 616  *
 617  * @since 1.2.0
 618  * @access private
 619  *
 620  * @param string|array $args Optional. Overwrite the defaults.
 621  * @return string Formatted output in HTML.
 622  */
 623 function wp_link_pages($args = '') {
 624         $defaults = array(
 625                 'before' => '<p>' . __('Pages:'), 'after' => '</p>',
 626                 'link_before' => '', 'link_after' => '',
 627                 'next_or_number' => 'number', 'nextpagelink' => __('Next page'),
 628                 'previouspagelink' => __('Previous page'), 'pagelink' => '%',
 629                 'echo' => 1
 630         );
 631
 632         $r = wp_parse_args( $args, $defaults );
 633         $r = apply_filters( 'wp_link_pages_args', $r );
 634         extract( $r, EXTR_SKIP );
 635
 636         global $page, $numpages, $multipage, $more, $pagenow;
 637
 638         $output = '';
 639         if ( $multipage ) {
 640                 if ( 'number' == $next_or_number ) {
 641                         $output .= $before;
 642                         for ( $i = 1; $i < ($numpages+1); $i = $i + 1 ) {
 643                                 $j = str_replace('%',$i,$pagelink);
 644                                 $output .= ' ';
 645                                 if ( ($i != $page) || ((!$more) && ($page==1)) ) {
 646                                         $output .= _wp_link_page($i);
 647                                 }
 648                                 $output .= $link_before . $j . $link_after;
 649                                 if ( ($i != $page) || ((!$more) && ($page==1)) )
 650                                         $output .= '</a>';
 651                         }
 652                         $output .= $after;
 653                 } else {
 654                         if ( $more ) {
 655                                 $output .= $before;
 656                                 $i = $page - 1;
 657                                 if ( $i && $more ) {
 658                                         $output .= _wp_link_page($i);
 659                                         $output .= $link_before. $previouspagelink . $link_after . '</a>';
 660                                 }
 661                                 $i = $page + 1;
 662                                 if ( $i <= $numpages && $more ) {
 663                                         $output .= _wp_link_page($i);
 664                                         $output .= $link_before. $nextpagelink . $link_after . '</a>';
 665                                 }
 666                                 $output .= $after;
 667                         }
 668                 }
 669         }
 670
 671         if ( $echo )
 672                 echo $output;
 673
 674         return $output;
 675 }
 676
 677 /**
 678  * Helper function for wp_link_pages().
 679  *
 680  * @since 3.1.0
 681  * @access private
 682  *
 683  * @param int $i Page number.
 684  * @return string Link.
 685  */
 686 function _wp_link_page( $i ) {
 687         global $post, $wp_rewrite;
 688
 689         if ( 1 == $i ) {
 690                 $url = get_permalink();
 691         } else {
 692                 if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) )
 693                         $url = add_query_arg( 'page', $i, get_permalink() );
 694                 elseif ( 'page' == get_option('show_on_front') && get_option('page_on_front') == $post->ID )
 695                         $url = trailingslashit(get_permalink()) . user_trailingslashit("$wp_rewrite->pagination_base/" . $i, 'single_paged');
 696                 else
 697                         $url = trailingslashit(get_permalink()) . user_trailingslashit($i, 'single_paged');
 698         }
 699
 700         return '<a href="' . esc_url( $url ) . '">';
 701 }
 702
 703 //
 704 // Post-meta: Custom per-post fields.
 705 //
 706
 707 /**
 708  * Retrieve post custom meta data field.
 709  *
 710  * @since 1.5.0
 711  *
 712  * @param string $key Meta data key name.
 713  * @return bool|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist.
 714  */
 715 function post_custom( $key = '' ) {
 716         $custom = get_post_custom();
 717
 718         if ( !isset( $custom[$key] ) )
 719                 return false;
 720         elseif ( 1 == count($custom[$key]) )
 721                 return $custom[$key][0];
 722         else
 723                 return $custom[$key];
 724 }
 725
 726 /**
 727  * Display list of post custom fields.
 728  *
 729  * @internal This will probably change at some point...
 730  * @since 1.2.0
 731  * @uses apply_filters() Calls 'the_meta_key' on list item HTML content, with key and value as separate parameters.
 732  */
 733 function the_meta() {
 734         if ( $keys = get_post_custom_keys() ) {
 735                 echo "<ul class='post-meta'>\n";
 736                 foreach ( (array) $keys as $key ) {
 737                         $keyt = trim($key);
 738                         if ( '_' == $keyt[0] )
 739                                 continue;
 740                         $values = array_map('trim', get_post_custom_values($key));
 741                         $value = implode($values,', ');
 742                         echo apply_filters('the_meta_key', "<li><span class='post-meta-key'>$key:</span> $value</li>\n", $key, $value);
 743                 }
 744                 echo "</ul>\n";
 745         }
 746 }
 747
 748 //
 749 // Pages
 750 //
 751
 752 /**
 753  * Retrieve or display list of pages as a dropdown (select list).
 754  *
 755  * @since 2.1.0
 756  *
 757  * @param array|string $args Optional. Override default arguments.
 758  * @return string HTML content, if not displaying.
 759  */
 760 function wp_dropdown_pages($args = '') {
 761         $defaults = array(
 762                 'depth' => 0, 'child_of' => 0,
 763                 'selected' => 0, 'echo' => 1,
 764                 'name' => 'page_id', 'id' => '',
 765                 'show_option_none' => '', 'show_option_no_change' => '',
 766                 'option_none_value' => ''
 767         );
 768
 769         $r = wp_parse_args( $args, $defaults );
 770         extract( $r, EXTR_SKIP );
 771
 772         $pages = get_pages($r);
 773         $output = '';
 774         $name = esc_attr($name);
 775         // Back-compat with old system where both id and name were based on $name argument
 776         if ( empty($id) )
 777                 $id = $name;
 778
 779         if ( ! empty($pages) ) {
 780                 $output = "<select name=\"$name\" id=\"$id\">\n";
 781                 if ( $show_option_no_change )
 782                         $output .= "\t<option value=\"-1\">$show_option_no_change</option>";
 783                 if ( $show_option_none )
 784                         $output .= "\t<option value=\"" . esc_attr($option_none_value) . "\">$show_option_none</option>\n";
 785                 $output .= walk_page_dropdown_tree($pages, $depth, $r);
 786                 $output .= "</select>\n";
 787         }
 788
 789         $output = apply_filters('wp_dropdown_pages', $output);
 790
 791         if ( $echo )
 792                 echo $output;
 793
 794         return $output;
 795 }
 796
 797 /**
 798  * Retrieve or display list of pages in list (li) format.
 799  *
 800  * @since 1.5.0
 801  *
 802  * @param array|string $args Optional. Override default arguments.
 803  * @return string HTML content, if not displaying.
 804  */
 805 function wp_list_pages($args = '') {
 806         $defaults = array(
 807                 'depth' => 0, 'show_date' => '',
 808                 'date_format' => get_option('date_format'),
 809                 'child_of' => 0, 'exclude' => '',
 810                 'title_li' => __('Pages'), 'echo' => 1,
 811                 'authors' => '', 'sort_column' => 'menu_order, post_title',
 812                 'link_before' => '', 'link_after' => '', 'walker' => '',
 813         );
 814
 815         $r = wp_parse_args( $args, $defaults );
 816         extract( $r, EXTR_SKIP );
 817
 818         $output = '';
 819         $current_page = 0;
 820
 821         // sanitize, mostly to keep spaces out
 822         $r['exclude'] = preg_replace('/[^0-9,]/', '', $r['exclude']);
 823
 824         // Allow plugins to filter an array of excluded pages (but don't put a nullstring into the array)
 825         $exclude_array = ( $r['exclude'] ) ? explode(',', $r['exclude']) : array();
 826         $r['exclude'] = implode( ',', apply_filters('wp_list_pages_excludes', $exclude_array) );
 827
 828         // Query pages.
 829         $r['hierarchical'] = 0;
 830         $pages = get_pages($r);
 831
 832         if ( !empty($pages) ) {
 833                 if ( $r['title_li'] )
 834                         $output .= '<li class="pagenav">' . $r['title_li'] . '<ul>';
 835
 836                 global $wp_query;
 837                 if ( is_page() || is_attachment() || $wp_query->is_posts_page )
 838                         $current_page = $wp_query->get_queried_object_id();
 839                 $output .= walk_page_tree($pages, $r['depth'], $current_page, $r);
 840
 841                 if ( $r['title_li'] )
 842                         $output .= '</ul></li>';
 843         }
 844
 845         $output = apply_filters('wp_list_pages', $output, $r);
 846
 847         if ( $r['echo'] )
 848                 echo $output;
 849         else
 850                 return $output;
 851 }
 852
 853 /**
 854  * Display or retrieve list of pages with optional home link.
 855  *
 856  * The arguments are listed below and part of the arguments are for {@link
 857  * wp_list_pages()} function. Check that function for more info on those
 858  * arguments.
 859  *
 860  * <ul>
 861  * <li><strong>sort_column</strong> - How to sort the list of pages. Defaults
 862  * to page title. Use column for posts table.</li>
 863  * <li><strong>menu_class</strong> - Class to use for the div ID which contains
 864  * the page list. Defaults to 'menu'.</li>
 865  * <li><strong>echo</strong> - Whether to echo list or return it. Defaults to
 866  * echo.</li>
 867  * <li><strong>link_before</strong> - Text before show_home argument text.</li>
 868  * <li><strong>link_after</strong> - Text after show_home argument text.</li>
 869  * <li><strong>show_home</strong> - If you set this argument, then it will
 870  * display the link to the home page. The show_home argument really just needs
 871  * to be set to the value of the text of the link.</li>
 872  * </ul>
 873  *
 874  * @since 2.7.0
 875  *
 876  * @param array|string $args
 877  */
 878 function wp_page_menu( $args = array() ) {
 879         $defaults = array('sort_column' => 'menu_order, post_title', 'menu_class' => 'menu', 'echo' => true, 'link_before' => '', 'link_after' => '');
 880         $args = wp_parse_args( $args, $defaults );
 881         $args = apply_filters( 'wp_page_menu_args', $args );
 882
 883         $menu = '';
 884
 885         $list_args = $args;
 886
 887         // Show Home in the menu
 888         if ( ! empty($args['show_home']) ) {
 889                 if ( true === $args['show_home'] || '1' === $args['show_home'] || 1 === $args['show_home'] )
 890                         $text = __('Home');
 891                 else
 892                         $text = $args['show_home'];
 893                 $class = '';
 894                 if ( is_front_page() && !is_paged() )
 895                         $class = 'class="current_page_item"';
 896                 $menu .= '<li ' . $class . '><a href="' . home_url( '/' ) . '" title="' . esc_attr($text) . '">' . $args['link_before'] . $text . $args['link_after'] . '</a></li>';
 897                 // If the front page is a page, add it to the exclude list
 898                 if (get_option('show_on_front') == 'page') {
 899                         if ( !empty( $list_args['exclude'] ) ) {
 900                                 $list_args['exclude'] .= ',';
 901                         } else {
 902                                 $list_args['exclude'] = '';
 903                         }
 904                         $list_args['exclude'] .= get_option('page_on_front');
 905                 }
 906         }
 907
 908         $list_args['echo'] = false;
 909         $list_args['title_li'] = '';
 910         $menu .= str_replace( array( "\r", "\n", "\t" ), '', wp_list_pages($list_args) );
 911
 912         if ( $menu )
 913                 $menu = '<ul>' . $menu . '</ul>';
 914
 915         $menu = '<div class="' . esc_attr($args['menu_class']) . '">' . $menu . "</div>\n";
 916         $menu = apply_filters( 'wp_page_menu', $menu, $args );
 917         if ( $args['echo'] )
 918                 echo $menu;
 919         else
 920                 return $menu;
 921 }
 922
 923 //
 924 // Page helpers
 925 //
 926
 927 /**
 928  * Retrieve HTML list content for page list.
 929  *
 930  * @uses Walker_Page to create HTML list content.
 931  * @since 2.1.0
 932  * @see Walker_Page::walk() for parameters and return description.
 933  */
 934 function walk_page_tree($pages, $depth, $current_page, $r) {
 935         if ( empty($r['walker']) )
 936                 $walker = new Walker_Page;
 937         else
 938                 $walker = $r['walker'];
 939
 940         $args = array($pages, $depth, $r, $current_page);
 941         return call_user_func_array(array(&$walker, 'walk'), $args);
 942 }
 943
 944 /**
 945  * Retrieve HTML dropdown (select) content for page list.
 946  *
 947  * @uses Walker_PageDropdown to create HTML dropdown content.
 948  * @since 2.1.0
 949  * @see Walker_PageDropdown::walk() for parameters and return description.
 950  */
 951 function walk_page_dropdown_tree() {
 952         $args = func_get_args();
 953         if ( empty($args[2]['walker']) ) // the user's options are the third parameter
 954                 $walker = new Walker_PageDropdown;
 955         else
 956                 $walker = $args[2]['walker'];
 957
 958         return call_user_func_array(array(&$walker, 'walk'), $args);
 959 }
 960
 961 /**
 962  * Create HTML list of pages.
 963  *
 964  * @package WordPress
 965  * @since 2.1.0
 966  * @uses Walker
 967  */
 968 class Walker_Page extends Walker {
 969         /**
 970          * @see Walker::$tree_type
 971          * @since 2.1.0
 972          * @var string
 973          */
 974         var $tree_type = 'page';
 975
 976         /**
 977          * @see Walker::$db_fields
 978          * @since 2.1.0
 979          * @todo Decouple this.
 980          * @var array
 981          */
 982         var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
 983
 984         /**
 985          * @see Walker::start_lvl()
 986          * @since 2.1.0
 987          *
 988          * @param string $output Passed by reference. Used to append additional content.
 989          * @param int $depth Depth of page. Used for padding.
 990          */
 991         function start_lvl(&$output, $depth) {
 992                 $indent = str_repeat("\t", $depth);
 993                 $output .= "\n$indent<ul class='children'>\n";
 994         }
 995
 996         /**
 997          * @see Walker::end_lvl()
 998          * @since 2.1.0
 999          *
1000          * @param string $output Passed by reference. Used to append additional content.
1001          * @param int $depth Depth of page. Used for padding.
1002          */
1003         function end_lvl(&$output, $depth) {
1004                 $indent = str_repeat("\t", $depth);
1005                 $output .= "$indent</ul>\n";
1006         }
1007
1008         /**
1009          * @see Walker::start_el()
1010          * @since 2.1.0
1011          *
1012          * @param string $output Passed by reference. Used to append additional content.
1013          * @param object $page Page data object.
1014          * @param int $depth Depth of page. Used for padding.
1015          * @param int $current_page Page ID.
1016          * @param array $args
1017          */
1018         function start_el(&$output, $page, $depth, $args, $current_page) {
1019                 if ( $depth )
1020                         $indent = str_repeat("\t", $depth);
1021                 else
1022                         $indent = '';
1023
1024                 extract($args, EXTR_SKIP);
1025                 $css_class = array('page_item', 'page-item-'.$page->ID);
1026                 if ( !empty($current_page) ) {
1027                         $_current_page = get_page( $current_page );
1028                         _get_post_ancestors($_current_page);
1029                         if ( isset($_current_page->ancestors) && in_array($page->ID, (array) $_current_page->ancestors) )
1030                                 $css_class[] = 'current_page_ancestor';
1031                         if ( $page->ID == $current_page )
1032                                 $css_class[] = 'current_page_item';
1033                         elseif ( $_current_page && $page->ID == $_current_page->post_parent )
1034                                 $css_class[] = 'current_page_parent';
1035                 } elseif ( $page->ID == get_option('page_for_posts') ) {
1036                         $css_class[] = 'current_page_parent';
1037                 }
1038
1039                 $css_class = implode(' ', apply_filters('page_css_class', $css_class, $page));
1040
1041                 $output .= $indent . '<li class="' . $css_class . '"><a href="' . get_permalink($page->ID) . '" title="' . esc_attr( wp_strip_all_tags( apply_filters( 'the_title', $page->post_title, $page->ID ) ) ) . '">' . $link_before . apply_filters( 'the_title', $page->post_title, $page->ID ) . $link_after . '</a>';
1042
1043                 if ( !empty($show_date) ) {
1044                         if ( 'modified' == $show_date )
1045                                 $time = $page->post_modified;
1046                         else
1047                                 $time = $page->post_date;
1048
1049                         $output .= " " . mysql2date($date_format, $time);
1050                 }
1051         }
1052
1053         /**
1054          * @see Walker::end_el()
1055          * @since 2.1.0
1056          *
1057          * @param string $output Passed by reference. Used to append additional content.
1058          * @param object $page Page data object. Not used.
1059          * @param int $depth Depth of page. Not Used.
1060          */
1061         function end_el(&$output, $page, $depth) {
1062                 $output .= "</li>\n";
1063         }
1064
1065 }
1066
1067 /**
1068  * Create HTML dropdown list of pages.
1069  *
1070  * @package WordPress
1071  * @since 2.1.0
1072  * @uses Walker
1073  */
1074 class Walker_PageDropdown extends Walker {
1075         /**
1076          * @see Walker::$tree_type
1077          * @since 2.1.0
1078          * @var string
1079          */
1080         var $tree_type = 'page';
1081
1082         /**
1083          * @see Walker::$db_fields
1084          * @since 2.1.0
1085          * @todo Decouple this
1086          * @var array
1087          */
1088         var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
1089
1090         /**
1091          * @see Walker::start_el()
1092          * @since 2.1.0
1093          *
1094          * @param string $output Passed by reference. Used to append additional content.
1095          * @param object $page Page data object.
1096          * @param int $depth Depth of page in reference to parent pages. Used for padding.
1097          * @param array $args Uses 'selected' argument for selected page to set selected HTML attribute for option element.
1098          */
1099         function start_el(&$output, $page, $depth, $args) {
1100                 $pad = str_repeat('&nbsp;', $depth * 3);
1101
1102                 $output .= "\t<option class=\"level-$depth\" value=\"$page->ID\"";
1103                 if ( $page->ID == $args['selected'] )
1104                         $output .= ' selected="selected"';
1105                 $output .= '>';
1106                 $title = apply_filters( 'list_pages', $page->post_title );
1107                 $output .= $pad . esc_html( $title );
1108                 $output .= "</option>\n";
1109         }
1110 }
1111
1112 //
1113 // Attachments
1114 //
1115
1116 /**
1117  * Display an attachment page link using an image or icon.
1118  *
1119  * @since 2.0.0
1120  *
1121  * @param int $id Optional. Post ID.
1122  * @param bool $fullsize Optional, default is false. Whether to use full size.
1123  * @param bool $deprecated Deprecated. Not used.
1124  * @param bool $permalink Optional, default is false. Whether to include permalink.
1125  */
1126 function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
1127         if ( !empty( $deprecated ) )
1128                 _deprecated_argument( __FUNCTION__, '2.5' );
1129
1130         if ( $fullsize )
1131                 echo wp_get_attachment_link($id, 'full', $permalink);
1132         else
1133                 echo wp_get_attachment_link($id, 'thumbnail', $permalink);
1134 }
1135
1136 /**
1137  * Retrieve an attachment page link using an image or icon, if possible.
1138  *
1139  * @since 2.5.0
1140  * @uses apply_filters() Calls 'wp_get_attachment_link' filter on HTML content with same parameters as function.
1141  *
1142  * @param int $id Optional. Post ID.
1143  * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string.
1144  * @param bool $permalink Optional, default is false. Whether to add permalink to image.
1145  * @param bool $icon Optional, default is false. Whether to include icon.
1146  * @param string $text Optional, default is false. If string, then will be link text.
1147  * @return string HTML content.
1148  */
1149 function wp_get_attachment_link($id = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false) {
1150         $id = intval($id);
1151         $_post = & get_post( $id );
1152
1153         if ( ('attachment' != $_post->post_type) || !$url = wp_get_attachment_url($_post->ID) )
1154                 return __('Missing Attachment');
1155
1156         if ( $permalink )
1157                 $url = get_attachment_link($_post->ID);
1158
1159         $post_title = esc_attr($_post->post_title);
1160
1161         if ( $text ) {
1162                 $link_text = esc_attr($text);
1163         } elseif ( ( is_int($size) && $size != 0 ) or ( is_string($size) && $size != 'none' ) or $size != false ) {
1164                 $link_text = wp_get_attachment_image($id, $size, $icon);
1165         } else {
1166                 $link_text = '';
1167         }
1168
1169         if( trim($link_text) == '' )
1170                 $link_text = $_post->post_title;
1171
1172         return apply_filters( 'wp_get_attachment_link', "<a href='$url' title='$post_title'>$link_text</a>", $id, $size, $permalink, $icon, $text );
1173 }
1174
1175 /**
1176  * Wrap attachment in <<p>> element before content.
1177  *
1178  * @since 2.0.0
1179  * @uses apply_filters() Calls 'prepend_attachment' hook on HTML content.
1180  *
1181  * @param string $content
1182  * @return string
1183  */
1184 function prepend_attachment($content) {
1185         global $post;
1186
1187         if ( empty($post->post_type) || $post->post_type != 'attachment' )
1188                 return $content;
1189
1190         $p = '<p class="attachment">';
1191         // show the medium sized image representation of the attachment if available, and link to the raw file
1192         $p .= wp_get_attachment_link(0, 'medium', false);
1193         $p .= '</p>';
1194         $p = apply_filters('prepend_attachment', $p);
1195
1196         return "$p\n$content";
1197 }
1198
1199 //
1200 // Misc
1201 //
1202
1203 /**
1204  * Retrieve protected post password form content.
1205  *
1206  * @since 1.0.0
1207  * @uses apply_filters() Calls 'the_password_form' filter on output.
1208  *
1209  * @return string HTML content for password form for password protected post.
1210  */
1211 function get_the_password_form() {
1212         global $post;
1213         $label = 'pwbox-'.(empty($post->ID) ? rand() : $post->ID);
1214         $output = '<form action="' . get_option('siteurl') . '/wp-pass.php" method="post">
1215         <p>' . __("This post is password protected. To view it please enter your password below:") . '</p>
1216         <p><label for="' . $label . '">' . __("Password:") . ' <input name="post_password" id="' . $label . '" type="password" size="20" /></label> <input type="submit" name="Submit" value="' . esc_attr__("Submit") . '" /></p>
1217         </form>
1218         ';
1219         return apply_filters('the_password_form', $output);
1220 }
1221
1222 /**
1223  * Whether currently in a page template.
1224  *
1225  * This template tag allows you to determine if you are in a page template.
1226  * You can optionally provide a template name and then the check will be
1227  * specific to that template.
1228  *
1229  * @since 2.5.0
1230  * @uses $wp_query
1231  *
1232  * @param string $template The specific template name if specific matching is required.
1233  * @return bool False on failure, true if success.
1234  */
1235 function is_page_template($template = '') {
1236         if (!is_page()) {
1237                 return false;
1238         }
1239
1240         global $wp_query;
1241
1242         $page = $wp_query->get_queried_object();
1243         $custom_fields = get_post_custom_values('_wp_page_template',$page->ID);
1244         $page_template = $custom_fields[0];
1245
1246         // We have no argument passed so just see if a page_template has been specified
1247         if ( empty( $template ) ) {
1248                 if ( !empty( $page_template ) and ( 'default' != $page_template ) ) {
1249                         return true;
1250                 }
1251         } elseif ( $template == $page_template) {
1252                 return true;
1253         }
1254
1255         return false;
1256 }
1257
1258 /**
1259  * Retrieve formatted date timestamp of a revision (linked to that revisions's page).
1260  *
1261  * @package WordPress
1262  * @subpackage Post_Revisions
1263  * @since 2.6.0
1264  *
1265  * @uses date_i18n()
1266  *
1267  * @param int|object $revision Revision ID or revision object.
1268  * @param bool $link Optional, default is true. Link to revisions's page?
1269  * @return string i18n formatted datetimestamp or localized 'Current Revision'.
1270  */
1271 function wp_post_revision_title( $revision, $link = true ) {
1272         if ( !$revision = get_post( $revision ) )
1273                 return $revision;
1274
1275         if ( !in_array( $revision->post_type, array( 'post', 'page', 'revision' ) ) )
1276                 return false;
1277
1278         /* translators: revision date format, see http://php.net/date */
1279         $datef = _x( 'j F, Y @ G:i', 'revision date format');
1280         /* translators: 1: date */
1281         $autosavef = __( '%1$s [Autosave]' );
1282         /* translators: 1: date */
1283         $currentf  = __( '%1$s [Current Revision]' );
1284
1285         $date = date_i18n( $datef, strtotime( $revision->post_modified ) );
1286         if ( $link && current_user_can( 'edit_post', $revision->ID ) && $link = get_edit_post_link( $revision->ID ) )
1287                 $date = "<a href='$link'>$date</a>";
1288
1289         if ( !wp_is_post_revision( $revision ) )
1290                 $date = sprintf( $currentf, $date );
1291         elseif ( wp_is_post_autosave( $revision ) )
1292                 $date = sprintf( $autosavef, $date );
1293
1294         return $date;
1295 }
1296
1297 /**
1298  * Display list of a post's revisions.
1299  *
1300  * Can output either a UL with edit links or a TABLE with diff interface, and
1301  * restore action links.
1302  *
1303  * Second argument controls parameters:
1304  *   (bool)   parent : include the parent (the "Current Revision") in the list.
1305  *   (string) format : 'list' or 'form-table'.  'list' outputs UL, 'form-table'
1306  *                     outputs TABLE with UI.
1307  *   (int)    right  : what revision is currently being viewed - used in
1308  *                     form-table format.
1309  *   (int)    left   : what revision is currently being diffed against right -
1310  *                     used in form-table format.
1311  *
1312  * @package WordPress
1313  * @subpackage Post_Revisions
1314  * @since 2.6.0
1315  *
1316  * @uses wp_get_post_revisions()
1317  * @uses wp_post_revision_title()
1318  * @uses get_edit_post_link()
1319  * @uses get_the_author_meta()
1320  *
1321  * @todo split into two functions (list, form-table) ?
1322  *
1323  * @param int|object $post_id Post ID or post object.
1324  * @param string|array $args See description {@link wp_parse_args()}.
1325  * @return null
1326  */
1327 function wp_list_post_revisions( $post_id = 0, $args = null ) {
1328         if ( !$post = get_post( $post_id ) )
1329                 return;
1330
1331         $defaults = array( 'parent' => false, 'right' => false, 'left' => false, 'format' => 'list', 'type' => 'all' );
1332         extract( wp_parse_args( $args, $defaults ), EXTR_SKIP );
1333
1334         switch ( $type ) {
1335                 case 'autosave' :
1336                         if ( !$autosave = wp_get_post_autosave( $post->ID ) )
1337                                 return;
1338                         $revisions = array( $autosave );
1339                         break;
1340                 case 'revision' : // just revisions - remove autosave later
1341                 case 'all' :
1342                 default :
1343                         if ( !$revisions = wp_get_post_revisions( $post->ID ) )
1344                                 return;
1345                         break;
1346         }
1347
1348         /* translators: post revision: 1: when, 2: author name */
1349         $titlef = _x( '%1$s by %2$s', 'post revision' );
1350
1351         if ( $parent )
1352                 array_unshift( $revisions, $post );
1353
1354         $rows = $right_checked = '';
1355         $class = false;
1356         $can_edit_post = current_user_can( 'edit_post', $post->ID );
1357         foreach ( $revisions as $revision ) {
1358                 if ( !current_user_can( 'read_post', $revision->ID ) )
1359                         continue;
1360                 if ( 'revision' === $type && wp_is_post_autosave( $revision ) )
1361                         continue;
1362
1363                 $date = wp_post_revision_title( $revision );
1364                 $name = get_the_author_meta( 'display_name', $revision->post_author );
1365
1366                 if ( 'form-table' == $format ) {
1367                         if ( $left )
1368                                 $left_checked = $left == $revision->ID ? ' checked="checked"' : '';
1369                         else
1370                                 $left_checked = $right_checked ? ' checked="checked"' : ''; // [sic] (the next one)
1371                         $right_checked = $right == $revision->ID ? ' checked="checked"' : '';
1372
1373                         $class = $class ? '' : " class='alternate'";
1374
1375                         if ( $post->ID != $revision->ID && $can_edit_post )
1376                                 $actions = '<a href="' . wp_nonce_url( add_query_arg( array( 'revision' => $revision->ID, 'action' => 'restore' ) ), "restore-post_$post->ID|$revision->ID" ) . '">' . __( 'Restore' ) . '</a>';
1377                         else
1378                                 $actions = '';
1379
1380                         $rows .= "<tr$class>\n";
1381                         $rows .= "\t<th style='white-space: nowrap' scope='row'><input type='radio' name='left' value='$revision->ID'$left_checked /></th>\n";
1382                         $rows .= "\t<th style='white-space: nowrap' scope='row'><input type='radio' name='right' value='$revision->ID'$right_checked /></th>\n";
1383                         $rows .= "\t<td>$date</td>\n";
1384                         $rows .= "\t<td>$name</td>\n";
1385                         $rows .= "\t<td class='action-links'>$actions</td>\n";
1386                         $rows .= "</tr>\n";
1387                 } else {
1388                         $title = sprintf( $titlef, $date, $name );
1389                         $rows .= "\t<li>$title</li>\n";
1390                 }
1391         }
1392
1393         if ( 'form-table' == $format ) : ?>
1394
1395 <form action="revision.php" method="get">
1396
1397 <div class="tablenav">
1398         <div class="alignleft">
1399                 <input type="submit" class="button-secondary" value="<?php esc_attr_e( 'Compare Revisions' ); ?>" />
1400                 <input type="hidden" name="action" value="diff" />
1401                 <input type="hidden" name="post_type" value="<?php echo esc_attr($post->post_type); ?>" />
1402         </div>
1403 </div>
1404
1405 <br class="clear" />
1406
1407 <table class="widefat post-revisions" cellspacing="0" id="post-revisions">
1408         <col />
1409         <col />
1410         <col style="width: 33%" />
1411         <col style="width: 33%" />
1412         <col style="width: 33%" />
1413 <thead>
1414 <tr>
1415         <th scope="col"><?php /* translators: column name in revisons */ _ex( 'Old', 'revisions column name' ); ?></th>
1416         <th scope="col"><?php /* translators: column name in revisons */ _ex( 'New', 'revisions column name' ); ?></th>
1417         <th scope="col"><?php /* translators: column name in revisons */ _ex( 'Date Created', 'revisions column name' ); ?></th>
1418         <th scope="col"><?php _e( 'Author' ); ?></th>
1419         <th scope="col" class="action-links"><?php _e( 'Actions' ); ?></th>
1420 </tr>
1421 </thead>
1422 <tbody>
1423
1424 <?php echo $rows; ?>
1425
1426 </tbody>
1427 </table>
1428
1429 </form>
1430
1431 <?php
1432         else :
1433                 echo "<ul class='post-revisions'>\n";
1434                 echo $rows;
1435                 echo "</ul>";
1436         endif;
1437
1438 }