X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f5fcdc7994bb67cce809bc4777944ae8b7fad4a4..refs/tags/wordpress-4.3:/wp-admin/includes/file.php diff --git a/wp-admin/includes/file.php b/wp-admin/includes/file.php index 6c12b3f3..df489491 100644 --- a/wp-admin/includes/file.php +++ b/wp-admin/includes/file.php @@ -50,7 +50,7 @@ $wp_file_descriptions = array( * * @since 1.5.0 * - * @uses $wp_file_descriptions + * @global array $wp_file_descriptions * @param string $file Filesystem path or filename * @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist */ @@ -516,6 +516,8 @@ function verify_file_md5( $filename, $expected_md5 ) { * * @since 2.5.0 * + * @global WP_Filesystem_Base $wp_filesystem Subclass + * * @param string $file Full path and filename of zip archive * @param string $to Full path on the filesystem to extract archive to * @return mixed WP_Error on failure, True on success @@ -579,6 +581,8 @@ function unzip_file($file, $to) { * @see unzip_file * @access private * + * @global WP_Filesystem_Base $wp_filesystem Subclass + * * @param string $file Full path and filename of zip archive * @param string $to Full path on the filesystem to extract archive to * @param array $needed_dirs A partial list of required folders needed to be created. @@ -677,6 +681,8 @@ function _unzip_file_ziparchive($file, $to, $needed_dirs = array() ) { * @see unzip_file * @access private * + * @global WP_Filesystem_Base $wp_filesystem Subclass + * * @param string $file Full path and filename of zip archive * @param string $to Full path on the filesystem to extract archive to * @param array $needed_dirs A partial list of required folders needed to be created. @@ -769,6 +775,8 @@ function _unzip_file_pclzip($file, $to, $needed_dirs = array()) { * * @since 2.5.0 * + * @global WP_Filesystem_Base $wp_filesystem Subclass + * * @param string $from source directory * @param string $to destination directory * @param array $skip_list a list of files/folders to skip copying @@ -823,13 +831,13 @@ function copy_dir($from, $to, $skip_list = array() ) { * * @since 2.5.0 * - * @param array $args Optional. Connection args, These are passed directly to - * the `WP_Filesystem_*()` classes. Default false. - * @param string $context Optional. Context for {@see get_filesystem_method()}. - * Default false. - * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. - * Default false. - * @return null|boolean false on failure, true on success. + * @global WP_Filesystem_Base $wp_filesystem Subclass + * + * @param array|false $args Optional. Connection args, These are passed directly to + * the `WP_Filesystem_*()` classes. Default false. + * @param string|false $context Optional. Context for get_filesystem_method(). Default false. + * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false. + * @return null|bool false on failure, true on success. */ function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { global $wp_filesystem; @@ -902,6 +910,8 @@ function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_own * * @since 2.5.0 * + * @global callback $_wp_filesystem_direct_method + * * @param array $args Optional. Connection details. Default empty array. * @param string $context Optional. Full path to the directory that is tested * for being writable. Default false. @@ -986,13 +996,13 @@ function get_filesystem_method( $args = array(), $context = false, $allow_relaxe * * @todo Properly mark optional arguments as such * - * @param string $form_post the URL to post the form to - * @param string $type the chosen Filesystem method in use - * @param boolean $error if the current request has failed to connect - * @param string $context The directory which is needed access to, The write-test will be performed on this directory by get_filesystem_method() - * @param array $extra_fields Extra POST fields which should be checked for to be included in the post. - * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable. - * @return boolean False on failure. True on success. + * @param string $form_post the URL to post the form to + * @param string $type the chosen Filesystem method in use + * @param bool $error if the current request has failed to connect + * @param string $context The directory which is needed access to, The write-test will be performed on this directory by get_filesystem_method() + * @param array $extra_fields Extra POST fields which should be checked for to be included in the post. + * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable. + * @return bool False on failure. True on success. */ function request_filesystem_credentials($form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false ) {