Changeset 21171

Timestamp:

06/28/2012 08:31:28 PM (13 years ago)

Author:

nacin

Message:

Inline documentation for image_attachment_fields_to_save(). props Moraleida.me. fixes #20803.

File:

• trunk/wp-admin/includes/media.php (modified) (1 diff)

trunk/wp-admin/includes/media.php

@@ -862 +862 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since 2.5.0
- *
- * @param unknown_type $post
- * @param unknown_type $attachment
- * @return unknown
+ * Filters input from media_upload_form_handler() and assigns a default
+ * post_title from the file name if none supplied. 
+ *
+ * Illustrates the use of the attachment_fields_to_save filter 
+ * which can be used to add default values to any field before saving to DB.
+ *
+ * @since 2.5.0
+ *
+ * @param array $post
+ * @param array $attachment
+ * @return array
  */
 function image_attachment_fields_to_save($post, $attachment) {