Changeset 27672

Timestamp:

03/24/2014 02:44:17 AM (12 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/file.php.

Fixes #27429.

Location:

trunk/src

Files:

• wp-admin/includes/file.php (modified) (11 diffs)
• wp-includes/class-wp-xmlrpc-server.php (modified) (1 diff)

trunk/src/wp-admin/includes/file.php

@@ -195 +195 @@
  *
  * @uses wp_handle_upload_error
- * @uses apply_filters
  * @uses is_multisite
  * @uses wp_check_filetype_and_ext
@@ -215 +214 @@
         }
 
+        /**
+         * Filter data for the current file to upload.
+         *
+         * @since 2.9.0
+         *
+         * @param array $file An array of data for a single file.
+         */
         $file = apply_filters( 'wp_handle_upload_prefilter', $file );
 
@@ -326 +332 @@
                 delete_transient( 'dirsize_cache' );
 
+        /**
+         * Filter the data array for the uploaded file.
+         *
+         * @since 2.1.0
+         *
+         * @param array  $upload {
+         *     Array of upload data.
+         *
+         *     @type string $file Filename of the newly-uploaded file.
+         *     @type string $url  URL of the uploaded file.
+         *     @type string $type File type.
+         * }
+         * @param string $context The type of upload action. Accepts 'upload' or 'sideload'.
+         */
         return apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $type ), 'upload' );
 }
@@ -337 +357 @@
  *
  * @uses wp_handle_upload_error
- * @uses apply_filters
  * @uses wp_check_filetype_and_ext
  * @uses current_user_can
@@ -451 +470 @@
         $url = $uploads['url'] . "/$filename";
 
+        /** This filter is documented in wp-admin/includes/file.php */
         $return = apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $type ), 'sideload' );
 
@@ -544 +564 @@
 
         // Unzip can use a lot of memory, but not this much hopefully
+        /** This filter is documented in wp-admin/admin.php */
         @ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
 
@@ -567 +588 @@
         }
 
-        if ( class_exists('ZipArchive') && apply_filters('unzip_file_use_ziparchive', true ) ) {
+        /**
+         * Filter whether to use ZipArchive to unzip archives.
+         *
+         * @since 3.0.0
+         *
+         * @param bool $ziparchive Whether to use ZipArchive. Default true.
+         */
+        if ( class_exists( 'ZipArchive' ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
                 $result = _unzip_file_ziparchive($file, $to, $needed_dirs);
                 if ( true === $result ) {
@@ -844 +872 @@
 
         if ( ! class_exists("WP_Filesystem_$method") ) {
-                $abstraction_file = apply_filters('filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method);
+
+                /**
+                 * Filter the path for a specific filesystem method class file.
+                 *
+                 * @since 2.6.0
+                 *
+                 * @see get_filesystem_method()
+                 *
+                 * @param string $path   Path to the specific filesystem method class file.
+                 * @param string $method The filesystem method to use.
+                 */
+                $abstraction_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method );
+
                 if ( ! file_exists($abstraction_file) )
                         return;
@@ -916 +956 @@
         if ( ! $method && extension_loaded('ftp') ) $method = 'ftpext';
         if ( ! $method && ( extension_loaded('sockets') || function_exists('fsockopen') ) ) $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread
-        return apply_filters('filesystem_method', $method, $args);
+
+        /**
+         * Filter the filesystem method to use.
+         *
+         * @since 2.6.0
+         *
+         * @param string $method Filesystem method to return.
+         * @param array  $args   An array of connection details for the method.
+         */
+        return apply_filters( 'filesystem_method', $method, $args );
 }
 
@@ -937 +986 @@
  */
 function request_filesystem_credentials($form_post, $type = '', $error = false, $context = false, $extra_fields = null) {
+
+        /**
+         * Filter the filesystem credentials form output.
+         *
+         * Returning anything other than an empty string will effectively short-circuit
+         * output of the filesystem credentials form, returning that value instead.
+         *
+         * @since 2.5.0
+         *
+         * @param mixed  $output       Form output to return instead. Default empty.
+         * @param string $form_post    URL to POST the form to.
+         * @param string $type         Chosen type of filesystem.
+         * @param bool   $error        Whether the current request has failed to connect.
+         *                             Default false.
+         * @param string $context      Full path to the directory that is tested for
+         *                             being writable.
+         * @param array  $extra_fields Extra POST fields.
+         */
         $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields );
         if ( '' !== $req_cred )
@@ -1015 +1082 @@
                 $types[ 'ssh' ] = __('SSH2');
 
-        $types = apply_filters('fs_ftp_connection_types', $types, $credentials, $type, $error, $context);
+        /**
+         * Filter the connection types to output to the filesystem credentials form.
+         *
+         * @since 2.9.0
+         *
+         * @param array  $types       Types of connections.
+         * @param array  $credentials Credentials to connect with.
+         * @param string $type        Chosen filesystem method.
+         * @param object $error       Error object.
+         * @param string $context     Full path to the directory that is tested
+         *                            for being writable.
+         */
+        $types = apply_filters( 'fs_ftp_connection_types', $types, $credentials, $type, $error, $context );
 
 ?>

trunk/src/wp-includes/class-wp-xmlrpc-server.php

@@ -4996 +4996 @@
                         'type' => $type
                 );
+
+                /** This filter is documented in wp-admin/includes/file.php */
                 return apply_filters( 'wp_handle_upload', $struct, 'upload' );
         }