Wordpress 3.5.2
[autoinstalls/wordpress.git] / wp-includes / post-template.php
index a956dc482f1a6049a7f8b6eb02fabe78b844b03f..d51d00953ee3494eefcff76216067e833ec83938 100644 (file)
@@ -1,21 +1,44 @@
 <?php
 <?php
-
-//
-// "The Loop" post functions
-//
-
+/**
+ * WordPress Post Template Functions.
+ *
+ * Gets content for the current post in the loop.
+ *
+ * @package WordPress
+ * @subpackage Template
+ */
+
+/**
+ * Display the ID of the current item in the WordPress Loop.
+ *
+ * @since 0.71
+ */
 function the_ID() {
 function the_ID() {
-       global $id;
-       echo $id;
+       echo get_the_ID();
 }
 
 }
 
-
+/**
+ * Retrieve the ID of the current item in the WordPress Loop.
+ *
+ * @since 2.1.0
+ * @uses $post
+ *
+ * @return int
+ */
 function get_the_ID() {
 function get_the_ID() {
-       global $id;
-       return $id;
+       return get_post()->ID;
 }
 
 }
 
-
+/**
+ * Display or retrieve the current post title with optional content.
+ *
+ * @since 0.71
+ *
+ * @param string $before Optional. Content to prepend to the title.
+ * @param string $after Optional. Content to append to the title.
+ * @param bool $echo Optional, default to true.Whether to display or return.
+ * @return null|string Null on no title. String if $echo parameter is false.
+ */
 function the_title($before = '', $after = '', $echo = true) {
        $title = get_the_title();
 
 function the_title($before = '', $after = '', $echo = true) {
        $title = get_the_title();
 
@@ -30,6 +53,21 @@ function the_title($before = '', $after = '', $echo = true) {
                return $title;
 }
 
                return $title;
 }
 
+/**
+ * Sanitize the current title when retrieving or displaying.
+ *
+ * Works like {@link the_title()}, except the parameters can be in a string or
+ * an array. See the function for what can be override in the $args parameter.
+ *
+ * The title before it is displayed will have the tags stripped and {@link
+ * esc_attr()} before it is passed to the user or displayed. The default
+ * as with {@link the_title()}, is to display the title.
+ *
+ * @since 2.3.0
+ *
+ * @param string|array $args Optional. Override the defaults.
+ * @return string|null Null on failure or display. String when echo is false.
+ */
 function the_title_attribute( $args = '' ) {
        $title = get_the_title();
 
 function the_title_attribute( $args = '' ) {
        $title = get_the_title();
 
@@ -40,9 +78,8 @@ function the_title_attribute( $args = '' ) {
        $r = wp_parse_args($args, $defaults);
        extract( $r, EXTR_SKIP );
 
        $r = wp_parse_args($args, $defaults);
        extract( $r, EXTR_SKIP );
 
-
        $title = $before . $title . $after;
        $title = $before . $title . $after;
-       $title = attribute_escape(strip_tags($title));
+       $title = esc_attr(strip_tags($title));
 
        if ( $echo )
                echo $title;
 
        if ( $echo )
                echo $title;
@@ -50,53 +87,110 @@ function the_title_attribute( $args = '' ) {
                return $title;
 }
 
                return $title;
 }
 
-function get_the_title( $id = 0 ) {
-       $post = &get_post($id);
-
-       $title = $post->post_title;
-       if ( !empty($post->post_password) )
-               $title = sprintf(__('Protected: %s'), $title);
-       else if ( 'private' == $post->post_status )
-               $title = sprintf(__('Private: %s'), $title);
+/**
+ * Retrieve post title.
+ *
+ * If the post is protected and the visitor is not an admin, then "Protected"
+ * will be displayed before the post title. If the post is private, then
+ * "Private" will be located before the post title.
+ *
+ * @since 0.71
+ *
+ * @param mixed $post Optional. Post ID or object.
+ * @return string
+ */
+function get_the_title( $post = 0 ) {
+       $post = get_post( $post );
+
+       $title = isset( $post->post_title ) ? $post->post_title : '';
+       $id = isset( $post->ID ) ? $post->ID : 0;
+
+       if ( ! is_admin() ) {
+               if ( ! empty( $post->post_password ) ) {
+                       $protected_title_format = apply_filters( 'protected_title_format', __( 'Protected: %s' ) );
+                       $title = sprintf( $protected_title_format, $title );
+               } else if ( isset( $post->post_status ) && 'private' == $post->post_status ) {
+                       $private_title_format = apply_filters( 'private_title_format', __( 'Private: %s' ) );
+                       $title = sprintf( $private_title_format, $title );
+               }
+       }
 
 
-       return apply_filters( 'the_title', $title );
+       return apply_filters( 'the_title', $title, $id );
 }
 
 }
 
+/**
+ * Display the Post Global Unique Identifier (guid).
+ *
+ * The guid will appear to be a link, but should not be used as an link to the
+ * post. The reason you should not use it as a link, is because of moving the
+ * blog across domains.
+ *
+ * Url is escaped to make it xml safe
+ *
+ * @since 1.5.0
+ *
+ * @param int $id Optional. Post ID.
+ */
 function the_guid( $id = 0 ) {
 function the_guid( $id = 0 ) {
-       echo get_the_guid($id);
+       echo esc_url( get_the_guid( $id ) );
 }
 
 }
 
+/**
+ * Retrieve the Post Global Unique Identifier (guid).
+ *
+ * The guid will appear to be a link, but should not be used as an link to the
+ * post. The reason you should not use it as a link, is because of moving the
+ * blog across domains.
+ *
+ * @since 1.5.0
+ *
+ * @param int $id Optional. Post ID.
+ * @return string
+ */
 function get_the_guid( $id = 0 ) {
 function get_the_guid( $id = 0 ) {
-       $post = &get_post($id);
+       $post = get_post($id);
 
        return apply_filters('get_the_guid', $post->guid);
 }
 
 
        return apply_filters('get_the_guid', $post->guid);
 }
 
-function the_content($more_link_text = '(more...)', $stripteaser = 0, $more_file = '') {
-       $content = get_the_content($more_link_text, $stripteaser, $more_file);
+/**
+ * Display the post content.
+ *
+ * @since 0.71
+ *
+ * @param string $more_link_text Optional. Content for when there is more text.
+ * @param bool $stripteaser Optional. Strip teaser content before the more text. Default is false.
+ */
+function the_content($more_link_text = null, $stripteaser = false) {
+       $content = get_the_content($more_link_text, $stripteaser);
        $content = apply_filters('the_content', $content);
        $content = str_replace(']]>', ']]&gt;', $content);
        echo $content;
 }
 
        $content = apply_filters('the_content', $content);
        $content = str_replace(']]>', ']]&gt;', $content);
        echo $content;
 }
 
+/**
+ * Retrieve the post content.
+ *
+ * @since 0.71
+ *
+ * @param string $more_link_text Optional. Content for when there is more text.
+ * @param bool $stripteaser Optional. Strip teaser content before the more text. Default is false.
+ * @return string
+ */
+function get_the_content( $more_link_text = null, $stripteaser = false ) {
+       global $more, $page, $pages, $multipage, $preview;
 
 
-function get_the_content($more_link_text = '(more...)', $stripteaser = 0, $more_file = '') {
-       global $id, $post, $more, $single, $withcomments, $page, $pages, $multipage, $numpages;
-       global $preview;
-       global $pagenow;
-       $output = '';
+       $post = get_post();
 
 
-       if ( !empty($post->post_password) ) { // if there's a password
-               if ( stripslashes($_COOKIE['wp-postpass_'.COOKIEHASH]) != $post->post_password ) {      // and it doesn't match the cookie
-                       $output = get_the_password_form();
-                       return $output;
-               }
-       }
+       if ( null === $more_link_text )
+               $more_link_text = __( '(more...)' );
 
 
-       if ( $more_file != '' )
-               $file = $more_file;
-       else
-               $file = $pagenow; //$_SERVER['PHP_SELF'];
+       $output = '';
+       $hasTeaser = false;
+
+       // If post password required and it doesn't match the cookie.
+       if ( post_password_required() )
+               return get_the_password_form();
 
        if ( $page > count($pages) ) // if the requested page doesn't exist
                $page = count($pages); // give them the highest numbered page that DOES exist
 
        if ( $page > count($pages) ) // if the requested page doesn't exist
                $page = count($pages); // give them the highest numbered page that DOES exist
@@ -106,91 +200,457 @@ function get_the_content($more_link_text = '(more...)', $stripteaser = 0, $more_
                $content = explode($matches[0], $content, 2);
                if ( !empty($matches[1]) && !empty($more_link_text) )
                        $more_link_text = strip_tags(wp_kses_no_null(trim($matches[1])));
                $content = explode($matches[0], $content, 2);
                if ( !empty($matches[1]) && !empty($more_link_text) )
                        $more_link_text = strip_tags(wp_kses_no_null(trim($matches[1])));
+
+               $hasTeaser = true;
        } else {
                $content = array($content);
        }
        if ( (false !== strpos($post->post_content, '<!--noteaser-->') && ((!$multipage) || ($page==1))) )
        } else {
                $content = array($content);
        }
        if ( (false !== strpos($post->post_content, '<!--noteaser-->') && ((!$multipage) || ($page==1))) )
-               $stripteaser = 1;
+               $stripteaser = true;
        $teaser = $content[0];
        $teaser = $content[0];
-       if ( ($more) && ($stripteaser) )
+       if ( $more && $stripteaser && $hasTeaser )
                $teaser = '';
        $output .= $teaser;
        if ( count($content) > 1 ) {
                if ( $more ) {
                $teaser = '';
        $output .= $teaser;
        if ( count($content) > 1 ) {
                if ( $more ) {
-                       $output .= '<span id="more-'.$id.'"></span>'.$content[1];
+                       $output .= '<span id="more-' . $post->ID . '"></span>' . $content[1];
                } else {
                } else {
-                       $output = balanceTags($output);
                        if ( ! empty($more_link_text) )
                        if ( ! empty($more_link_text) )
-                               $output .= ' <a href="'. get_permalink() . "#more-$id\" class=\"more-link\">$more_link_text</a>";
+                               $output .= apply_filters( 'the_content_more_link', ' <a href="' . get_permalink() . "#more-{$post->ID}\" class=\"more-link\">$more_link_text</a>", $more_link_text );
+                       $output = force_balance_tags($output);
                }
 
        }
        if ( $preview ) // preview fix for javascript bug with foreign languages
                }
 
        }
        if ( $preview ) // preview fix for javascript bug with foreign languages
-               $output =       preg_replace('/\%u([0-9A-F]{4,4})/e',   "'&#'.base_convert('\\1',16,10).';'", $output);
+               $output =       preg_replace_callback('/\%u([0-9A-F]{4})/', '_convert_urlencoded_to_entities', $output);
 
        return $output;
 }
 
 
        return $output;
 }
 
+/**
+ * Preview fix for javascript bug with foreign languages
+ *
+ * @since 3.1.0
+ * @access private
+ * @param array $match Match array from preg_replace_callback
+ * @return string
+ */
+function _convert_urlencoded_to_entities( $match ) {
+       return '&#' . base_convert( $match[1], 16, 10 ) . ';';
+}
 
 
+/**
+ * Display the post excerpt.
+ *
+ * @since 0.71
+ * @uses apply_filters() Calls 'the_excerpt' hook on post excerpt.
+ */
 function the_excerpt() {
        echo apply_filters('the_excerpt', get_the_excerpt());
 }
 
 function the_excerpt() {
        echo apply_filters('the_excerpt', get_the_excerpt());
 }
 
-
-function get_the_excerpt($deprecated = true) {
-       global $id, $post;
-       $output = '';
-       $output = $post->post_excerpt;
-       if ( !empty($post->post_password) ) { // if there's a password
-               if ( $_COOKIE['wp-postpass_'.COOKIEHASH] != $post->post_password ) {  // and it doesn't match the cookie
-                       $output = __('There is no excerpt because this is a protected post.');
-                       return $output;
-               }
+/**
+ * Retrieve the post excerpt.
+ *
+ * @since 0.71
+ *
+ * @param mixed $deprecated Not used.
+ * @return string
+ */
+function get_the_excerpt( $deprecated = '' ) {
+       if ( !empty( $deprecated ) )
+               _deprecated_argument( __FUNCTION__, '2.3' );
+
+       $post = get_post();
+
+       if ( post_password_required() ) {
+               return __( 'There is no excerpt because this is a protected post.' );
        }
 
        }
 
-       return apply_filters('get_the_excerpt', $output);
+       return apply_filters( 'get_the_excerpt', $post->post_excerpt );
 }
 
 }
 
+/**
+ * Whether post has excerpt.
+ *
+ * @since 2.3.0
+ *
+ * @param int $id Optional. Post ID.
+ * @return bool
+ */
 function has_excerpt( $id = 0 ) {
 function has_excerpt( $id = 0 ) {
-       $post = &get_post( $id );
+       $post = get_post( $id );
        return ( !empty( $post->post_excerpt ) );
 }
 
        return ( !empty( $post->post_excerpt ) );
 }
 
+/**
+ * Display the classes for the post div.
+ *
+ * @since 2.7.0
+ *
+ * @param string|array $class One or more classes to add to the class list.
+ * @param int $post_id An optional post ID.
+ */
+function post_class( $class = '', $post_id = null ) {
+       // Separates classes with a single space, collates classes for post DIV
+       echo 'class="' . join( ' ', get_post_class( $class, $post_id ) ) . '"';
+}
+
+/**
+ * Retrieve the classes for the post div as an array.
+ *
+ * The class names are add are many. If the post is a sticky, then the 'sticky'
+ * class name. The class 'hentry' is always added to each post. For each
+ * category, the class will be added with 'category-' with category slug is
+ * added. The tags are the same way as the categories with 'tag-' before the tag
+ * slug. All classes are passed through the filter, 'post_class' with the list
+ * of classes, followed by $class parameter value, with the post ID as the last
+ * parameter.
+ *
+ * @since 2.7.0
+ *
+ * @param string|array $class One or more classes to add to the class list.
+ * @param int $post_id An optional post ID.
+ * @return array Array of classes.
+ */
+function get_post_class( $class = '', $post_id = null ) {
+       $post = get_post($post_id);
+
+       $classes = array();
+
+       if ( empty($post) )
+               return $classes;
+
+       $classes[] = 'post-' . $post->ID;
+       if ( ! is_admin() )
+               $classes[] = $post->post_type;
+       $classes[] = 'type-' . $post->post_type;
+       $classes[] = 'status-' . $post->post_status;
+
+       // Post Format
+       if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
+               $post_format = get_post_format( $post->ID );
+
+               if ( $post_format && !is_wp_error($post_format) )
+                       $classes[] = 'format-' . sanitize_html_class( $post_format );
+               else
+                       $classes[] = 'format-standard';
+       }
+
+       // post requires password
+       if ( post_password_required($post->ID) )
+               $classes[] = 'post-password-required';
+
+       // sticky for Sticky Posts
+       if ( is_sticky($post->ID) && is_home() && !is_paged() )
+               $classes[] = 'sticky';
+
+       // hentry for hAtom compliance
+       $classes[] = 'hentry';
+
+       // Categories
+       if ( is_object_in_taxonomy( $post->post_type, 'category' ) ) {
+               foreach ( (array) get_the_category($post->ID) as $cat ) {
+                       if ( empty($cat->slug ) )
+                               continue;
+                       $classes[] = 'category-' . sanitize_html_class($cat->slug, $cat->term_id);
+               }
+       }
+
+       // Tags
+       if ( is_object_in_taxonomy( $post->post_type, 'post_tag' ) ) {
+               foreach ( (array) get_the_tags($post->ID) as $tag ) {
+                       if ( empty($tag->slug ) )
+                               continue;
+                       $classes[] = 'tag-' . sanitize_html_class($tag->slug, $tag->term_id);
+               }
+       }
+
+       if ( !empty($class) ) {
+               if ( !is_array( $class ) )
+                       $class = preg_split('#\s+#', $class);
+               $classes = array_merge($classes, $class);
+       }
+
+       $classes = array_map('esc_attr', $classes);
+
+       return apply_filters('post_class', $classes, $class, $post->ID);
+}
+
+/**
+ * Display the classes for the body element.
+ *
+ * @since 2.8.0
+ *
+ * @param string|array $class One or more classes to add to the class list.
+ */
+function body_class( $class = '' ) {
+       // Separates classes with a single space, collates classes for body element
+       echo 'class="' . join( ' ', get_body_class( $class ) ) . '"';
+}
+
+/**
+ * Retrieve the classes for the body element as an array.
+ *
+ * @since 2.8.0
+ *
+ * @param string|array $class One or more classes to add to the class list.
+ * @return array Array of classes.
+ */
+function get_body_class( $class = '' ) {
+       global $wp_query, $wpdb;
+
+       $classes = array();
+
+       if ( is_rtl() )
+               $classes[] = 'rtl';
+
+       if ( is_front_page() )
+               $classes[] = 'home';
+       if ( is_home() )
+               $classes[] = 'blog';
+       if ( is_archive() )
+               $classes[] = 'archive';
+       if ( is_date() )
+               $classes[] = 'date';
+       if ( is_search() ) {
+               $classes[] = 'search';
+               $classes[] = $wp_query->posts ? 'search-results' : 'search-no-results';
+       }
+       if ( is_paged() )
+               $classes[] = 'paged';
+       if ( is_attachment() )
+               $classes[] = 'attachment';
+       if ( is_404() )
+               $classes[] = 'error404';
+
+       if ( is_single() ) {
+               $post_id = $wp_query->get_queried_object_id();
+               $post = $wp_query->get_queried_object();
+
+               $classes[] = 'single';
+               if ( isset( $post->post_type ) ) {
+                       $classes[] = 'single-' . sanitize_html_class($post->post_type, $post_id);
+                       $classes[] = 'postid-' . $post_id;
+
+                       // Post Format
+                       if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
+                               $post_format = get_post_format( $post->ID );
+
+                               if ( $post_format && !is_wp_error($post_format) )
+                                       $classes[] = 'single-format-' . sanitize_html_class( $post_format );
+                               else
+                                       $classes[] = 'single-format-standard';
+                       }
+               }
+
+               if ( is_attachment() ) {
+                       $mime_type = get_post_mime_type($post_id);
+                       $mime_prefix = array( 'application/', 'image/', 'text/', 'audio/', 'video/', 'music/' );
+                       $classes[] = 'attachmentid-' . $post_id;
+                       $classes[] = 'attachment-' . str_replace( $mime_prefix, '', $mime_type );
+               }
+       } elseif ( is_archive() ) {
+               if ( is_post_type_archive() ) {
+                       $classes[] = 'post-type-archive';
+                       $classes[] = 'post-type-archive-' . sanitize_html_class( get_query_var( 'post_type' ) );
+               } else if ( is_author() ) {
+                       $author = $wp_query->get_queried_object();
+                       $classes[] = 'author';
+                       if ( isset( $author->user_nicename ) ) {
+                               $classes[] = 'author-' . sanitize_html_class( $author->user_nicename, $author->ID );
+                               $classes[] = 'author-' . $author->ID;
+                       }
+               } elseif ( is_category() ) {
+                       $cat = $wp_query->get_queried_object();
+                       $classes[] = 'category';
+                       if ( isset( $cat->term_id ) ) {
+                               $classes[] = 'category-' . sanitize_html_class( $cat->slug, $cat->term_id );
+                               $classes[] = 'category-' . $cat->term_id;
+                       }
+               } elseif ( is_tag() ) {
+                       $tags = $wp_query->get_queried_object();
+                       $classes[] = 'tag';
+                       if ( isset( $tags->term_id ) ) {
+                               $classes[] = 'tag-' . sanitize_html_class( $tags->slug, $tags->term_id );
+                               $classes[] = 'tag-' . $tags->term_id;
+                       }
+               } elseif ( is_tax() ) {
+                       $term = $wp_query->get_queried_object();
+                       if ( isset( $term->term_id ) ) {
+                               $classes[] = 'tax-' . sanitize_html_class( $term->taxonomy );
+                               $classes[] = 'term-' . sanitize_html_class( $term->slug, $term->term_id );
+                               $classes[] = 'term-' . $term->term_id;
+                       }
+               }
+       } elseif ( is_page() ) {
+               $classes[] = 'page';
+
+               $page_id = $wp_query->get_queried_object_id();
+
+               $post = get_post($page_id);
+
+               $classes[] = 'page-id-' . $page_id;
+
+               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) ) )
+                       $classes[] = 'page-parent';
+
+               if ( $post->post_parent ) {
+                       $classes[] = 'page-child';
+                       $classes[] = 'parent-pageid-' . $post->post_parent;
+               }
+               if ( is_page_template() ) {
+                       $classes[] = 'page-template';
+                       $classes[] = 'page-template-' . sanitize_html_class( str_replace( '.', '-', get_page_template_slug( $page_id ) ) );
+               } else {
+                       $classes[] = 'page-template-default';
+               }
+       }
+
+       if ( is_user_logged_in() )
+               $classes[] = 'logged-in';
+
+       if ( is_admin_bar_showing() ) {
+               $classes[] = 'admin-bar';
+               $classes[] = 'no-customize-support';
+       }
+
+       if ( get_theme_mod( 'background_color' ) || get_background_image() )
+               $classes[] = 'custom-background';
+
+       $page = $wp_query->get( 'page' );
+
+       if ( !$page || $page < 2)
+               $page = $wp_query->get( 'paged' );
+
+       if ( $page && $page > 1 ) {
+               $classes[] = 'paged-' . $page;
+
+               if ( is_single() )
+                       $classes[] = 'single-paged-' . $page;
+               elseif ( is_page() )
+                       $classes[] = 'page-paged-' . $page;
+               elseif ( is_category() )
+                       $classes[] = 'category-paged-' . $page;
+               elseif ( is_tag() )
+                       $classes[] = 'tag-paged-' . $page;
+               elseif ( is_date() )
+                       $classes[] = 'date-paged-' . $page;
+               elseif ( is_author() )
+                       $classes[] = 'author-paged-' . $page;
+               elseif ( is_search() )
+                       $classes[] = 'search-paged-' . $page;
+               elseif ( is_post_type_archive() )
+                       $classes[] = 'post-type-paged-' . $page;
+       }
+
+       if ( ! empty( $class ) ) {
+               if ( !is_array( $class ) )
+                       $class = preg_split( '#\s+#', $class );
+               $classes = array_merge( $classes, $class );
+       } else {
+               // Ensure that we always coerce class to being an array.
+               $class = array();
+       }
+
+       $classes = array_map( 'esc_attr', $classes );
+
+       return apply_filters( 'body_class', $classes, $class );
+}
+
+/**
+ * Whether post requires password and correct password has been provided.
+ *
+ * @since 2.7.0
+ *
+ * @param int|object $post An optional post. Global $post used if not provided.
+ * @return bool false if a password is not required or the correct password cookie is present, true otherwise.
+ */
+function post_password_required( $post = null ) {
+       $post = get_post($post);
+
+       if ( empty( $post->post_password ) )
+               return false;
+
+       if ( ! isset( $_COOKIE['wp-postpass_' . COOKIEHASH] ) )
+               return true;
+
+       require_once ABSPATH . 'wp-includes/class-phpass.php';
+       $hasher = new PasswordHash( 8, true );
+
+       $hash = stripslashes( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] );
+       if ( 0 !== strpos( $hash, '$P$B' ) )
+               return true;
+
+       return ! $hasher->CheckPassword( $post->post_password, $hash );
+}
+
+/**
+ * Page Template Functions for usage in Themes
+ *
+ * @package WordPress
+ * @subpackage Template
+ */
+
+/**
+ * The formatted output of a list of pages.
+ *
+ * Displays page links for paginated posts (i.e. includes the <!--nextpage-->.
+ * Quicktag one or more times). This tag must be within The Loop.
+ *
+ * The defaults for overwriting are:
+ * 'next_or_number' - Default is 'number' (string). Indicates whether page
+ *      numbers should be used. Valid values are number and next.
+ * 'nextpagelink' - Default is 'Next Page' (string). Text for link to next page.
+ *      of the bookmark.
+ * 'previouspagelink' - Default is 'Previous Page' (string). Text for link to
+ *      previous page, if available.
+ * 'pagelink' - Default is '%' (String).Format string for page numbers. The % in
+ *      the parameter string will be replaced with the page number, so Page %
+ *      generates "Page 1", "Page 2", etc. Defaults to %, just the page number.
+ * 'before' - Default is '<p> Pages:' (string). The html or text to prepend to
+ *      each bookmarks.
+ * 'after' - Default is '</p>' (string). The html or text to append to each
+ *      bookmarks.
+ * 'link_before' - Default is '' (string). The html or text to prepend to each
+ *      Pages link inside the <a> tag. Also prepended to the current item, which
+ *      is not linked.
+ * 'link_after' - Default is '' (string). The html or text to append to each
+ *      Pages link inside the <a> tag. Also appended to the current item, which
+ *      is not linked.
+ *
+ * @since 1.2.0
+ * @access private
+ *
+ * @param string|array $args Optional. Overwrite the defaults.
+ * @return string Formatted output in HTML.
+ */
 function wp_link_pages($args = '') {
        $defaults = array(
                'before' => '<p>' . __('Pages:'), 'after' => '</p>',
 function wp_link_pages($args = '') {
        $defaults = array(
                'before' => '<p>' . __('Pages:'), 'after' => '</p>',
+               'link_before' => '', 'link_after' => '',
                'next_or_number' => 'number', 'nextpagelink' => __('Next page'),
                'previouspagelink' => __('Previous page'), 'pagelink' => '%',
                'next_or_number' => 'number', 'nextpagelink' => __('Next page'),
                'previouspagelink' => __('Previous page'), 'pagelink' => '%',
-               'more_file' => '', 'echo' => 1
+               'echo' => 1
        );
 
        $r = wp_parse_args( $args, $defaults );
        );
 
        $r = wp_parse_args( $args, $defaults );
+       $r = apply_filters( 'wp_link_pages_args', $r );
        extract( $r, EXTR_SKIP );
 
        extract( $r, EXTR_SKIP );
 
-       global $post, $id, $page, $numpages, $multipage, $more, $pagenow;
-       if ( $more_file != '' )
-               $file = $more_file;
-       else
-               $file = $pagenow;
+       global $page, $numpages, $multipage, $more, $pagenow;
 
        $output = '';
        if ( $multipage ) {
                if ( 'number' == $next_or_number ) {
                        $output .= $before;
                        for ( $i = 1; $i < ($numpages+1); $i = $i + 1 ) {
 
        $output = '';
        if ( $multipage ) {
                if ( 'number' == $next_or_number ) {
                        $output .= $before;
                        for ( $i = 1; $i < ($numpages+1); $i = $i + 1 ) {
-                               $j = str_replace('%',"$i",$pagelink);
+                               $j = str_replace('%',$i,$pagelink);
                                $output .= ' ';
                                if ( ($i != $page) || ((!$more) && ($page==1)) ) {
                                $output .= ' ';
                                if ( ($i != $page) || ((!$more) && ($page==1)) ) {
-                                       if ( 1 == $i ) {
-                                               $output .= '<a href="' . get_permalink() . '">';
-                                       } else {
-                                               if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) )
-                                                       $output .= '<a href="' . get_permalink() . '&amp;page=' . $i . '">';
-                                               else
-                                                       $output .= '<a href="' . trailingslashit(get_permalink()) . user_trailingslashit($i, 'single_paged') . '">';
-                                       }
+                                       $output .= _wp_link_page($i);
                                }
                                }
-                               $output .= $j;
+                               $output .= $link_before . $j . $link_after;
                                if ( ($i != $page) || ((!$more) && ($page==1)) )
                                        $output .= '</a>';
                        }
                                if ( ($i != $page) || ((!$more) && ($page==1)) )
                                        $output .= '</a>';
                        }
@@ -200,25 +660,13 @@ function wp_link_pages($args = '') {
                                $output .= $before;
                                $i = $page - 1;
                                if ( $i && $more ) {
                                $output .= $before;
                                $i = $page - 1;
                                if ( $i && $more ) {
-                                       if ( 1 == $i ) {
-                                               $output .= '<a href="' . get_permalink() . '">' . $previouspagelink . '</a>';
-                                       } else {
-                                               if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) )
-                                                       $output .= '<a href="' . get_permalink() . '&amp;page=' . $i . '">' . $previouspagelink . '</a>';
-                                               else
-                                                       $output .= '<a href="' . trailingslashit(get_permalink()) . user_trailingslashit($i, 'single_paged') . '">' . $previouspagelink . '</a>';
-                                       }
+                                       $output .= _wp_link_page($i);
+                                       $output .= $link_before. $previouspagelink . $link_after . '</a>';
                                }
                                $i = $page + 1;
                                if ( $i <= $numpages && $more ) {
                                }
                                $i = $page + 1;
                                if ( $i <= $numpages && $more ) {
-                                       if ( 1 == $i ) {
-                                               $output .= '<a href="' . get_permalink() . '">' . $nextpagelink . '</a>';
-                                       } else {
-                                               if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) )
-                                                       $output .= '<a href="' . get_permalink() . '&amp;page=' . $i . '">' . $nextpagelink . '</a>';
-                                               else
-                                                       $output .= '<a href="' . trailingslashit(get_permalink()) . user_trailingslashit($i, 'single_paged') . '">' . $nextpagelink . '</a>';
-                                       }
+                                       $output .= _wp_link_page($i);
+                                       $output .= $link_before. $nextpagelink . $link_after . '</a>';
                                }
                                $output .= $after;
                        }
                                }
                                $output .= $after;
                        }
@@ -231,31 +679,69 @@ function wp_link_pages($args = '') {
        return $output;
 }
 
        return $output;
 }
 
+/**
+ * Helper function for wp_link_pages().
+ *
+ * @since 3.1.0
+ * @access private
+ *
+ * @param int $i Page number.
+ * @return string Link.
+ */
+function _wp_link_page( $i ) {
+       global $wp_rewrite;
+       $post = get_post();
+
+       if ( 1 == $i ) {
+               $url = get_permalink();
+       } else {
+               if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) )
+                       $url = add_query_arg( 'page', $i, get_permalink() );
+               elseif ( 'page' == get_option('show_on_front') && get_option('page_on_front') == $post->ID )
+                       $url = trailingslashit(get_permalink()) . user_trailingslashit("$wp_rewrite->pagination_base/" . $i, 'single_paged');
+               else
+                       $url = trailingslashit(get_permalink()) . user_trailingslashit($i, 'single_paged');
+       }
+
+       return '<a href="' . esc_url( $url ) . '">';
+}
 
 //
 // Post-meta: Custom per-post fields.
 //
 
 
 //
 // Post-meta: Custom per-post fields.
 //
 
-
+/**
+ * Retrieve post custom meta data field.
+ *
+ * @since 1.5.0
+ *
+ * @param string $key Meta data key name.
+ * @return bool|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist.
+ */
 function post_custom( $key = '' ) {
        $custom = get_post_custom();
 
 function post_custom( $key = '' ) {
        $custom = get_post_custom();
 
-       if ( 1 == count($custom[$key]) )
+       if ( !isset( $custom[$key] ) )
+               return false;
+       elseif ( 1 == count($custom[$key]) )
                return $custom[$key][0];
        else
                return $custom[$key];
 }
 
                return $custom[$key][0];
        else
                return $custom[$key];
 }
 
-
-// this will probably change at some point...
+/**
+ * Display list of post custom fields.
+ *
+ * @internal This will probably change at some point...
+ * @since 1.2.0
+ * @uses apply_filters() Calls 'the_meta_key' on list item HTML content, with key and value as separate parameters.
+ */
 function the_meta() {
 function the_meta() {
-       global $id;
-
        if ( $keys = get_post_custom_keys() ) {
                echo "<ul class='post-meta'>\n";
        if ( $keys = get_post_custom_keys() ) {
                echo "<ul class='post-meta'>\n";
-               foreach ( $keys as $key ) {
+               foreach ( (array) $keys as $key ) {
                        $keyt = trim($key);
                        $keyt = trim($key);
-                       if ( '_' == $keyt{0} )
+                       if ( is_protected_meta( $keyt, 'post' ) )
                                continue;
                        $values = array_map('trim', get_post_custom_values($key));
                        $value = implode($values,', ');
                                continue;
                        $values = array_map('trim', get_post_custom_values($key));
                        $value = implode($values,', ');
@@ -265,16 +751,25 @@ function the_meta() {
        }
 }
 
        }
 }
 
-
 //
 // Pages
 //
 
 //
 // Pages
 //
 
+/**
+ * Retrieve or display list of pages as a dropdown (select list).
+ *
+ * @since 2.1.0
+ *
+ * @param array|string $args Optional. Override default arguments.
+ * @return string HTML content, if not displaying.
+ */
 function wp_dropdown_pages($args = '') {
        $defaults = array(
                'depth' => 0, 'child_of' => 0,
                'selected' => 0, 'echo' => 1,
 function wp_dropdown_pages($args = '') {
        $defaults = array(
                'depth' => 0, 'child_of' => 0,
                'selected' => 0, 'echo' => 1,
-               'name' => 'page_id', 'show_option_none' => ''
+               'name' => 'page_id', 'id' => '',
+               'show_option_none' => '', 'show_option_no_change' => '',
+               'option_none_value' => ''
        );
 
        $r = wp_parse_args( $args, $defaults );
        );
 
        $r = wp_parse_args( $args, $defaults );
@@ -282,11 +777,16 @@ function wp_dropdown_pages($args = '') {
 
        $pages = get_pages($r);
        $output = '';
 
        $pages = get_pages($r);
        $output = '';
+       // Back-compat with old system where both id and name were based on $name argument
+       if ( empty($id) )
+               $id = $name;
 
        if ( ! empty($pages) ) {
 
        if ( ! empty($pages) ) {
-               $output = "<select name='$name'>\n";
+               $output = "<select name='" . esc_attr( $name ) . "' id='" . esc_attr( $id ) . "'>\n";
+               if ( $show_option_no_change )
+                       $output .= "\t<option value=\"-1\">$show_option_no_change</option>";
                if ( $show_option_none )
                if ( $show_option_none )
-                       $output .= "\t<option value=''>$show_option_none</option>\n";
+                       $output .= "\t<option value=\"" . esc_attr($option_none_value) . "\">$show_option_none</option>\n";
                $output .= walk_page_dropdown_tree($pages, $depth, $r);
                $output .= "</select>\n";
        }
                $output .= walk_page_dropdown_tree($pages, $depth, $r);
                $output .= "</select>\n";
        }
@@ -299,13 +799,22 @@ function wp_dropdown_pages($args = '') {
        return $output;
 }
 
        return $output;
 }
 
+/**
+ * Retrieve or display list of pages in list (li) format.
+ *
+ * @since 1.5.0
+ *
+ * @param array|string $args Optional. Override default arguments.
+ * @return string HTML content, if not displaying.
+ */
 function wp_list_pages($args = '') {
        $defaults = array(
                'depth' => 0, 'show_date' => '',
                'date_format' => get_option('date_format'),
                'child_of' => 0, 'exclude' => '',
                'title_li' => __('Pages'), 'echo' => 1,
 function wp_list_pages($args = '') {
        $defaults = array(
                'depth' => 0, 'show_date' => '',
                'date_format' => get_option('date_format'),
                'child_of' => 0, 'exclude' => '',
                'title_li' => __('Pages'), 'echo' => 1,
-               'authors' => '', 'sort_column' => 'menu_order, post_title'
+               'authors' => '', 'sort_column' => 'menu_order, post_title',
+               'link_before' => '', 'link_after' => '', 'walker' => '',
        );
 
        $r = wp_parse_args( $args, $defaults );
        );
 
        $r = wp_parse_args( $args, $defaults );
@@ -315,12 +824,14 @@ function wp_list_pages($args = '') {
        $current_page = 0;
 
        // sanitize, mostly to keep spaces out
        $current_page = 0;
 
        // sanitize, mostly to keep spaces out
-       $r['exclude'] = preg_replace('[^0-9,]', '', $r['exclude']);
+       $r['exclude'] = preg_replace('/[^0-9,]/', '', $r['exclude']);
 
 
-       // Allow plugins to filter an array of excluded pages
-       $r['exclude'] = implode(',', apply_filters('wp_list_pages_excludes', explode(',', $r['exclude'])));
+       // Allow plugins to filter an array of excluded pages (but don't put a nullstring into the array)
+       $exclude_array = ( $r['exclude'] ) ? explode(',', $r['exclude']) : array();
+       $r['exclude'] = implode( ',', apply_filters('wp_list_pages_excludes', $exclude_array) );
 
        // Query pages.
 
        // Query pages.
+       $r['hierarchical'] = 0;
        $pages = get_pages($r);
 
        if ( !empty($pages) ) {
        $pages = get_pages($r);
 
        if ( !empty($pages) ) {
@@ -328,7 +839,7 @@ function wp_list_pages($args = '') {
                        $output .= '<li class="pagenav">' . $r['title_li'] . '<ul>';
 
                global $wp_query;
                        $output .= '<li class="pagenav">' . $r['title_li'] . '<ul>';
 
                global $wp_query;
-               if ( is_page() )
+               if ( is_page() || is_attachment() || $wp_query->is_posts_page )
                        $current_page = $wp_query->get_queried_object_id();
                $output .= walk_page_tree($pages, $r['depth'], $current_page, $r);
 
                        $current_page = $wp_query->get_queried_object_id();
                $output .= walk_page_tree($pages, $r['depth'], $current_page, $r);
 
@@ -336,7 +847,7 @@ function wp_list_pages($args = '') {
                        $output .= '</ul></li>';
        }
 
                        $output .= '</ul></li>';
        }
 
-       $output = apply_filters('wp_list_pages', $output);
+       $output = apply_filters('wp_list_pages', $output, $r);
 
        if ( $r['echo'] )
                echo $output;
 
        if ( $r['echo'] )
                echo $output;
@@ -344,151 +855,606 @@ function wp_list_pages($args = '') {
                return $output;
 }
 
                return $output;
 }
 
+/**
+ * Display or retrieve list of pages with optional home link.
+ *
+ * The arguments are listed below and part of the arguments are for {@link
+ * wp_list_pages()} function. Check that function for more info on those
+ * arguments.
+ *
+ * <ul>
+ * <li><strong>sort_column</strong> - How to sort the list of pages. Defaults
+ * to page title. Use column for posts table.</li>
+ * <li><strong>menu_class</strong> - Class to use for the div ID which contains
+ * the page list. Defaults to 'menu'.</li>
+ * <li><strong>echo</strong> - Whether to echo list or return it. Defaults to
+ * echo.</li>
+ * <li><strong>link_before</strong> - Text before show_home argument text.</li>
+ * <li><strong>link_after</strong> - Text after show_home argument text.</li>
+ * <li><strong>show_home</strong> - If you set this argument, then it will
+ * display the link to the home page. The show_home argument really just needs
+ * to be set to the value of the text of the link.</li>
+ * </ul>
+ *
+ * @since 2.7.0
+ *
+ * @param array|string $args
+ * @return string html menu
+ */
+function wp_page_menu( $args = array() ) {
+       $defaults = array('sort_column' => 'menu_order, post_title', 'menu_class' => 'menu', 'echo' => true, 'link_before' => '', 'link_after' => '');
+       $args = wp_parse_args( $args, $defaults );
+       $args = apply_filters( 'wp_page_menu_args', $args );
+
+       $menu = '';
+
+       $list_args = $args;
+
+       // Show Home in the menu
+       if ( ! empty($args['show_home']) ) {
+               if ( true === $args['show_home'] || '1' === $args['show_home'] || 1 === $args['show_home'] )
+                       $text = __('Home');
+               else
+                       $text = $args['show_home'];
+               $class = '';
+               if ( is_front_page() && !is_paged() )
+                       $class = 'class="current_page_item"';
+               $menu .= '<li ' . $class . '><a href="' . home_url( '/' ) . '" title="' . esc_attr($text) . '">' . $args['link_before'] . $text . $args['link_after'] . '</a></li>';
+               // If the front page is a page, add it to the exclude list
+               if (get_option('show_on_front') == 'page') {
+                       if ( !empty( $list_args['exclude'] ) ) {
+                               $list_args['exclude'] .= ',';
+                       } else {
+                               $list_args['exclude'] = '';
+                       }
+                       $list_args['exclude'] .= get_option('page_on_front');
+               }
+       }
+
+       $list_args['echo'] = false;
+       $list_args['title_li'] = '';
+       $menu .= str_replace( array( "\r", "\n", "\t" ), '', wp_list_pages($list_args) );
+
+       if ( $menu )
+               $menu = '<ul>' . $menu . '</ul>';
+
+       $menu = '<div class="' . esc_attr($args['menu_class']) . '">' . $menu . "</div>\n";
+       $menu = apply_filters( 'wp_page_menu', $menu, $args );
+       if ( $args['echo'] )
+               echo $menu;
+       else
+               return $menu;
+}
+
 //
 // Page helpers
 //
 
 //
 // Page helpers
 //
 
-function walk_page_tree() {
-       $walker = new Walker_Page;
-       $args = func_get_args();
-       return call_user_func_array(array(&$walker, 'walk'), $args);
+/**
+ * Retrieve HTML list content for page list.
+ *
+ * @uses Walker_Page to create HTML list content.
+ * @since 2.1.0
+ * @see Walker_Page::walk() for parameters and return description.
+ */
+function walk_page_tree($pages, $depth, $current_page, $r) {
+       if ( empty($r['walker']) )
+               $walker = new Walker_Page;
+       else
+               $walker = $r['walker'];
+
+       $args = array($pages, $depth, $r, $current_page);
+       return call_user_func_array(array($walker, 'walk'), $args);
 }
 
 }
 
+/**
+ * Retrieve HTML dropdown (select) content for page list.
+ *
+ * @uses Walker_PageDropdown to create HTML dropdown content.
+ * @since 2.1.0
+ * @see Walker_PageDropdown::walk() for parameters and return description.
+ */
 function walk_page_dropdown_tree() {
 function walk_page_dropdown_tree() {
-       $walker = new Walker_PageDropdown;
        $args = func_get_args();
        $args = func_get_args();
-       return call_user_func_array(array(&$walker, 'walk'), $args);
+       if ( empty($args[2]['walker']) ) // the user's options are the third parameter
+               $walker = new Walker_PageDropdown;
+       else
+               $walker = $args[2]['walker'];
+
+       return call_user_func_array(array($walker, 'walk'), $args);
+}
+
+/**
+ * Create HTML list of pages.
+ *
+ * @package WordPress
+ * @since 2.1.0
+ * @uses Walker
+ */
+class Walker_Page extends Walker {
+       /**
+        * @see Walker::$tree_type
+        * @since 2.1.0
+        * @var string
+        */
+       var $tree_type = 'page';
+
+       /**
+        * @see Walker::$db_fields
+        * @since 2.1.0
+        * @todo Decouple this.
+        * @var array
+        */
+       var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
+
+       /**
+        * @see Walker::start_lvl()
+        * @since 2.1.0
+        *
+        * @param string $output Passed by reference. Used to append additional content.
+        * @param int $depth Depth of page. Used for padding.
+        * @param array $args
+        */
+       function start_lvl( &$output, $depth = 0, $args = array() ) {
+               $indent = str_repeat("\t", $depth);
+               $output .= "\n$indent<ul class='children'>\n";
+       }
+
+       /**
+        * @see Walker::end_lvl()
+        * @since 2.1.0
+        *
+        * @param string $output Passed by reference. Used to append additional content.
+        * @param int $depth Depth of page. Used for padding.
+        * @param array $args
+        */
+       function end_lvl( &$output, $depth = 0, $args = array() ) {
+               $indent = str_repeat("\t", $depth);
+               $output .= "$indent</ul>\n";
+       }
+
+       /**
+        * @see Walker::start_el()
+        * @since 2.1.0
+        *
+        * @param string $output Passed by reference. Used to append additional content.
+        * @param object $page Page data object.
+        * @param int $depth Depth of page. Used for padding.
+        * @param int $current_page Page ID.
+        * @param array $args
+        */
+       function start_el( &$output, $page, $depth, $args, $current_page = 0 ) {
+               if ( $depth )
+                       $indent = str_repeat("\t", $depth);
+               else
+                       $indent = '';
+
+               extract($args, EXTR_SKIP);
+               $css_class = array('page_item', 'page-item-'.$page->ID);
+               if ( !empty($current_page) ) {
+                       $_current_page = get_post( $current_page );
+                       if ( in_array( $page->ID, $_current_page->ancestors ) )
+                               $css_class[] = 'current_page_ancestor';
+                       if ( $page->ID == $current_page )
+                               $css_class[] = 'current_page_item';
+                       elseif ( $_current_page && $page->ID == $_current_page->post_parent )
+                               $css_class[] = 'current_page_parent';
+               } elseif ( $page->ID == get_option('page_for_posts') ) {
+                       $css_class[] = 'current_page_parent';
+               }
+
+               $css_class = implode( ' ', apply_filters( 'page_css_class', $css_class, $page, $depth, $args, $current_page ) );
+
+               $output .= $indent . '<li class="' . $css_class . '"><a href="' . get_permalink($page->ID) . '">' . $link_before . apply_filters( 'the_title', $page->post_title, $page->ID ) . $link_after . '</a>';
+
+               if ( !empty($show_date) ) {
+                       if ( 'modified' == $show_date )
+                               $time = $page->post_modified;
+                       else
+                               $time = $page->post_date;
+
+                       $output .= " " . mysql2date($date_format, $time);
+               }
+       }
+
+       /**
+        * @see Walker::end_el()
+        * @since 2.1.0
+        *
+        * @param string $output Passed by reference. Used to append additional content.
+        * @param object $page Page data object. Not used.
+        * @param int $depth Depth of page. Not Used.
+        * @param array $args
+        */
+       function end_el( &$output, $page, $depth = 0, $args = array() ) {
+               $output .= "</li>\n";
+       }
+
+}
+
+/**
+ * Create HTML dropdown list of pages.
+ *
+ * @package WordPress
+ * @since 2.1.0
+ * @uses Walker
+ */
+class Walker_PageDropdown extends Walker {
+       /**
+        * @see Walker::$tree_type
+        * @since 2.1.0
+        * @var string
+        */
+       var $tree_type = 'page';
+
+       /**
+        * @see Walker::$db_fields
+        * @since 2.1.0
+        * @todo Decouple this
+        * @var array
+        */
+       var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
+
+       /**
+        * @see Walker::start_el()
+        * @since 2.1.0
+        *
+        * @param string $output Passed by reference. Used to append additional content.
+        * @param object $page Page data object.
+        * @param int $depth Depth of page in reference to parent pages. Used for padding.
+        * @param array $args Uses 'selected' argument for selected page to set selected HTML attribute for option element.
+        * @param int $id
+        */
+       function start_el(&$output, $page, $depth, $args, $id = 0) {
+               $pad = str_repeat('&nbsp;', $depth * 3);
+
+               $output .= "\t<option class=\"level-$depth\" value=\"$page->ID\"";
+               if ( $page->ID == $args['selected'] )
+                       $output .= ' selected="selected"';
+               $output .= '>';
+               $title = apply_filters( 'list_pages', $page->post_title, $page );
+               $output .= $pad . esc_html( $title );
+               $output .= "</option>\n";
+       }
 }
 
 //
 // Attachments
 //
 
 }
 
 //
 // Attachments
 //
 
-function the_attachment_link($id = 0, $fullsize = false, $max_dims = false) {
-       echo get_the_attachment_link($id, $fullsize, $max_dims);
+/**
+ * Display an attachment page link using an image or icon.
+ *
+ * @since 2.0.0
+ *
+ * @param int $id Optional. Post ID.
+ * @param bool $fullsize Optional, default is false. Whether to use full size.
+ * @param bool $deprecated Deprecated. Not used.
+ * @param bool $permalink Optional, default is false. Whether to include permalink.
+ */
+function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
+       if ( !empty( $deprecated ) )
+               _deprecated_argument( __FUNCTION__, '2.5' );
+
+       if ( $fullsize )
+               echo wp_get_attachment_link($id, 'full', $permalink);
+       else
+               echo wp_get_attachment_link($id, 'thumbnail', $permalink);
 }
 
 }
 
-function get_the_attachment_link($id = 0, $fullsize = false, $max_dims = false) {
-       $id = (int) $id;
-       $_post = & get_post($id);
-
-       if ( ('attachment' != $_post->post_type) || !$url = wp_get_attachment_url($_post->ID) )
-               return __('Missing Attachment');
+/**
+ * Retrieve an attachment page link using an image or icon, if possible.
+ *
+ * @since 2.5.0
+ * @uses apply_filters() Calls 'wp_get_attachment_link' filter on HTML content with same parameters as function.
+ *
+ * @param int $id Optional. Post ID.
+ * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string.
+ * @param bool $permalink Optional, default is false. Whether to add permalink to image.
+ * @param bool $icon Optional, default is false. Whether to include icon.
+ * @param string|bool $text Optional, default is false. If string, then will be link text.
+ * @return string HTML content.
+ */
+function wp_get_attachment_link( $id = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false ) {
+       $id = intval( $id );
+       $_post = get_post( $id );
+
+       if ( empty( $_post ) || ( 'attachment' != $_post->post_type ) || ! $url = wp_get_attachment_url( $_post->ID ) )
+               return __( 'Missing Attachment' );
+
+       if ( $permalink )
+               $url = get_attachment_link( $_post->ID );
+
+       $post_title = esc_attr( $_post->post_title );
+
+       if ( $text )
+               $link_text = $text;
+       elseif ( $size && 'none' != $size )
+               $link_text = wp_get_attachment_image( $id, $size, $icon );
+       else
+               $link_text = '';
 
 
-       $post_title = attribute_escape($_post->post_title);
+       if ( trim( $link_text ) == '' )
+               $link_text = $_post->post_title;
 
 
-       $innerHTML = get_attachment_innerHTML($_post->ID, $fullsize, $max_dims);
-       return "<a href='$url' title='$post_title'>$innerHTML</a>";
+       return apply_filters( 'wp_get_attachment_link', "<a href='$url' title='$post_title'>$link_text</a>", $id, $size, $permalink, $icon, $text );
 }
 
 }
 
-function get_attachment_icon_src( $id = 0, $fullsize = false ) {
-       $id = (int) $id;
-       if ( !$post = & get_post($id) )
-               return false;
-
-       $imagedata = wp_get_attachment_metadata( $post->ID );
+/**
+ * Wrap attachment in <<p>> element before content.
+ *
+ * @since 2.0.0
+ * @uses apply_filters() Calls 'prepend_attachment' hook on HTML content.
+ *
+ * @param string $content
+ * @return string
+ */
+function prepend_attachment($content) {
+       $post = get_post();
 
 
-       $file = get_attached_file( $post->ID );
+       if ( empty($post->post_type) || $post->post_type != 'attachment' )
+               return $content;
 
 
-       if ( !$fullsize && $thumbfile = wp_get_attachment_thumb_file( $post->ID ) ) {
-               // We have a thumbnail desired, specified and existing
+       $p = '<p class="attachment">';
+       // show the medium sized image representation of the attachment if available, and link to the raw file
+       $p .= wp_get_attachment_link(0, 'medium', false);
+       $p .= '</p>';
+       $p = apply_filters('prepend_attachment', $p);
 
 
-               $src = wp_get_attachment_thumb_url( $post->ID );
-               $src_file = $thumbfile;
-               $class = 'attachmentthumb';
-       } elseif ( wp_attachment_is_image( $post->ID ) ) {
-               // We have an image without a thumbnail
+       return "$p\n$content";
+}
 
 
-               $src = wp_get_attachment_url( $post->ID );
-               $src_file = & $file;
-               $class = 'attachmentimage';
-       } elseif ( $src = wp_mime_type_icon( $post->ID ) ) {
-               // No thumb, no image. We'll look for a mime-related icon instead.
+//
+// Misc
+//
 
 
-               $icon_dir = apply_filters( 'icon_dir', get_template_directory() . '/images' );
-               $src_file = $icon_dir . '/' . basename($src);
-       }
+/**
+ * Retrieve protected post password form content.
+ *
+ * @since 1.0.0
+ * @uses apply_filters() Calls 'the_password_form' filter on output.
+ *
+ * @return string HTML content for password form for password protected post.
+ */
+function get_the_password_form() {
+       $post = get_post();
+       $label = 'pwbox-' . ( empty($post->ID) ? rand() : $post->ID );
+       $output = '<form action="' . esc_url( site_url( 'wp-login.php?action=postpass', 'login_post' ) ) . '" method="post">
+       <p>' . __("This post is password protected. To view it please enter your password below:") . '</p>
+       <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>
+</form>
+       ';
+       return apply_filters('the_password_form', $output);
+}
 
 
-       if ( !isset($src) || !$src )
+/**
+ * Whether currently in a page template.
+ *
+ * This template tag allows you to determine if you are in a page template.
+ * You can optionally provide a template name and then the check will be
+ * specific to that template.
+ *
+ * @since 2.5.0
+ * @uses $wp_query
+ *
+ * @param string $template The specific template name if specific matching is required.
+ * @return bool False on failure, true if success.
+ */
+function is_page_template( $template = '' ) {
+       if ( ! is_page() )
                return false;
 
                return false;
 
-       return array($src, $src_file);
+       $page_template = get_page_template_slug( get_queried_object_id() );
+
+       if ( empty( $template ) )
+               return (bool) $page_template;
+
+       if ( $template == $page_template )
+               return true;
+
+       if ( 'default' == $template && ! $page_template )
+               return true;
+
+       return false;
 }
 
 }
 
-function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) {
-       $id = (int) $id;
-       if ( !$post = & get_post($id) )
+/**
+ * Get the specific template name for a page.
+ *
+ * @since 3.4.0
+ *
+ * @param int $post_id The page ID to check. Defaults to the current post, when used in the loop.
+ * @return string|bool Page template filename. Returns an empty string when the default page template
+ *     is in use. Returns false if the post is not a page.
+ */
+function get_page_template_slug( $post_id = null ) {
+       $post = get_post( $post_id );
+       if ( 'page' != $post->post_type )
                return false;
                return false;
+       $template = get_post_meta( $post->ID, '_wp_page_template', true );
+       if ( ! $template || 'default' == $template )
+               return '';
+       return $template;
+}
 
 
-       if ( !$src = get_attachment_icon_src( $post->ID, $fullsize ) )
+/**
+ * Retrieve formatted date timestamp of a revision (linked to that revisions's page).
+ *
+ * @package WordPress
+ * @subpackage Post_Revisions
+ * @since 2.6.0
+ *
+ * @uses date_i18n()
+ *
+ * @param int|object $revision Revision ID or revision object.
+ * @param bool $link Optional, default is true. Link to revisions's page?
+ * @return string i18n formatted datetimestamp or localized 'Current Revision'.
+ */
+function wp_post_revision_title( $revision, $link = true ) {
+       if ( !$revision = get_post( $revision ) )
+               return $revision;
+
+       if ( !in_array( $revision->post_type, array( 'post', 'page', 'revision' ) ) )
                return false;
 
                return false;
 
-       list($src, $src_file) = $src;
+       /* translators: revision date format, see http://php.net/date */
+       $datef = _x( 'j F, Y @ G:i', 'revision date format');
+       /* translators: 1: date */
+       $autosavef = __( '%1$s [Autosave]' );
+       /* translators: 1: date */
+       $currentf  = __( '%1$s [Current Revision]' );
 
 
-       // Do we need to constrain the image?
-       if ( ($max_dims = apply_filters('attachment_max_dims', $max_dims)) && file_exists($src_file) ) {
+       $date = date_i18n( $datef, strtotime( $revision->post_modified ) );
+       if ( $link && current_user_can( 'edit_post', $revision->ID ) && $link = get_edit_post_link( $revision->ID ) )
+               $date = "<a href='$link'>$date</a>";
 
 
-               $imagesize = getimagesize($src_file);
+       if ( !wp_is_post_revision( $revision ) )
+               $date = sprintf( $currentf, $date );
+       elseif ( wp_is_post_autosave( $revision ) )
+               $date = sprintf( $autosavef, $date );
 
 
-               if (($imagesize[0] > $max_dims[0]) || $imagesize[1] > $max_dims[1] ) {
-                       $actual_aspect = $imagesize[0] / $imagesize[1];
-                       $desired_aspect = $max_dims[0] / $max_dims[1];
+       return $date;
+}
 
 
-                       if ( $actual_aspect >= $desired_aspect ) {
-                               $height = $actual_aspect * $max_dims[0];
-                               $constraint = "width='{$max_dims[0]}' ";
-                               $post->iconsize = array($max_dims[0], $height);
-                       } else {
-                               $width = $max_dims[1] / $actual_aspect;
-                               $constraint = "height='{$max_dims[1]}' ";
-                               $post->iconsize = array($width, $max_dims[1]);
-                       }
+/**
+ * Display list of a post's revisions.
+ *
+ * Can output either a UL with edit links or a TABLE with diff interface, and
+ * restore action links.
+ *
+ * Second argument controls parameters:
+ *   (bool)   parent : include the parent (the "Current Revision") in the list.
+ *   (string) format : 'list' or 'form-table'. 'list' outputs UL, 'form-table'
+ *                     outputs TABLE with UI.
+ *   (int)    right  : what revision is currently being viewed - used in
+ *                     form-table format.
+ *   (int)    left   : what revision is currently being diffed against right -
+ *                     used in form-table format.
+ *
+ * @package WordPress
+ * @subpackage Post_Revisions
+ * @since 2.6.0
+ *
+ * @uses wp_get_post_revisions()
+ * @uses wp_post_revision_title()
+ * @uses get_edit_post_link()
+ * @uses get_the_author_meta()
+ *
+ * @todo split into two functions (list, form-table) ?
+ *
+ * @param int|object $post_id Post ID or post object.
+ * @param string|array $args See description {@link wp_parse_args()}.
+ * @return null
+ */
+function wp_list_post_revisions( $post_id = 0, $args = null ) {
+       if ( !$post = get_post( $post_id ) )
+               return;
+
+       $defaults = array( 'parent' => false, 'right' => false, 'left' => false, 'format' => 'list', 'type' => 'all' );
+       extract( wp_parse_args( $args, $defaults ), EXTR_SKIP );
+
+       switch ( $type ) {
+               case 'autosave' :
+                       if ( !$autosave = wp_get_post_autosave( $post->ID ) )
+                               return;
+                       $revisions = array( $autosave );
+                       break;
+               case 'revision' : // just revisions - remove autosave later
+               case 'all' :
+               default :
+                       if ( !$revisions = wp_get_post_revisions( $post->ID ) )
+                               return;
+                       break;
+       }
+
+       /* translators: post revision: 1: when, 2: author name */
+       $titlef = _x( '%1$s by %2$s', 'post revision' );
+
+       if ( $parent )
+               array_unshift( $revisions, $post );
+
+       $rows = $right_checked = '';
+       $class = false;
+       $can_edit_post = current_user_can( 'edit_post', $post->ID );
+       foreach ( $revisions as $revision ) {
+               if ( !current_user_can( 'read_post', $revision->ID ) )
+                       continue;
+               if ( 'revision' === $type && wp_is_post_autosave( $revision ) )
+                       continue;
+
+               $date = wp_post_revision_title( $revision );
+               $name = get_the_author_meta( 'display_name', $revision->post_author );
+
+               if ( 'form-table' == $format ) {
+                       if ( $left )
+                               $left_checked = $left == $revision->ID ? ' checked="checked"' : '';
+                       else
+                               $left_checked = $right_checked ? ' checked="checked"' : ''; // [sic] (the next one)
+                       $right_checked = $right == $revision->ID ? ' checked="checked"' : '';
+
+                       $class = $class ? '' : " class='alternate'";
+
+                       if ( $post->ID != $revision->ID && $can_edit_post )
+                               $actions = '<a href="' . wp_nonce_url( add_query_arg( array( 'revision' => $revision->ID, 'action' => 'restore' ) ), "restore-post_$post->ID|$revision->ID" ) . '">' . __( 'Restore' ) . '</a>';
+                       else
+                               $actions = '';
+
+                       $rows .= "<tr$class>\n";
+                       $rows .= "\t<th style='white-space: nowrap' scope='row'><input type='radio' name='left' value='$revision->ID'$left_checked /></th>\n";
+                       $rows .= "\t<th style='white-space: nowrap' scope='row'><input type='radio' name='right' value='$revision->ID'$right_checked /></th>\n";
+                       $rows .= "\t<td>$date</td>\n";
+                       $rows .= "\t<td>$name</td>\n";
+                       $rows .= "\t<td class='action-links'>$actions</td>\n";
+                       $rows .= "</tr>\n";
                } else {
                } else {
-                       $post->iconsize = array($imagesize[0], $imagesize[1]);
+                       $title = sprintf( $titlef, $date, $name );
+                       $rows .= "\t<li>$title</li>\n";
                }
        }
 
                }
        }
 
-       $post_title = attribute_escape($post->post_title);
-
-       $icon = "<img src='$src' title='$post_title' alt='$post_title' $constraint/>";
+       if ( 'form-table' == $format ) : ?>
 
 
-       return apply_filters( 'attachment_icon', $icon, $post->ID );
-}
+<form action="revision.php" method="get">
 
 
-function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) {
-       $id = (int) $id;
-       if ( !$post = & get_post($id) )
-               return false;
+<div class="tablenav">
+       <div class="alignleft">
+               <input type="submit" class="button-secondary" value="<?php esc_attr_e( 'Compare Revisions' ); ?>" />
+               <input type="hidden" name="action" value="diff" />
+               <input type="hidden" name="post_type" value="<?php echo esc_attr($post->post_type); ?>" />
+       </div>
+</div>
 
 
-       if ( $innerHTML = get_attachment_icon($post->ID, $fullsize, $max_dims))
-               return $innerHTML;
+<br class="clear" />
 
 
+<table class="widefat post-revisions" cellspacing="0" id="post-revisions">
+       <col />
+       <col />
+       <col style="width: 33%" />
+       <col style="width: 33%" />
+       <col style="width: 33%" />
+<thead>
+<tr>
+       <th scope="col"><?php /* translators: column name in revisions */ _ex( 'Old', 'revisions column name' ); ?></th>
+       <th scope="col"><?php /* translators: column name in revisions */ _ex( 'New', 'revisions column name' ); ?></th>
+       <th scope="col"><?php /* translators: column name in revisions */ _ex( 'Date Created', 'revisions column name' ); ?></th>
+       <th scope="col"><?php _e( 'Author' ); ?></th>
+       <th scope="col" class="action-links"><?php _e( 'Actions' ); ?></th>
+</tr>
+</thead>
+<tbody>
 
 
-       $innerHTML = attribute_escape($post->post_title);
+<?php echo $rows; ?>
 
 
-       return apply_filters('attachment_innerHTML', $innerHTML, $post->ID);
-}
-
-function prepend_attachment($content) {
-       $p = '<p class="attachment">';
-       $p .= get_the_attachment_link(false, true, array(400, 300));
-       $p .= '</p>';
-       $p = apply_filters('prepend_attachment', $p);
+</tbody>
+</table>
 
 
-       return "$p\n$content";
-}
+</form>
 
 
-//
-// Misc
-//
+<?php
+       else :
+               echo "<ul class='post-revisions'>\n";
+               echo $rows;
+               echo "</ul>";
+       endif;
 
 
-function get_the_password_form() {
-       $output = '<form action="' . get_option('siteurl') . '/wp-pass.php" method="post">
-       <p>' . __("This post is password protected. To view it please enter your password below:") . '</p>
-       <p><label>' . __("Password:") . ' <input name="post_password" type="password" size="20" /></label> <input type="submit" name="Submit" value="' . __("Submit") . '" /></p>
-       </form>
-       ';
-       return $output;
 }
 }
-
-?>