Changeset 15590 for trunk/wp-includes/post.php

Timestamp:

09/07/2010 11:21:11 AM (14 years ago)

Author:

nacin

Message:

Phpdoc argument/@param cleanups. props duck_, see #14783.

File:

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

trunk/wp-includes/post.php

@@ -626 +626 @@
  * @see get_post_statuses
  *
- * @param string $post_type The name of a registered post status
+ * @param string $post_status The name of a registered post status
  * @return object A post status object
  */
@@ -670 +670 @@
  * @see get_post_type_object
  *
- * @param string $post Post type name
+ * @param string $post_type Post type name
  * @return bool Whether post type is hierarchical.
  */
@@ -687 +687 @@
  * @uses get_post_type_object()
  *
- * @param string Post type name
+ * @param string $post_type Post type name
  * @return bool Whether post type is registered.
  */
@@ -1145 +1145 @@
  *
  * @param int $post_id Post ID.
- * @param string $key Metadata name.
- * @param mixed $value Metadata value.
+ * @param string $meta_key Metadata name.
+ * @param mixed $meta_value Metadata value.
  * @param bool $unique Optional, default is false. Whether the same key should not be added.
  * @return bool False for failure. True for success.
@@ -1212 +1212 @@
  *
  * @param int $post_id Post ID.
- * @param string $key Metadata key.
- * @param mixed $value Metadata value.
+ * @param string $meta_key Metadata key.
+ * @param mixed $meta_value Metadata value.
  * @param mixed $prev_value Optional. Previous value to check before removing.
  * @return bool False on failure, true if success.
@@ -1651 +1651 @@
  * @since 2.5.0
  *
- * @param string|array $mime_types List of mime types or comma separated string of mime types.
+ * @param string|array $post_mime_types List of mime types or comma separated string of mime types.
  * @param string $table_alias Optional. Specify a table alias, if needed.
  * @return string The SQL AND clause for mime searching.
@@ -1810 +1810 @@
  * @uses wp_delete_post() if trash is disabled
  *
- * @param int $postid Post ID.
+ * @param int $post_id Post ID.
  * @return mixed False on failure
  */
@@ -1845 +1845 @@
  * @uses do_action() on 'untrashed_post' after undeletion
  *
- * @param int $postid Post ID.
+ * @param int $post_id Post ID.
  * @return mixed False on failure
  */
@@ -2965 +2965 @@
  * @since 2.0.0
  *
- * @param array $posts Posts array.
- * @param int $parent Parent page ID.
+ * @param array $pages Posts array.
+ * @param int $page_id Parent page ID.
  * @return array A list arranged by hierarchy. Children immediately follow their parents.
  */
 function &get_page_hierarchy( &$pages, $page_id = 0 ) {
-
     if ( empty( $pages ) ) {
         $result = array();
@@ -2978 +2977 @@
     $children = array();
     foreach ( (array) $pages as $p ) {
-
         $parent_id = intval( $p->post_parent );
         $children[ $parent_id ][] = $p;
-     }
-
-     $result = array();
-     _page_traverse_name( $page_id, $children, $result );
+    }
+
+    $result = array();
+    _page_traverse_name( $page_id, $children, $result );
 
     return $result;
@@ -2995 +2993 @@
  */
 function _page_traverse_name( $page_id, &$children, &$result ){
-
     if ( isset( $children[ $page_id ] ) ){
-
         foreach( (array)$children[ $page_id ] as $child ) {
-
             $result[ $child->ID ] = $child->post_name;
             _page_traverse_name( $child->ID, $children, $result );
@@ -3278 +3273 @@
  * @param string|array $object Arguments to override defaults.
  * @param string $file Optional filename.
- * @param int $post_parent Parent post ID.
+ * @param int $parent Parent post ID.
  * @return int Attachment ID.
  */
@@ -3428 +3423 @@
  * @uses do_action() Calls 'delete_attachment' hook on Attachment ID.
  *
- * @param int $postid Attachment ID.
+ * @param int $post_id Attachment ID.
  * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
  * @return mixed False on failure. Post data on success.
@@ -4646 +4641 @@
  *
  * @param int|object $revision_id Revision ID or revision object.
- * @param array $fields Optional. What fields to restore from.  Defaults to all.
- * @return mixed Null if error, false if no fields to restore, (int) post ID if success.
+ * @return mixed Null or WP_Error if error, deleted post if success.
  */
 function wp_delete_post_revision( $revision_id ) {