Changeset 12320

Timestamp:

12/03/2009 03:59:27 PM (15 years ago)

Author:

ryan

Message:

phpdoc for post thumbnail template functions. Props ramiy. fixes #11310

File:

• trunk/wp-includes/post-image-template.php (modified) (3 diffs)

trunk/wp-includes/post-image-template.php

@@ -10 +10 @@
  */
 
+/**
+ * Check if post has an image attached.
+ * 
+ * @since 2.9.0
+ *
+ * @param int $post_id Optional. Post ID.
+ * @return bool Whether post has an image attached (true) or not (false).
+ */
 function has_post_image( $post_id = NULL ) {
     global $id;
@@ -16 +24 @@
 }
 
+/**
+ * Retrieve Post Image ID.
+ * 
+ * @since 2.9.0
+ *
+ * @param int $post_id Optional. Post ID.
+ * @return int
+ */
 function get_post_image_id( $post_id = NULL ) {
     global $id;
@@ -22 +38 @@
 }
 
+/**
+ * Display Post Image.
+ * 
+ * @since 2.9.0
+ *
+ * @param int $size Optional. Image size.  Defaults to 'thumbnail'.
+ * @param string|array $attr Optional. Query string or array of attributes.
+ */
 function the_post_image( $size = 'thumbnail', $attr = '' ) {
     echo get_the_post_image( NULL, $size, $attr );
 }
 
+/**
+ * Retrieve Post Image.
+ * 
+ * @since 2.9.0
+ *
+ * @param int $post_id Optional. Post ID.
+ * @param string $size Optional. Image size.  Defaults to 'thumbnail'.
+ * @param string|array $attr Optional. Query string or array of attributes.
+  */
 function get_the_post_image( $post_id = NULL, $size = 'thumbnail', $attr = '' ) {
     global $id;