3 * WordPress Post Template Functions.
5 * Gets content for the current post in the loop.
12 * Display the ID of the current item in the WordPress Loop.
21 * Retrieve the ID of the current item in the WordPress Loop.
25 * @return int|false The ID of the current item in the WordPress Loop. False if $post is not set.
27 function get_the_ID() {
29 return ! empty( $post ) ? $post->ID : false;
33 * Display or retrieve the current post title with optional content.
37 * @param string $before Optional. Content to prepend to the title.
38 * @param string $after Optional. Content to append to the title.
39 * @param bool $echo Optional, default to true.Whether to display or return.
40 * @return string|void String if $echo parameter is false.
42 function the_title( $before = '', $after = '', $echo = true ) {
43 $title = get_the_title();
45 if ( strlen($title) == 0 )
48 $title = $before . $title . $after;
57 * Sanitize the current title when retrieving or displaying.
59 * Works like {@link the_title()}, except the parameters can be in a string or
60 * an array. See the function for what can be override in the $args parameter.
62 * The title before it is displayed will have the tags stripped and {@link
63 * esc_attr()} before it is passed to the user or displayed. The default
64 * as with {@link the_title()}, is to display the title.
68 * @param string|array $args {
69 * Title attribute arguments. Optional.
71 * @type string $before Markup to prepend to the title. Default empty.
72 * @type string $after Markup to append to the title. Default empty.
73 * @type bool $echo Whether to echo or return the title. Default true for echo.
74 * @type WP_Post $post Current post object to retrieve the title for.
76 * @return string|void String when echo is false.
78 function the_title_attribute( $args = '' ) {
79 $defaults = array( 'before' => '', 'after' => '', 'echo' => true, 'post' => get_post() );
80 $r = wp_parse_args( $args, $defaults );
82 $title = get_the_title( $r['post'] );
84 if ( strlen( $title ) == 0 ) {
88 $title = $r['before'] . $title . $r['after'];
89 $title = esc_attr( strip_tags( $title ) );
99 * Retrieve post title.
101 * If the post is protected and the visitor is not an admin, then "Protected"
102 * will be displayed before the post title. If the post is private, then
103 * "Private" will be located before the post title.
107 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
110 function get_the_title( $post = 0 ) {
111 $post = get_post( $post );
113 $title = isset( $post->post_title ) ? $post->post_title : '';
114 $id = isset( $post->ID ) ? $post->ID : 0;
116 if ( ! is_admin() ) {
117 if ( ! empty( $post->post_password ) ) {
120 * Filter the text prepended to the post title for protected posts.
122 * The filter is only applied on the front end.
126 * @param string $prepend Text displayed before the post title.
127 * Default 'Protected: %s'.
128 * @param WP_Post $post Current post object.
130 $protected_title_format = apply_filters( 'protected_title_format', __( 'Protected: %s' ), $post );
131 $title = sprintf( $protected_title_format, $title );
132 } elseif ( isset( $post->post_status ) && 'private' == $post->post_status ) {
135 * Filter the text prepended to the post title of private posts.
137 * The filter is only applied on the front end.
141 * @param string $prepend Text displayed before the post title.
142 * Default 'Private: %s'.
143 * @param WP_Post $post Current post object.
145 $private_title_format = apply_filters( 'private_title_format', __( 'Private: %s' ), $post );
146 $title = sprintf( $private_title_format, $title );
151 * Filter the post title.
155 * @param string $title The post title.
156 * @param int $id The post ID.
158 return apply_filters( 'the_title', $title, $id );
162 * Display the Post Global Unique Identifier (guid).
164 * The guid will appear to be a link, but should not be used as a link to the
165 * post. The reason you should not use it as a link, is because of moving the
166 * blog across domains.
168 * URL is escaped to make it XML-safe.
172 * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
174 function the_guid( $post = 0 ) {
175 $post = get_post( $post );
177 $guid = isset( $post->guid ) ? get_the_guid( $post ) : '';
178 $id = isset( $post->ID ) ? $post->ID : 0;
181 * Filter the escaped Global Unique Identifier (guid) of the post.
185 * @see get_the_guid()
187 * @param string $guid Escaped Global Unique Identifier (guid) of the post.
188 * @param int $id The post ID.
190 echo apply_filters( 'the_guid', $guid, $id );
194 * Retrieve the Post Global Unique Identifier (guid).
196 * The guid will appear to be a link, but should not be used as an link to the
197 * post. The reason you should not use it as a link, is because of moving the
198 * blog across domains.
202 * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
205 function get_the_guid( $post = 0 ) {
206 $post = get_post( $post );
208 $guid = isset( $post->guid ) ? $post->guid : '';
209 $id = isset( $post->ID ) ? $post->ID : 0;
212 * Filter the Global Unique Identifier (guid) of the post.
216 * @param string $guid Global Unique Identifier (guid) of the post.
217 * @param int $id The post ID.
219 return apply_filters( 'get_the_guid', $guid, $id );
223 * Display the post content.
227 * @param string $more_link_text Optional. Content for when there is more text.
228 * @param bool $strip_teaser Optional. Strip teaser content before the more text. Default is false.
230 function the_content( $more_link_text = null, $strip_teaser = false) {
231 $content = get_the_content( $more_link_text, $strip_teaser );
234 * Filter the post content.
238 * @param string $content Content of the current post.
240 $content = apply_filters( 'the_content', $content );
241 $content = str_replace( ']]>', ']]>', $content );
246 * Retrieve the post content.
252 * @global bool $preview
253 * @global array $pages
254 * @global int $multipage
256 * @param string $more_link_text Optional. Content for when there is more text.
257 * @param bool $strip_teaser Optional. Strip teaser content before the more text. Default is false.
260 function get_the_content( $more_link_text = null, $strip_teaser = false ) {
261 global $page, $more, $preview, $pages, $multipage;
265 if ( null === $more_link_text )
266 $more_link_text = __( '(more…)' );
271 // If post password required and it doesn't match the cookie.
272 if ( post_password_required( $post ) )
273 return get_the_password_form( $post );
275 if ( $page > count( $pages ) ) // if the requested page doesn't exist
276 $page = count( $pages ); // give them the highest numbered page that DOES exist
278 $content = $pages[$page - 1];
279 if ( preg_match( '/<!--more(.*?)?-->/', $content, $matches ) ) {
280 $content = explode( $matches[0], $content, 2 );
281 if ( ! empty( $matches[1] ) && ! empty( $more_link_text ) )
282 $more_link_text = strip_tags( wp_kses_no_null( trim( $matches[1] ) ) );
286 $content = array( $content );
289 if ( false !== strpos( $post->post_content, '<!--noteaser-->' ) && ( ! $multipage || $page == 1 ) )
290 $strip_teaser = true;
292 $teaser = $content[0];
294 if ( $more && $strip_teaser && $has_teaser )
299 if ( count( $content ) > 1 ) {
301 $output .= '<span id="more-' . $post->ID . '"></span>' . $content[1];
303 if ( ! empty( $more_link_text ) )
306 * Filter the Read More link text.
310 * @param string $more_link_element Read More link element.
311 * @param string $more_link_text Read More text.
313 $output .= apply_filters( 'the_content_more_link', ' <a href="' . get_permalink() . "#more-{$post->ID}\" class=\"more-link\">$more_link_text</a>", $more_link_text );
314 $output = force_balance_tags( $output );
318 if ( $preview ) // Preview fix for JavaScript bug with foreign languages.
319 $output = preg_replace_callback( '/\%u([0-9A-F]{4})/', '_convert_urlencoded_to_entities', $output );
325 * Preview fix for JavaScript bug with foreign languages.
330 * @param array $match Match array from preg_replace_callback.
333 function _convert_urlencoded_to_entities( $match ) {
334 return '&#' . base_convert( $match[1], 16, 10 ) . ';';
338 * Display the post excerpt.
342 function the_excerpt() {
345 * Filter the displayed post excerpt.
349 * @see get_the_excerpt()
351 * @param string $post_excerpt The post excerpt.
353 echo apply_filters( 'the_excerpt', get_the_excerpt() );
357 * Retrieves the post excerpt.
360 * @since 4.5.0 Introduced the `$post` parameter.
362 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
363 * @return string Post excerpt.
365 function get_the_excerpt( $post = null ) {
366 if ( is_bool( $post ) ) {
367 _deprecated_argument( __FUNCTION__, '2.3' );
370 $post = get_post( $post );
371 if ( empty( $post ) ) {
375 if ( post_password_required( $post ) ) {
376 return __( 'There is no excerpt because this is a protected post.' );
380 * Filter the retrieved post excerpt.
383 * @since 4.5.0 Introduced the `$post` parameter.
385 * @param string $post_excerpt The post excerpt.
386 * @param WP_Post $post Post object.
388 return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
392 * Whether post has excerpt.
396 * @param int|WP_Post $id Optional. Post ID or post object.
399 function has_excerpt( $id = 0 ) {
400 $post = get_post( $id );
401 return ( !empty( $post->post_excerpt ) );
405 * Display the classes for the post div.
409 * @param string|array $class One or more classes to add to the class list.
410 * @param int|WP_Post $post_id Optional. Post ID or post object. Defaults to the global `$post`.
412 function post_class( $class = '', $post_id = null ) {
413 // Separates classes with a single space, collates classes for post DIV
414 echo 'class="' . join( ' ', get_post_class( $class, $post_id ) ) . '"';
418 * Retrieve the classes for the post div as an array.
420 * The class names are many. If the post is a sticky, then the 'sticky'
421 * class name. The class 'hentry' is always added to each post. If the post has a
422 * post thumbnail, 'has-post-thumbnail' is added as a class. For each taxonomy that
423 * the post belongs to, a class will be added of the format '{$taxonomy}-{$slug}' -
424 * eg 'category-foo' or 'my_custom_taxonomy-bar'. The 'post_tag' taxonomy is a special
425 * case; the class has the 'tag-' prefix instead of 'post_tag-'. All classes are
426 * passed through the filter, 'post_class' with the list of classes, followed by
427 * $class parameter value, with the post ID as the last parameter.
430 * @since 4.2.0 Custom taxonomy classes were added.
432 * @param string|array $class One or more classes to add to the class list.
433 * @param int|WP_Post $post_id Optional. Post ID or post object.
434 * @return array Array of classes.
436 function get_post_class( $class = '', $post_id = null ) {
437 $post = get_post( $post_id );
442 if ( ! is_array( $class ) ) {
443 $class = preg_split( '#\s+#', $class );
445 $classes = array_map( 'esc_attr', $class );
447 // Ensure that we always coerce class to being an array.
455 $classes[] = 'post-' . $post->ID;
457 $classes[] = $post->post_type;
458 $classes[] = 'type-' . $post->post_type;
459 $classes[] = 'status-' . $post->post_status;
462 if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
463 $post_format = get_post_format( $post->ID );
465 if ( $post_format && !is_wp_error($post_format) )
466 $classes[] = 'format-' . sanitize_html_class( $post_format );
468 $classes[] = 'format-standard';
471 $post_password_required = post_password_required( $post->ID );
473 // Post requires password.
474 if ( $post_password_required ) {
475 $classes[] = 'post-password-required';
476 } elseif ( ! empty( $post->post_password ) ) {
477 $classes[] = 'post-password-protected';
481 if ( current_theme_supports( 'post-thumbnails' ) && has_post_thumbnail( $post->ID ) && ! is_attachment( $post ) && ! $post_password_required ) {
482 $classes[] = 'has-post-thumbnail';
485 // sticky for Sticky Posts
486 if ( is_sticky( $post->ID ) ) {
487 if ( is_home() && ! is_paged() ) {
488 $classes[] = 'sticky';
489 } elseif ( is_admin() ) {
490 $classes[] = 'status-sticky';
494 // hentry for hAtom compliance
495 $classes[] = 'hentry';
497 // All public taxonomies
498 $taxonomies = get_taxonomies( array( 'public' => true ) );
499 foreach ( (array) $taxonomies as $taxonomy ) {
500 if ( is_object_in_taxonomy( $post->post_type, $taxonomy ) ) {
501 foreach ( (array) get_the_terms( $post->ID, $taxonomy ) as $term ) {
502 if ( empty( $term->slug ) ) {
506 $term_class = sanitize_html_class( $term->slug, $term->term_id );
507 if ( is_numeric( $term_class ) || ! trim( $term_class, '-' ) ) {
508 $term_class = $term->term_id;
511 // 'post_tag' uses the 'tag' prefix for backward compatibility.
512 if ( 'post_tag' == $taxonomy ) {
513 $classes[] = 'tag-' . $term_class;
515 $classes[] = sanitize_html_class( $taxonomy . '-' . $term_class, $taxonomy . '-' . $term->term_id );
521 $classes = array_map( 'esc_attr', $classes );
524 * Filter the list of CSS classes for the current post.
528 * @param array $classes An array of post classes.
529 * @param array $class An array of additional classes added to the post.
530 * @param int $post_id The post ID.
532 $classes = apply_filters( 'post_class', $classes, $class, $post->ID );
534 return array_unique( $classes );
538 * Display the classes for the body element.
542 * @param string|array $class One or more classes to add to the class list.
544 function body_class( $class = '' ) {
545 // Separates classes with a single space, collates classes for body element
546 echo 'class="' . join( ' ', get_body_class( $class ) ) . '"';
550 * Retrieve the classes for the body element as an array.
554 * @global WP_Query $wp_query
556 * @param string|array $class One or more classes to add to the class list.
557 * @return array Array of classes.
559 function get_body_class( $class = '' ) {
567 if ( is_front_page() )
572 $classes[] = 'archive';
576 $classes[] = 'search';
577 $classes[] = $wp_query->posts ? 'search-results' : 'search-no-results';
580 $classes[] = 'paged';
581 if ( is_attachment() )
582 $classes[] = 'attachment';
584 $classes[] = 'error404';
585 if ( is_singular() ) {
586 $classes[] = 'singular';
590 $post_id = $wp_query->get_queried_object_id();
591 $post = $wp_query->get_queried_object();
593 $classes[] = 'single';
594 if ( isset( $post->post_type ) ) {
595 $classes[] = 'single-' . sanitize_html_class($post->post_type, $post_id);
596 $classes[] = 'postid-' . $post_id;
599 if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
600 $post_format = get_post_format( $post->ID );
602 if ( $post_format && !is_wp_error($post_format) )
603 $classes[] = 'single-format-' . sanitize_html_class( $post_format );
605 $classes[] = 'single-format-standard';
609 if ( is_attachment() ) {
610 $mime_type = get_post_mime_type($post_id);
611 $mime_prefix = array( 'application/', 'image/', 'text/', 'audio/', 'video/', 'music/' );
612 $classes[] = 'attachmentid-' . $post_id;
613 $classes[] = 'attachment-' . str_replace( $mime_prefix, '', $mime_type );
615 } elseif ( is_archive() ) {
616 if ( is_post_type_archive() ) {
617 $classes[] = 'post-type-archive';
618 $post_type = get_query_var( 'post_type' );
619 if ( is_array( $post_type ) )
620 $post_type = reset( $post_type );
621 $classes[] = 'post-type-archive-' . sanitize_html_class( $post_type );
622 } elseif ( is_author() ) {
623 $author = $wp_query->get_queried_object();
624 $classes[] = 'author';
625 if ( isset( $author->user_nicename ) ) {
626 $classes[] = 'author-' . sanitize_html_class( $author->user_nicename, $author->ID );
627 $classes[] = 'author-' . $author->ID;
629 } elseif ( is_category() ) {
630 $cat = $wp_query->get_queried_object();
631 $classes[] = 'category';
632 if ( isset( $cat->term_id ) ) {
633 $cat_class = sanitize_html_class( $cat->slug, $cat->term_id );
634 if ( is_numeric( $cat_class ) || ! trim( $cat_class, '-' ) ) {
635 $cat_class = $cat->term_id;
638 $classes[] = 'category-' . $cat_class;
639 $classes[] = 'category-' . $cat->term_id;
641 } elseif ( is_tag() ) {
642 $tag = $wp_query->get_queried_object();
644 if ( isset( $tag->term_id ) ) {
645 $tag_class = sanitize_html_class( $tag->slug, $tag->term_id );
646 if ( is_numeric( $tag_class ) || ! trim( $tag_class, '-' ) ) {
647 $tag_class = $tag->term_id;
650 $classes[] = 'tag-' . $tag_class;
651 $classes[] = 'tag-' . $tag->term_id;
653 } elseif ( is_tax() ) {
654 $term = $wp_query->get_queried_object();
655 if ( isset( $term->term_id ) ) {
656 $term_class = sanitize_html_class( $term->slug, $term->term_id );
657 if ( is_numeric( $term_class ) || ! trim( $term_class, '-' ) ) {
658 $term_class = $term->term_id;
661 $classes[] = 'tax-' . sanitize_html_class( $term->taxonomy );
662 $classes[] = 'term-' . $term_class;
663 $classes[] = 'term-' . $term->term_id;
666 } elseif ( is_page() ) {
669 $page_id = $wp_query->get_queried_object_id();
671 $post = get_post($page_id);
673 $classes[] = 'page-id-' . $page_id;
675 if ( get_pages( array( 'parent' => $page_id, 'number' => 1 ) ) ) {
676 $classes[] = 'page-parent';
679 if ( $post->post_parent ) {
680 $classes[] = 'page-child';
681 $classes[] = 'parent-pageid-' . $post->post_parent;
683 if ( is_page_template() ) {
684 $classes[] = 'page-template';
686 $template_slug = get_page_template_slug( $page_id );
687 $template_parts = explode( '/', $template_slug );
689 foreach ( $template_parts as $part ) {
690 $classes[] = 'page-template-' . sanitize_html_class( str_replace( array( '.', '/' ), '-', basename( $part, '.php' ) ) );
692 $classes[] = 'page-template-' . sanitize_html_class( str_replace( '.', '-', $template_slug ) );
694 $classes[] = 'page-template-default';
698 if ( is_user_logged_in() )
699 $classes[] = 'logged-in';
701 if ( is_admin_bar_showing() ) {
702 $classes[] = 'admin-bar';
703 $classes[] = 'no-customize-support';
706 if ( get_background_color() !== get_theme_support( 'custom-background', 'default-color' ) || get_background_image() )
707 $classes[] = 'custom-background';
709 if ( has_custom_logo() ) {
710 $classes[] = 'wp-custom-logo';
713 $page = $wp_query->get( 'page' );
715 if ( ! $page || $page < 2 )
716 $page = $wp_query->get( 'paged' );
718 if ( $page && $page > 1 && ! is_404() ) {
719 $classes[] = 'paged-' . $page;
722 $classes[] = 'single-paged-' . $page;
724 $classes[] = 'page-paged-' . $page;
725 elseif ( is_category() )
726 $classes[] = 'category-paged-' . $page;
728 $classes[] = 'tag-paged-' . $page;
730 $classes[] = 'date-paged-' . $page;
731 elseif ( is_author() )
732 $classes[] = 'author-paged-' . $page;
733 elseif ( is_search() )
734 $classes[] = 'search-paged-' . $page;
735 elseif ( is_post_type_archive() )
736 $classes[] = 'post-type-paged-' . $page;
739 if ( ! empty( $class ) ) {
740 if ( !is_array( $class ) )
741 $class = preg_split( '#\s+#', $class );
742 $classes = array_merge( $classes, $class );
744 // Ensure that we always coerce class to being an array.
748 $classes = array_map( 'esc_attr', $classes );
751 * Filter the list of CSS body classes for the current post or page.
755 * @param array $classes An array of body classes.
756 * @param array $class An array of additional classes added to the body.
758 $classes = apply_filters( 'body_class', $classes, $class );
760 return array_unique( $classes );
764 * Whether post requires password and correct password has been provided.
768 * @param int|WP_Post|null $post An optional post. Global $post used if not provided.
769 * @return bool false if a password is not required or the correct password cookie is present, true otherwise.
771 function post_password_required( $post = null ) {
772 $post = get_post($post);
774 if ( empty( $post->post_password ) )
777 if ( ! isset( $_COOKIE['wp-postpass_' . COOKIEHASH] ) )
780 require_once ABSPATH . WPINC . '/class-phpass.php';
781 $hasher = new PasswordHash( 8, true );
783 $hash = wp_unslash( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] );
784 if ( 0 !== strpos( $hash, '$P$B' ) )
787 return ! $hasher->CheckPassword( $post->post_password, $hash );
791 // Page Template Functions for usage in Themes
795 * The formatted output of a list of pages.
797 * Displays page links for paginated posts (i.e. includes the <!--nextpage-->.
798 * Quicktag one or more times). This tag must be within The Loop.
803 * @global int $numpages
804 * @global int $multipage
807 * @param string|array $args {
808 * Optional. Array or string of default arguments.
810 * @type string $before HTML or text to prepend to each link. Default is `<p> Pages:`.
811 * @type string $after HTML or text to append to each link. Default is `</p>`.
812 * @type string $link_before HTML or text to prepend to each link, inside the `<a>` tag.
813 * Also prepended to the current item, which is not linked. Default empty.
814 * @type string $link_after HTML or text to append to each Pages link inside the `<a>` tag.
815 * Also appended to the current item, which is not linked. Default empty.
816 * @type string $next_or_number Indicates whether page numbers should be used. Valid values are number
817 * and next. Default is 'number'.
818 * @type string $separator Text between pagination links. Default is ' '.
819 * @type string $nextpagelink Link text for the next page link, if available. Default is 'Next Page'.
820 * @type string $previouspagelink Link text for the previous page link, if available. Default is 'Previous Page'.
821 * @type string $pagelink Format string for page numbers. The % in the parameter string will be
822 * replaced with the page number, so 'Page %' generates "Page 1", "Page 2", etc.
823 * Defaults to '%', just the page number.
824 * @type int|bool $echo Whether to echo or not. Accepts 1|true or 0|false. Default 1|true.
826 * @return string Formatted output in HTML.
828 function wp_link_pages( $args = '' ) {
829 global $page, $numpages, $multipage, $more;
832 'before' => '<p>' . __( 'Pages:' ),
836 'next_or_number' => 'number',
838 'nextpagelink' => __( 'Next page' ),
839 'previouspagelink' => __( 'Previous page' ),
844 $params = wp_parse_args( $args, $defaults );
847 * Filter the arguments used in retrieving page links for paginated posts.
851 * @param array $params An array of arguments for page links for paginated posts.
853 $r = apply_filters( 'wp_link_pages_args', $params );
857 if ( 'number' == $r['next_or_number'] ) {
858 $output .= $r['before'];
859 for ( $i = 1; $i <= $numpages; $i++ ) {
860 $link = $r['link_before'] . str_replace( '%', $i, $r['pagelink'] ) . $r['link_after'];
861 if ( $i != $page || ! $more && 1 == $page ) {
862 $link = _wp_link_page( $i ) . $link . '</a>';
865 * Filter the HTML output of individual page number links.
869 * @param string $link The page number HTML output.
870 * @param int $i Page number for paginated posts' page links.
872 $link = apply_filters( 'wp_link_pages_link', $link, $i );
874 // Use the custom links separator beginning with the second link.
875 $output .= ( 1 === $i ) ? ' ' : $r['separator'];
878 $output .= $r['after'];
880 $output .= $r['before'];
883 $link = _wp_link_page( $prev ) . $r['link_before'] . $r['previouspagelink'] . $r['link_after'] . '</a>';
885 /** This filter is documented in wp-includes/post-template.php */
886 $output .= apply_filters( 'wp_link_pages_link', $link, $prev );
889 if ( $next <= $numpages ) {
891 $output .= $r['separator'];
893 $link = _wp_link_page( $next ) . $r['link_before'] . $r['nextpagelink'] . $r['link_after'] . '</a>';
895 /** This filter is documented in wp-includes/post-template.php */
896 $output .= apply_filters( 'wp_link_pages_link', $link, $next );
898 $output .= $r['after'];
903 * Filter the HTML output of page links for paginated posts.
907 * @param string $output HTML output of paginated posts' page links.
908 * @param array $args An array of arguments.
910 $html = apply_filters( 'wp_link_pages', $output, $args );
919 * Helper function for wp_link_pages().
924 * @global WP_Rewrite $wp_rewrite
926 * @param int $i Page number.
927 * @return string Link.
929 function _wp_link_page( $i ) {
932 $query_args = array();
935 $url = get_permalink();
937 if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) )
938 $url = add_query_arg( 'page', $i, get_permalink() );
939 elseif ( 'page' == get_option('show_on_front') && get_option('page_on_front') == $post->ID )
940 $url = trailingslashit(get_permalink()) . user_trailingslashit("$wp_rewrite->pagination_base/" . $i, 'single_paged');
942 $url = trailingslashit(get_permalink()) . user_trailingslashit($i, 'single_paged');
945 if ( is_preview() ) {
947 if ( ( 'draft' !== $post->post_status ) && isset( $_GET['preview_id'], $_GET['preview_nonce'] ) ) {
948 $query_args['preview_id'] = wp_unslash( $_GET['preview_id'] );
949 $query_args['preview_nonce'] = wp_unslash( $_GET['preview_nonce'] );
952 $url = get_preview_post_link( $post, $query_args, $url );
955 return '<a href="' . esc_url( $url ) . '">';
959 // Post-meta: Custom per-post fields.
963 * Retrieve post custom meta data field.
967 * @param string $key Meta data key name.
968 * @return false|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist.
970 function post_custom( $key = '' ) {
971 $custom = get_post_custom();
973 if ( !isset( $custom[$key] ) )
975 elseif ( 1 == count($custom[$key]) )
976 return $custom[$key][0];
978 return $custom[$key];
982 * Display list of post custom fields.
986 * @internal This will probably change at some point...
989 function the_meta() {
990 if ( $keys = get_post_custom_keys() ) {
991 echo "<ul class='post-meta'>\n";
992 foreach ( (array) $keys as $key ) {
994 if ( is_protected_meta( $keyt, 'post' ) )
996 $values = array_map('trim', get_post_custom_values($key));
997 $value = implode($values,', ');
1000 * Filter the HTML output of the li element in the post custom fields list.
1004 * @param string $html The HTML output for the li element.
1005 * @param string $key Meta key.
1006 * @param string $value Meta value.
1008 echo apply_filters( 'the_meta_key', "<li><span class='post-meta-key'>$key:</span> $value</li>\n", $key, $value );
1019 * Retrieve or display list of pages as a dropdown (select list).
1022 * @since 4.2.0 The `$value_field` argument was added.
1023 * @since 4.3.0 The `$class` argument was added.
1025 * @param array|string $args {
1026 * Optional. Array or string of arguments to generate a pages drop-down element.
1028 * @type int $depth Maximum depth. Default 0.
1029 * @type int $child_of Page ID to retrieve child pages of. Default 0.
1030 * @type int|string $selected Value of the option that should be selected. Default 0.
1031 * @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1,
1032 * or their bool equivalents. Default 1.
1033 * @type string $name Value for the 'name' attribute of the select element.
1034 * Default 'page_id'.
1035 * @type string $id Value for the 'id' attribute of the select element.
1036 * @type string $class Value for the 'class' attribute of the select element. Default: none.
1037 * Defaults to the value of `$name`.
1038 * @type string $show_option_none Text to display for showing no pages. Default empty (does not display).
1039 * @type string $show_option_no_change Text to display for "no change" option. Default empty (does not display).
1040 * @type string $option_none_value Value to use when no page is selected. Default empty.
1041 * @type string $value_field Post field used to populate the 'value' attribute of the option
1042 * elements. Accepts any valid post field. Default 'ID'.
1044 * @return string HTML content, if not displaying.
1046 function wp_dropdown_pages( $args = '' ) {
1048 'depth' => 0, 'child_of' => 0,
1049 'selected' => 0, 'echo' => 1,
1050 'name' => 'page_id', 'id' => '',
1052 'show_option_none' => '', 'show_option_no_change' => '',
1053 'option_none_value' => '',
1054 'value_field' => 'ID',
1057 $r = wp_parse_args( $args, $defaults );
1059 $pages = get_pages( $r );
1061 // Back-compat with old system where both id and name were based on $name argument
1062 if ( empty( $r['id'] ) ) {
1063 $r['id'] = $r['name'];
1066 if ( ! empty( $pages ) ) {
1068 if ( ! empty( $r['class'] ) ) {
1069 $class = " class='" . esc_attr( $r['class'] ) . "'";
1072 $output = "<select name='" . esc_attr( $r['name'] ) . "'" . $class . " id='" . esc_attr( $r['id'] ) . "'>\n";
1073 if ( $r['show_option_no_change'] ) {
1074 $output .= "\t<option value=\"-1\">" . $r['show_option_no_change'] . "</option>\n";
1076 if ( $r['show_option_none'] ) {
1077 $output .= "\t<option value=\"" . esc_attr( $r['option_none_value'] ) . '">' . $r['show_option_none'] . "</option>\n";
1079 $output .= walk_page_dropdown_tree( $pages, $r['depth'], $r );
1080 $output .= "</select>\n";
1084 * Filter the HTML output of a list of pages as a drop down.
1087 * @since 4.4.0 `$r` and `$pages` added as arguments.
1089 * @param string $output HTML output for drop down list of pages.
1090 * @param array $r The parsed arguments array.
1091 * @param array $pages List of WP_Post objects returned by `get_pages()`
1093 $html = apply_filters( 'wp_dropdown_pages', $output, $r, $pages );
1102 * Retrieve or display list of pages in list (li) format.
1108 * @global WP_Query $wp_query
1110 * @param array|string $args {
1111 * Array or string of arguments. Optional.
1113 * @type int $child_of Display only the sub-pages of a single page by ID. Default 0 (all pages).
1114 * @type string $authors Comma-separated list of author IDs. Default empty (all authors).
1115 * @type string $date_format PHP date format to use for the listed pages. Relies on the 'show_date' parameter.
1116 * Default is the value of 'date_format' option.
1117 * @type int $depth Number of levels in the hierarchy of pages to include in the generated list.
1118 * Accepts -1 (any depth), 0 (all pages), 1 (top-level pages only), and n (pages to
1119 * the given n depth). Default 0.
1120 * @type bool $echo Whether or not to echo the list of pages. Default true.
1121 * @type string $exclude Comma-separated list of page IDs to exclude. Default empty.
1122 * @type array $include Comma-separated list of page IDs to include. Default empty.
1123 * @type string $link_after Text or HTML to follow the page link label. Default null.
1124 * @type string $link_before Text or HTML to precede the page link label. Default null.
1125 * @type string $post_type Post type to query for. Default 'page'.
1126 * @type string $post_status Comma-separated list of post statuses to include. Default 'publish'.
1127 * @type string $show_date Whether to display the page publish or modified date for each page. Accepts
1128 * 'modified' or any other value. An empty value hides the date. Default empty.
1129 * @type string $sort_column Comma-separated list of column names to sort the pages by. Accepts 'post_author',
1130 * 'post_date', 'post_title', 'post_name', 'post_modified', 'post_modified_gmt',
1131 * 'menu_order', 'post_parent', 'ID', 'rand', or 'comment_count'. Default 'post_title'.
1132 * @type string $title_li List heading. Passing a null or empty value will result in no heading, and the list
1133 * will not be wrapped with unordered list `<ul>` tags. Default 'Pages'.
1134 * @type Walker $walker Walker instance to use for listing pages. Default empty (Walker_Page).
1136 * @return string|void HTML list of pages.
1138 function wp_list_pages( $args = '' ) {
1140 'depth' => 0, 'show_date' => '',
1141 'date_format' => get_option( 'date_format' ),
1142 'child_of' => 0, 'exclude' => '',
1143 'title_li' => __( 'Pages' ), 'echo' => 1,
1144 'authors' => '', 'sort_column' => 'menu_order, post_title',
1145 'link_before' => '', 'link_after' => '', 'walker' => '',
1148 $r = wp_parse_args( $args, $defaults );
1153 // sanitize, mostly to keep spaces out
1154 $r['exclude'] = preg_replace( '/[^0-9,]/', '', $r['exclude'] );
1156 // Allow plugins to filter an array of excluded pages (but don't put a nullstring into the array)
1157 $exclude_array = ( $r['exclude'] ) ? explode( ',', $r['exclude'] ) : array();
1160 * Filter the array of pages to exclude from the pages list.
1164 * @param array $exclude_array An array of page IDs to exclude.
1166 $r['exclude'] = implode( ',', apply_filters( 'wp_list_pages_excludes', $exclude_array ) );
1169 $r['hierarchical'] = 0;
1170 $pages = get_pages( $r );
1172 if ( ! empty( $pages ) ) {
1173 if ( $r['title_li'] ) {
1174 $output .= '<li class="pagenav">' . $r['title_li'] . '<ul>';
1177 if ( is_page() || is_attachment() || $wp_query->is_posts_page ) {
1178 $current_page = get_queried_object_id();
1179 } elseif ( is_singular() ) {
1180 $queried_object = get_queried_object();
1181 if ( is_post_type_hierarchical( $queried_object->post_type ) ) {
1182 $current_page = $queried_object->ID;
1186 $output .= walk_page_tree( $pages, $r['depth'], $current_page, $r );
1188 if ( $r['title_li'] ) {
1189 $output .= '</ul></li>';
1194 * Filter the HTML output of the pages to list.
1197 * @since 4.4.0 `$pages` added as arguments.
1199 * @see wp_list_pages()
1201 * @param string $output HTML output of the pages list.
1202 * @param array $r An array of page-listing arguments.
1203 * @param array $pages List of WP_Post objects returned by `get_pages()`
1205 $html = apply_filters( 'wp_list_pages', $output, $r, $pages );
1215 * Display or retrieve list of pages with optional home link.
1217 * The arguments are listed below and part of the arguments are for {@link
1218 * wp_list_pages()} function. Check that function for more info on those
1222 * @since 4.4.0 Added `menu_id`, `container`, `before`, `after`, and `walker` arguments.
1224 * @param array|string $args {
1225 * Optional. Arguments to generate a page menu. See wp_list_pages() for additional arguments.
1227 * @type string $sort_column How to short the list of pages. Accepts post column names.
1228 * Default 'menu_order, post_title'.
1229 * @type string $menu_id ID for the div containing the page list. Default is empty string.
1230 * @type string $menu_class Class to use for the element containing the page list. Default 'menu'.
1231 * @type string $container Element to use for the element containing the page list. Default 'div'.
1232 * @type bool $echo Whether to echo the list or return it. Accepts true (echo) or false (return).
1234 * @type int|bool|string $show_home Whether to display the link to the home page. Can just enter the text
1235 * you'd like shown for the home link. 1|true defaults to 'Home'.
1236 * @type string $link_before The HTML or text to prepend to $show_home text. Default empty.
1237 * @type string $link_after The HTML or text to append to $show_home text. Default empty.
1238 * @type string $before The HTML or text to prepend to the menu. Default is '<ul>'.
1239 * @type string $after The HTML or text to append to the menu. Default is '</ul>'.
1240 * @type Walker $walker Walker instance to use for listing pages. Default empty (Walker_Page).
1242 * @return string|void HTML menu
1244 function wp_page_menu( $args = array() ) {
1246 'sort_column' => 'menu_order, post_title',
1248 'menu_class' => 'menu',
1249 'container' => 'div',
1251 'link_before' => '',
1257 $args = wp_parse_args( $args, $defaults );
1260 * Filter the arguments used to generate a page-based menu.
1264 * @see wp_page_menu()
1266 * @param array $args An array of page menu arguments.
1268 $args = apply_filters( 'wp_page_menu_args', $args );
1274 // Show Home in the menu
1275 if ( ! empty($args['show_home']) ) {
1276 if ( true === $args['show_home'] || '1' === $args['show_home'] || 1 === $args['show_home'] )
1279 $text = $args['show_home'];
1281 if ( is_front_page() && !is_paged() )
1282 $class = 'class="current_page_item"';
1283 $menu .= '<li ' . $class . '><a href="' . home_url( '/' ) . '">' . $args['link_before'] . $text . $args['link_after'] . '</a></li>';
1284 // If the front page is a page, add it to the exclude list
1285 if (get_option('show_on_front') == 'page') {
1286 if ( !empty( $list_args['exclude'] ) ) {
1287 $list_args['exclude'] .= ',';
1289 $list_args['exclude'] = '';
1291 $list_args['exclude'] .= get_option('page_on_front');
1295 $list_args['echo'] = false;
1296 $list_args['title_li'] = '';
1297 $menu .= str_replace( array( "\r", "\n", "\t" ), '', wp_list_pages($list_args) );
1299 $container = sanitize_text_field( $args['container'] );
1301 // Fallback in case `wp_nav_menu()` was called without a container.
1302 if ( empty( $container ) ) {
1308 // wp_nav_menu doesn't set before and after
1309 if ( isset( $args['fallback_cb'] ) &&
1310 'wp_page_menu' === $args['fallback_cb'] &&
1311 'ul' !== $container ) {
1312 $args['before'] = '<ul>';
1313 $args['after'] = '</ul>';
1316 $menu = $args['before'] . $menu . $args['after'];
1320 if ( ! empty( $args['menu_id'] ) ) {
1321 $attrs .= ' id="' . esc_attr( $args['menu_id'] ) . '"';
1324 if ( ! empty( $args['menu_class'] ) ) {
1325 $attrs .= ' class="' . esc_attr( $args['menu_class'] ) . '"';
1328 $menu = "<{$container}{$attrs}>" . $menu . "</{$container}>\n";
1331 * Filter the HTML output of a page-based menu.
1335 * @see wp_page_menu()
1337 * @param string $menu The HTML output.
1338 * @param array $args An array of arguments.
1340 $menu = apply_filters( 'wp_page_menu', $menu, $args );
1341 if ( $args['echo'] )
1352 * Retrieve HTML list content for page list.
1354 * @uses Walker_Page to create HTML list content.
1357 * @param array $pages
1359 * @param int $current_page
1363 function walk_page_tree( $pages, $depth, $current_page, $r ) {
1364 if ( empty($r['walker']) )
1365 $walker = new Walker_Page;
1367 $walker = $r['walker'];
1369 foreach ( (array) $pages as $page ) {
1370 if ( $page->post_parent )
1371 $r['pages_with_children'][ $page->post_parent ] = true;
1374 $args = array($pages, $depth, $r, $current_page);
1375 return call_user_func_array(array($walker, 'walk'), $args);
1379 * Retrieve HTML dropdown (select) content for page list.
1381 * @uses Walker_PageDropdown to create HTML dropdown content.
1383 * @see Walker_PageDropdown::walk() for parameters and return description.
1387 function walk_page_dropdown_tree() {
1388 $args = func_get_args();
1389 if ( empty($args[2]['walker']) ) // the user's options are the third parameter
1390 $walker = new Walker_PageDropdown;
1392 $walker = $args[2]['walker'];
1394 return call_user_func_array(array($walker, 'walk'), $args);
1402 * Display an attachment page link using an image or icon.
1406 * @param int|WP_Post $id Optional. Post ID or post object.
1407 * @param bool $fullsize Optional, default is false. Whether to use full size.
1408 * @param bool $deprecated Deprecated. Not used.
1409 * @param bool $permalink Optional, default is false. Whether to include permalink.
1411 function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
1412 if ( !empty( $deprecated ) )
1413 _deprecated_argument( __FUNCTION__, '2.5' );
1416 echo wp_get_attachment_link($id, 'full', $permalink);
1418 echo wp_get_attachment_link($id, 'thumbnail', $permalink);
1422 * Retrieve an attachment page link using an image or icon, if possible.
1425 * @since 4.4.0 The `$id` parameter can now accept either a post ID or `WP_Post` object.
1427 * @param int|WP_Post $id Optional. Post ID or post object.
1428 * @param string|array $size Optional. Image size. Accepts any valid image size, or an array
1429 * of width and height values in pixels (in that order).
1430 * Default 'thumbnail'.
1431 * @param bool $permalink Optional, Whether to add permalink to image. Default false.
1432 * @param bool $icon Optional. Whether the attachment is an icon. Default false.
1433 * @param string|false $text Optional. Link text to use. Activated by passing a string, false otherwise.
1435 * @param array|string $attr Optional. Array or string of attributes. Default empty.
1436 * @return string HTML content.
1438 function wp_get_attachment_link( $id = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false, $attr = '' ) {
1439 $_post = get_post( $id );
1441 if ( empty( $_post ) || ( 'attachment' != $_post->post_type ) || ! $url = wp_get_attachment_url( $_post->ID ) )
1442 return __( 'Missing Attachment' );
1445 $url = get_attachment_link( $_post->ID );
1449 } elseif ( $size && 'none' != $size ) {
1450 $link_text = wp_get_attachment_image( $_post->ID, $size, $icon, $attr );
1455 if ( trim( $link_text ) == '' )
1456 $link_text = $_post->post_title;
1459 * Filter a retrieved attachment page link.
1463 * @param string $link_html The page link HTML output.
1464 * @param int $id Post ID.
1465 * @param string|array $size Size of the image. Image size or array of width and height values (in that order).
1466 * Default 'thumbnail'.
1467 * @param bool $permalink Whether to add permalink to image. Default false.
1468 * @param bool $icon Whether to include an icon. Default false.
1469 * @param string|bool $text If string, will be link text. Default false.
1471 return apply_filters( 'wp_get_attachment_link', "<a href='$url'>$link_text</a>", $id, $size, $permalink, $icon, $text );
1475 * Wrap attachment in paragraph tag before content.
1479 * @param string $content
1482 function prepend_attachment($content) {
1485 if ( empty($post->post_type) || $post->post_type != 'attachment' )
1488 if ( wp_attachment_is( 'video', $post ) ) {
1489 $meta = wp_get_attachment_metadata( get_the_ID() );
1490 $atts = array( 'src' => wp_get_attachment_url() );
1491 if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) {
1492 $atts['width'] = (int) $meta['width'];
1493 $atts['height'] = (int) $meta['height'];
1495 if ( has_post_thumbnail() ) {
1496 $atts['poster'] = wp_get_attachment_url( get_post_thumbnail_id() );
1498 $p = wp_video_shortcode( $atts );
1499 } elseif ( wp_attachment_is( 'audio', $post ) ) {
1500 $p = wp_audio_shortcode( array( 'src' => wp_get_attachment_url() ) );
1502 $p = '<p class="attachment">';
1503 // show the medium sized image representation of the attachment if available, and link to the raw file
1504 $p .= wp_get_attachment_link(0, 'medium', false);
1509 * Filter the attachment markup to be prepended to the post content.
1513 * @see prepend_attachment()
1515 * @param string $p The attachment HTML output.
1517 $p = apply_filters( 'prepend_attachment', $p );
1519 return "$p\n$content";
1527 * Retrieve protected post password form content.
1531 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
1532 * @return string HTML content for password form for password protected post.
1534 function get_the_password_form( $post = 0 ) {
1535 $post = get_post( $post );
1536 $label = 'pwbox-' . ( empty($post->ID) ? rand() : $post->ID );
1537 $output = '<form action="' . esc_url( site_url( 'wp-login.php?action=postpass', 'login_post' ) ) . '" class="post-password-form" method="post">
1538 <p>' . __( 'This content is password protected. To view it please enter your password below:' ) . '</p>
1539 <p><label for="' . $label . '">' . __( 'Password:' ) . ' <input name="post_password" id="' . $label . '" type="password" size="20" /></label> <input type="submit" name="Submit" value="' . esc_attr_x( 'Enter', 'post password form' ) . '" /></p></form>
1543 * Filter the HTML output for the protected post password form.
1545 * If modifying the password field, please note that the core database schema
1546 * limits the password field to 20 characters regardless of the value of the
1547 * size attribute in the form input.
1551 * @param string $output The password form HTML output.
1553 return apply_filters( 'the_password_form', $output );
1557 * Whether currently in a page template.
1559 * This template tag allows you to determine if you are in a page template.
1560 * You can optionally provide a template name or array of template names
1561 * and then the check will be specific to that template.
1564 * @since 4.2.0 The `$template` parameter was changed to also accept an array of page templates.
1566 * @param string|array $template The specific template name or array of templates to match.
1567 * @return bool True on success, false on failure.
1569 function is_page_template( $template = '' ) {
1573 $page_template = get_page_template_slug( get_queried_object_id() );
1575 if ( empty( $template ) )
1576 return (bool) $page_template;
1578 if ( $template == $page_template )
1581 if ( is_array( $template ) ) {
1582 if ( ( in_array( 'default', $template, true ) && ! $page_template )
1583 || in_array( $page_template, $template, true )
1589 return ( 'default' === $template && ! $page_template );
1593 * Get the specific template name for a page.
1597 * @param int $post_id Optional. The page ID to check. Defaults to the current post, when used in the loop.
1598 * @return string|false Page template filename. Returns an empty string when the default page template
1599 * is in use. Returns false if the post is not a page.
1601 function get_page_template_slug( $post_id = null ) {
1602 $post = get_post( $post_id );
1603 if ( ! $post || 'page' != $post->post_type )
1605 $template = get_post_meta( $post->ID, '_wp_page_template', true );
1606 if ( ! $template || 'default' == $template )
1612 * Retrieve formatted date timestamp of a revision (linked to that revisions's page).
1616 * @param int|object $revision Revision ID or revision object.
1617 * @param bool $link Optional, default is true. Link to revisions's page?
1618 * @return string|false i18n formatted datetimestamp or localized 'Current Revision'.
1620 function wp_post_revision_title( $revision, $link = true ) {
1621 if ( !$revision = get_post( $revision ) )
1624 if ( !in_array( $revision->post_type, array( 'post', 'page', 'revision' ) ) )
1627 /* translators: revision date format, see http://php.net/date */
1628 $datef = _x( 'F j, Y @ H:i:s', 'revision date format' );
1629 /* translators: 1: date */
1630 $autosavef = _x( '%1$s [Autosave]', 'post revision title extra' );
1631 /* translators: 1: date */
1632 $currentf = _x( '%1$s [Current Revision]', 'post revision title extra' );
1634 $date = date_i18n( $datef, strtotime( $revision->post_modified ) );
1635 if ( $link && current_user_can( 'edit_post', $revision->ID ) && $link = get_edit_post_link( $revision->ID ) )
1636 $date = "<a href='$link'>$date</a>";
1638 if ( !wp_is_post_revision( $revision ) )
1639 $date = sprintf( $currentf, $date );
1640 elseif ( wp_is_post_autosave( $revision ) )
1641 $date = sprintf( $autosavef, $date );
1647 * Retrieve formatted date timestamp of a revision (linked to that revisions's page).
1651 * @param int|object $revision Revision ID or revision object.
1652 * @param bool $link Optional, default is true. Link to revisions's page?
1653 * @return string|false gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'.
1655 function wp_post_revision_title_expanded( $revision, $link = true ) {
1656 if ( !$revision = get_post( $revision ) )
1659 if ( !in_array( $revision->post_type, array( 'post', 'page', 'revision' ) ) )
1662 $author = get_the_author_meta( 'display_name', $revision->post_author );
1663 /* translators: revision date format, see http://php.net/date */
1664 $datef = _x( 'F j, Y @ H:i:s', 'revision date format' );
1666 $gravatar = get_avatar( $revision->post_author, 24 );
1668 $date = date_i18n( $datef, strtotime( $revision->post_modified ) );
1669 if ( $link && current_user_can( 'edit_post', $revision->ID ) && $link = get_edit_post_link( $revision->ID ) )
1670 $date = "<a href='$link'>$date</a>";
1672 $revision_date_author = sprintf(
1673 /* translators: post revision title: 1: author avatar, 2: author name, 3: time ago, 4: date */
1674 _x( '%1$s %2$s, %3$s ago (%4$s)', 'post revision title' ),
1677 human_time_diff( strtotime( $revision->post_modified ), current_time( 'timestamp' ) ),
1681 $autosavef = __( '%1$s [Autosave]' );
1682 $currentf = __( '%1$s [Current Revision]' );
1684 if ( !wp_is_post_revision( $revision ) )
1685 $revision_date_author = sprintf( $currentf, $revision_date_author );
1686 elseif ( wp_is_post_autosave( $revision ) )
1687 $revision_date_author = sprintf( $autosavef, $revision_date_author );
1690 * Filter the formatted author and date for a revision.
1694 * @param string $revision_date_author The formatted string.
1695 * @param WP_Post $revision The revision object.
1696 * @param bool $link Whether to link to the revisions page, as passed into
1697 * wp_post_revision_title_expanded().
1699 return apply_filters( 'wp_post_revision_title_expanded', $revision_date_author, $revision, $link );
1703 * Display list of a post's revisions.
1705 * Can output either a UL with edit links or a TABLE with diff interface, and
1706 * restore action links.
1710 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
1711 * @param string $type 'all' (default), 'revision' or 'autosave'
1713 function wp_list_post_revisions( $post_id = 0, $type = 'all' ) {
1714 if ( ! $post = get_post( $post_id ) )
1717 // $args array with (parent, format, right, left, type) deprecated since 3.6
1718 if ( is_array( $type ) ) {
1719 $type = ! empty( $type['type'] ) ? $type['type'] : $type;
1720 _deprecated_argument( __FUNCTION__, '3.6' );
1723 if ( ! $revisions = wp_get_post_revisions( $post->ID ) )
1727 foreach ( $revisions as $revision ) {
1728 if ( ! current_user_can( 'read_post', $revision->ID ) )
1731 $is_autosave = wp_is_post_autosave( $revision );
1732 if ( ( 'revision' === $type && $is_autosave ) || ( 'autosave' === $type && ! $is_autosave ) )
1735 $rows .= "\t<li>" . wp_post_revision_title_expanded( $revision ) . "</li>\n";
1738 echo "<div class='hide-if-js'><p>" . __( 'JavaScript must be enabled to use this feature.' ) . "</p></div>\n";
1740 echo "<ul class='post-revisions hide-if-no-js'>\n";