Changeset 8081

Timestamp:

06/14/2008 04:31:08 PM (17 years ago)

Author:

westi

Message:

PHPdoc updates for wp-includes/post.php. See #7038 props jacobsantos.

File:

• trunk/wp-includes/post.php (modified) (2 diffs)

trunk/wp-includes/post.php

@@ -1 +1 @@
 <?php
 /**
- * Post functions and post utility function
+ * Post functions and post utility function.
+ *
+ * Warning: The inline documentation for the functions contained
+ * in this file might be inaccurate, so the documentation is not
+ * authoritative at the moment.
  *
  * @package WordPress
@@ -751 +755 @@
 
 /**
- * wp_count_posts() - Count number of posts with a given type
- *
- * {@internal Missing Long Description}}
+ * Count number of posts of a post type and is permissible.
+ *
+ * This function provides an efficient method of finding the amount
+ * of post's type a blog has. Another method is to count the amount
+ * of items in get_posts(), but that method has a lot of overhead
+ * with doing so. Therefore, when developing for 2.5+, use this
+ * function instead.
+ *
+ * The $perm parameter checks for 'readable' value and if the user
+ * can read private posts, it will display that for the user that
+ * is signed in.
  *
  * @package WordPress
  * @subpackage Post
  * @since 2.5
- *
- * @param string $type Post type
- * @return array Number of posts for each status
+ * @link http://codex.wordpress.org/Template_Tags/wp_count_posts
+ *
+ * @param string $type Optional. Post type to retrieve count
+ * @param string $perm Optional. 'readable' or empty.
+ * @return object Number of posts for each status
  */
 function wp_count_posts( $type = 'post', $perm = '' ) {