Wordpress 2.7.1

[autoinstalls/wordpress.git] / wp-admin / includes / import.php

diff --git a/wp-admin/includes/import.php b/wp-admin/includes/import.php
index 35fd141b17d9d6b431e98bae1163c2ddc75e4b5e..c9cd71cb580920b44d9ad39bd14a529125ada973 100644 (file)
--- a/wp-admin/includes/import.php
+++ b/wp-admin/includes/import.php
@@ -1,5 +1,18 @@
 <?php
+/**
+ * WordPress Administration Importer API.
+ *
+ * @package WordPress
+ * @subpackage Administration
+ */
 
+/**
+ * Retrieve list of importers.
+ *
+ * @since 2.0.0
+ *
+ * @return array
+ */
 function get_importers() {
        global $wp_importers;
        if ( is_array($wp_importers) )
@@ -7,6 +20,17 @@ function get_importers() {
        return $wp_importers;
 }
 
+/**
+ * Register importer for WordPress.
+ *
+ * @since 2.0.0
+ *
+ * @param string $id Importer tag. Used to uniquely identify importer.
+ * @param string $name Importer name and title.
+ * @param string $description Importer description.
+ * @param callback $callback Callback to run.
+ * @return WP_Error Returns WP_Error when $callback is WP_Error.
+ */
 function register_importer( $id, $name, $description, $callback ) {
        global $wp_importers;
        if ( is_wp_error( $callback ) )
@@ -14,10 +38,26 @@ function register_importer( $id, $name, $description, $callback ) {
        $wp_importers[$id] = array ( $name, $description, $callback );
 }
 
+/**
+ * Cleanup importer.
+ *
+ * Removes attachment based on ID.
+ *
+ * @since 2.0.0
+ *
+ * @param string $id Importer ID.
+ */
 function wp_import_cleanup( $id ) {
        wp_delete_attachment( $id );
 }
 
+/**
+ * Handle importer uploading and add attachment.
+ *
+ * @since 2.0.0
+ *
+ * @return array
+ */
 function wp_import_handle_upload() {
        $overrides = array( 'test_form' => false, 'test_type' => false );
        $_FILES['import']['name'] .= '.import';