WordPress 4.1.4-scripts
[autoinstalls/wordpress.git] / wp-includes / post-thumbnail-template.php
index 38ae9039a9c89baaa40bf5f80b0eef0503449690..91201e79944069ea89b716cee9561c70493c94dd 100644 (file)
@@ -18,7 +18,6 @@
  * @return bool Whether post has an image attached.
  */
 function has_post_thumbnail( $post_id = null ) {
-       $post_id = ( null === $post_id ) ? get_the_ID() : $post_id;
        return (bool) get_post_thumbnail_id( $post_id );
 }
 
@@ -40,7 +39,7 @@ function get_post_thumbnail_id( $post_id = null ) {
  *
  * @since 2.9.0
  *
- * @param int $size Optional. Image size.  Defaults to 'post-thumbnail', which theme sets using set_post_thumbnail_size( $width, $height, $crop_flag );.
+ * @param string|array $size Optional. Image size. Defaults to 'post-thumbnail', which theme sets using set_post_thumbnail_size( $width, $height, $crop_flag );.
  * @param string|array $attr Optional. Query string or array of attributes.
  */
 function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) {
@@ -50,10 +49,13 @@ function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) {
 /**
  * Update cache for thumbnails in the current loop
  *
- * @sicne 3.2
+ * @since 3.2.0
+ *
+ * @param object $wp_query Optional. A WP_Query instance. Defaults to the $wp_query global.
  */
-function update_post_thumbnail_cache() {
-       global $wp_query;
+function update_post_thumbnail_cache( $wp_query = null ) {
+       if ( ! $wp_query )
+               $wp_query = $GLOBALS['wp_query'];
 
        if ( $wp_query->thumbnails_cached )
                return;
@@ -65,13 +67,7 @@ function update_post_thumbnail_cache() {
        }
 
        if ( ! empty ( $thumb_ids ) ) {
-               get_posts( array(
-                               'update_post_term_cache' => false,
-                               'include' => $thumb_ids,
-                               'post_type' => 'attachment',
-                               'post_status' => 'inherit',
-                               'nopaging' => true
-               ) );
+               _prime_post_caches( $thumb_ids, false, true );
        }
 
        $wp_query->thumbnails_cached = true;
@@ -83,23 +79,64 @@ function update_post_thumbnail_cache() {
  * @since 2.9.0
  *
  * @param int $post_id Optional. Post ID.
- * @param string $size Optional. Image size.  Defaults to 'thumbnail'.
+ * @param string $size Optional. Image size. Defaults to 'post-thumbnail'.
  * @param string|array $attr Optional. Query string or array of attributes.
  */
 function get_the_post_thumbnail( $post_id = null, $size = 'post-thumbnail', $attr = '' ) {
        $post_id = ( null === $post_id ) ? get_the_ID() : $post_id;
        $post_thumbnail_id = get_post_thumbnail_id( $post_id );
+
+       /**
+        * Filter the post thumbnail size.
+        *
+        * @since 2.9.0
+        *
+        * @param string $size The post thumbnail size.
+        */
        $size = apply_filters( 'post_thumbnail_size', $size );
+
        if ( $post_thumbnail_id ) {
-               do_action( 'begin_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size ); // for "Just In Time" filtering of all of wp_get_attachment_image()'s filters
+
+               /**
+                * Fires before fetching the post thumbnail HTML.
+                *
+                * Provides "just in time" filtering of all filters in wp_get_attachment_image().
+                *
+                * @since 2.9.0
+                *
+                * @param string $post_id           The post ID.
+                * @param string $post_thumbnail_id The post thumbnail ID.
+                * @param string $size              The post thumbnail size.
+                */
+               do_action( 'begin_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size );
                if ( in_the_loop() )
                        update_post_thumbnail_cache();
                $html = wp_get_attachment_image( $post_thumbnail_id, $size, false, $attr );
+
+               /**
+                * Fires after fetching the post thumbnail HTML.
+                *
+                * @since 2.9.0
+                *
+                * @param string $post_id           The post ID.
+                * @param string $post_thumbnail_id The post thumbnail ID.
+                * @param string $size              The post thumbnail size.
+                */
                do_action( 'end_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size );
+
        } else {
                $html = '';
        }
+       /**
+        * Filter the post thumbnail HTML.
+        *
+        * @since 2.9.0
+        *
+        * @param string $html              The post thumbnail HTML.
+        * @param string $post_id           The post ID.
+        * @param string $post_thumbnail_id The post thumbnail ID.
+        * @param string $size              The post thumbnail size.
+        * @param string $attr              Query string of attributes.
+        */
        return apply_filters( 'post_thumbnail_html', $html, $post_id, $post_thumbnail_id, $size, $attr );
 }
-
-?>