Changes from branches/3.0/wp-admin/includes/file.php at r16367 to trunk/wp-admin/includes/file.php at r17200

File:

• trunk/wp-admin/includes/file.php (modified) (15 diffs)

trunk/wp-admin/includes/file.php

@@ -8 +8 @@
 
 /** The descriptions for theme files. */
-$wp_file_descriptions = array (
+$wp_file_descriptions = array(
     'index.php' => __( 'Main Index Template' ),
     'style.css' => __( 'Stylesheet' ),
     'editor-style.css' => __( 'Visual Editor Stylesheet' ),
+    'editor-style-rtl.css' => __( 'Visual Editor RTL Stylesheet' ),
     'rtl.css' => __( 'RTL Stylesheet' ),
     'comments.php' => __( 'Comments' ),
@@ -37 +38 @@
     '.htaccess' => __( '.htaccess (for rewrite rules )' ),
     // Deprecated files
-    'wp-layout.css' => __( 'Stylesheet' ), 'wp-comments.php' => __( 'Comments Template' ), 'wp-comments-popup.php' => __( 'Popup Comments Template' ));
-
-/**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $file
- * @return unknown
+    'wp-layout.css' => __( 'Stylesheet' ),
+    'wp-comments.php' => __( 'Comments Template' ),
+    'wp-comments-popup.php' => __( 'Popup Comments Template' ),
+);
+
+/**
+ * Get the description for standard WordPress theme files and other various standard
+ * WordPress files
+ *
+ * @since 1.5.0
+ *
+ * @uses _cleanup_header_comment
+ * @uses $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
  */
 function get_file_description( $file ) {
@@ -56 +63 @@
         $template_data = implode( '', file( $file ) );
         if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ))
-            return _cleanup_header_comment($name[1]) . ' Page Template';
+            return sprintf( __( '%s Page Template' ), _cleanup_header_comment($name[1]) );
     }
 
@@ -63 +70 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @return unknown
+ * Get the absolute filesystem path to the root of the WordPress installation
+ *
+ * @since 1.5.0
+ *
+ * @uses get_option
+ * @return string Full filesystem path to the root of the WordPress installation
  */
 function get_home_path() {
@@ -85 +93 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $file
- * @return unknown
+ * Get the real file system path to a file to edit within the admin
+ *
+ * If the $file is index.php or .htaccess this function will assume it is relative
+ * to the install root, otherwise it is assumed the file is relative to the wp-content
+ * directory
+ *
+ * @since 1.5.0
+ *
+ * @uses get_home_path
+ * @uses WP_CONTENT_DIR full filesystem path to the wp-content directory
+ * @param string $file filesystem path relative to the WordPress install directory or to the wp-content directory
+ * @return string full file system path to edit
  */
 function get_real_file_to_edit( $file ) {
@@ -202 +216 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $file
- * @param unknown_type $allowed_files
- * @return unknown
+ * Make sure that the file that was requested to edit, is allowed to be edited
+ *
+ * Function will die if if you are not allowed to edit the file
+ *
+ * @since 1.5.0
+ *
+ * @uses wp_die
+ * @uses validate_file
+ * @param string $file file the users is attempting to edit
+ * @param array $allowed_files Array of allowed files to edit, $file must match an entry exactly
+ * @return null
  */
 function validate_file_to_edit( $file, $allowed_files = '' ) {
@@ -229 +247 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
+ * Handle PHP uploads in WordPress, sanitizing file names, checking extensions for mime type,
+ * and moving the file to the appropriate directory within the uploads directory.
+ *
+ * @since 2.0
+ *
+ * @uses wp_handle_upload_error
+ * @uses apply_filters
+ * @uses is_multisite
+ * @uses wp_check_filetype_and_ext
+ * @uses current_user_can
+ * @uses wp_upload_dir
+ * @uses wp_unique_filename
+ * @uses delete_transient
  * @param array $file Reference to a single element of $_FILES. Call the function once for each uploaded file.
  * @param array $overrides Optional. An associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE ).
@@ -316 +343 @@
 
         if ( ( !$type || !$ext ) && !current_user_can( 'unfiltered_upload' ) )
-            return call_user_func($upload_error_handler, $file, __( 'File type does not meet security guidelines. Try another.' ));
+            return call_user_func($upload_error_handler, $file, __( 'Sorry, this file type is not permitted for security reasons.' ));
 
         if ( !$ext )
@@ -353 +380 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * Pass this function an array similar to that of a $_FILES POST array.
- *
- * @since unknown
- *
- * @param unknown_type $file
- * @param unknown_type $overrides
- * @return unknown
+ * Handle sideloads, which is the process of retriving a media item from another server instead of
+ * a traditional media upload.  This process involves sanitizing the filename, checking extensions
+ * for mime type, and moving the file to the appropriate directory within the uploads directory.
+ *
+ * @since 2.6.0
+ *
+ * @uses wp_handle_upload_error
+ * @uses apply_filters
+ * @uses wp_check_filetype_and_ext
+ * @uses current_user_can
+ * @uses wp_upload_dir
+ * @uses wp_unique_filename
+ * @param array $file an array similar to that of a PHP $_FILES POST array
+ * @param array $overrides Optional. An associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE ).
+ * @return array On success, returns an associative array of file attributes. On failure, returns $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
  */
 function wp_handle_sideload( &$file, $overrides = false ) {
@@ -430 +463 @@
 
         if ( ( !$type || !$ext ) && !current_user_can( 'unfiltered_upload' ) )
-            return $upload_error_handler( $file, __( 'File type does not meet security guidelines. Try another.' ));
+            return $upload_error_handler( $file, __( 'Sorry, this file type is not permitted for security reasons.' ));
 
         if ( !$ext )
@@ -475 +508 @@
  *
  * @param string $url the URL of the file to download
+ * @param int $timeout The timeout for the request to download the file default 300 seconds
  * @return mixed WP_Error on failure, string Filename on success.
  */
-function download_url( $url ) {
+function download_url( $url, $timeout = 300 ) {
     //WARNING: The file is not automatically deleted, The script must unlink() the file.
     if ( ! $url )
@@ -490 +524 @@
         return new WP_Error('http_no_file', __('Could not create Temporary file.'));
 
-    $response = wp_remote_get($url, array('timeout' => 300));
+    $response = wp_remote_get($url, array('timeout' => $timeout));
 
     if ( is_wp_error($response) ) {
@@ -937 +971 @@
         $error_string = __('<strong>Error:</strong> There was an error connecting to the server, Please verify the settings are correct.');
         if ( is_wp_error($error) )
-            $error_string = $error->get_error_message();
-        echo '<div id="message" class="error"><p>' . esc_html( $error_string ) . '</p></div>';
+            $error_string = esc_html( $error->get_error_message() );
+        echo '<div id="message" class="error"><p>' . $error_string . '</p></div>';
     }
 
@@ -972 +1006 @@
     $label_user = __('Username');
     $label_pass = __('Password');
-    _e('To perform the requested action, WordPress needs to access to your web server.');
+    _e('To perform the requested action, WordPress needs to access your web server.');
     echo ' ';
     if ( ( isset( $types['ftp'] ) || isset( $types['ftps'] ) ) ) {
@@ -1038 +1072 @@
         echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( stripslashes( $_POST[ $field ] ) ) . '" />';
 }
+submit_button( __( 'Proceed' ), 'button', 'upgrade' );
 ?>
-<p class="submit">
-<input id="upgrade" name="upgrade" type="submit" class="button" value="<?php esc_attr_e('Proceed'); ?>" />
-</p>
 </div>
 </form>