Changeset 12483 for trunk/wp-admin/includes/post.php

Timestamp:

12/22/2009 12:25:15 PM (17 years ago)

Author:

westi

Message:

Updated phpDoc for wp-admin/includes/post.php . Fixes #11198 based on a patch from Simek.

File:

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

trunk/wp-admin/includes/post.php

@@ -214 +214 @@
 
 /**
- * {@internal Missing Short Description}}
+ * Process the post data for the bulk editing of posts.
  *
  * Updates all bulk edited posts/pages, adding (but not removing) tags and
  * categories. Skips pages when they would be their own parent or child.
  *
- * @since unknown
- *
+ * @since 2.7.0
+ *
+ * @param array $post_data Optional, the array of post data to process if not provided will use $_POST superglobal.
  * @return array
  */
@@ -324 +325 @@
  * @since unknown
  *
- * @return unknown
+ * @return object stdClass object containing all the default post data as attributes
  */
 function get_default_post_to_edit() {
@@ -365 +366 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @return unknown
+ * Get the default page information to use.
+ *
+ * @since 2.5.0
+ *
+ * @return object stdClass object containing all the default post data as attributes
  */
 function get_default_page_to_edit() {
@@ -739 +740 @@
                         $attachment['post_parent'] = $post_ID;
                         // Escape data pulled from DB.
-                        $attachment = add_magic_quotes( $attachment);
-                        wp_update_post( $attachment);
+                        $attachment = add_magic_quotes( $attachment );
+                        wp_update_post( $attachment );
                 }
 
@@ -790 +791 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $type
- * @return unknown
+ * Get all the possible statuses for a post_type
+ *
+ * @since 2.5.0
+ *
+ * @param string $type The post_type you want the statuses for
+ * @return array As array of all the statuses for the supplied post type
  */
 function get_available_post_statuses($type = 'post') {
@@ -804 +805 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $q
- * @return unknown
+ * Run the wp query to fetch the posts for listing on the edit posts page
+ *
+ * @since 2.5.0
+ *
+ * @param array|bool $q Array of query variables to use to build the query or false to use $_GET superglobal.
+ * @return array
  */
 function wp_edit_posts_query( $q = false ) {
         if ( false === $q )
                 $q = $_GET;
-        $q['m']   = isset($q['m']) ? (int) $q['m'] : 0;
+        $q['m'] = isset($q['m']) ? (int) $q['m'] : 0;
         $q['cat'] = isset($q['cat']) ? (int) $q['cat'] : 0;
         $post_stati  = array(   //      array( adj, noun )
@@ -923 +924 @@
  * {@internal Missing Short Description}}
  *
+ * @uses get_user_option()
  * @since unknown
  *
@@ -934 +936 @@
         $current_user = wp_get_current_user();
         if ( $closed = get_user_option('closedpostboxes_'.$page, 0, false ) ) {
-                if ( !is_array( $closed ) ) return '';
+                if ( !is_array( $closed ) ) {
+                        return '';
+                }
                 return in_array( $id, $closed )? 'closed' : '';
         } else {
@@ -953 +957 @@
 function get_sample_permalink($id, $title = null, $name = null) {
         $post = &get_post($id);
-        if (!$post->ID) {
+        if ( !$post->ID ) {
                 return array('', '');
         }
@@ -962 +966 @@
         // Hack: get_permalink would return ugly permalink for
         // drafts, so we will fake, that our post is published
-        if (in_array($post->post_status, array('draft', 'pending'))) {
+        if ( in_array($post->post_status, array('draft', 'pending')) ) {
                 $post->post_status = 'publish';
                 $post->post_name = sanitize_title($post->post_name ? $post->post_name : $post->post_title, $post->ID);
@@ -971 +975 @@
         // If the user wants to set a new name -- override the current one
         // Note: if empty name is supplied -- use the title instead, see #6072
-        if (!is_null($name)) {
+        if ( !is_null($name) ) {
                 $post->post_name = sanitize_title($name ? $name : $title, $post->ID);
         }
@@ -1173 +1177 @@
  * @uses _wp_translate_postdata()
  * @uses _wp_post_revision_fields()
+ * 
+ * @return unknown
  */
 function wp_create_post_autosave( $post_id ) {
@@ -1199 +1205 @@
  *
  * @package WordPress
- * @since 2.7
+ * @since 2.7.0
  *
  * @uses wp_write_post()
@@ -1260 +1266 @@
  *
  * @package WordPress
- * @since 2.7
+ * @since 2.7.0
  *
  * TinyMCE is loaded separately from other Javascript by using wp-tinymce.php. It outputs concatenated