WordPress 4.5
[autoinstalls/wordpress.git] / wp-admin / includes / file.php
index 3b4d1c6e4c2fafe87f1e777d4a0dc8121a4a88e2..72f5e2209bccaa2f1227979ac01b308b0c53abd4 100644 (file)
 
 /** The descriptions for theme files. */
 $wp_file_descriptions = array(
 
 /** The descriptions for theme files. */
 $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' ),
-       'comments-popup.php' => __( 'Popup Comments' ),
-       'footer.php' => __( 'Theme Footer' ),
-       'header.php' => __( 'Theme Header' ),
-       'sidebar.php' => __( 'Sidebar' ),
-       'archive.php' => __( 'Archives' ),
-       'author.php' => __( 'Author Template' ),
-       'tag.php' => __( 'Tag Template' ),
-       'category.php' => __( 'Category Template' ),
-       'page.php' => __( 'Page Template' ),
-       'search.php' => __( 'Search Results' ),
-       'searchform.php' => __( 'Search Form' ),
-       'single.php' => __( 'Single Post' ),
-       '404.php' => __( '404 Template' ),
-       'link.php' => __( 'Links Template' ),
-       'functions.php' => __( 'Theme Functions' ),
-       'attachment.php' => __( 'Attachment Template' ),
-       'image.php' => __('Image Attachment Template'),
-       'video.php' => __('Video Attachment Template'),
-       'audio.php' => __('Audio Attachment Template'),
-       'application.php' => __('Application Attachment Template'),
-       'my-hacks.php' => __( 'my-hacks.php (legacy hacks support)' ),
-       '.htaccess' => __( '.htaccess (for rewrite rules )' ),
+       'functions.php'         => __( 'Theme Functions' ),
+       'header.php'            => __( 'Theme Header' ),
+       'footer.php'            => __( 'Theme Footer' ),
+       'sidebar.php'           => __( 'Sidebar' ),
+       'comments.php'          => __( 'Comments' ),
+       'searchform.php'        => __( 'Search Form' ),
+       '404.php'               => __( '404 Template' ),
+       'link.php'              => __( 'Links Template' ),
+       // Archives
+       'index.php'             => __( 'Main Index Template' ),
+       'archive.php'           => __( 'Archives' ),
+       'author.php'            => __( 'Author Template' ),
+       'taxonomy.php'          => __( 'Taxonomy Template' ),
+       'category.php'          => __( 'Category Template' ),
+       'tag.php'               => __( 'Tag Template' ),
+       'home.php'              => __( 'Posts Page' ),
+       'search.php'            => __( 'Search Results' ),
+       'date.php'              => __( 'Date Template' ),
+       // Content
+       'singular.php'          => __( 'Singular Template' ),
+       'single.php'            => __( 'Single Post' ),
+       'page.php'              => __( 'Single Page' ),
+       'front-page.php'        => __( 'Static Front Page' ),
+       // Attachments
+       'attachment.php'        => __( 'Attachment Template' ),
+       'image.php'             => __( 'Image Attachment Template' ),
+       'video.php'             => __( 'Video Attachment Template' ),
+       'audio.php'             => __( 'Audio Attachment Template' ),
+       'application.php'       => __( 'Application Attachment Template' ),
+       // Stylesheets
+       'style.css'             => __( 'Stylesheet' ),
+       'editor-style.css'      => __( 'Visual Editor Stylesheet' ),
+       'editor-style-rtl.css'  => __( 'Visual Editor RTL Stylesheet' ),
+       'rtl.css'               => __( 'RTL Stylesheet' ),
+       // Other
+       'my-hacks.php'          => __( 'my-hacks.php (legacy hacks support)' ),
+       '.htaccess'             => __( '.htaccess (for rewrite rules )' ),
        // Deprecated files
        // Deprecated files
-       'wp-layout.css' => __( 'Stylesheet' ),
-       'wp-comments.php' => __( 'Comments Template' ),
+       'wp-layout.css'         => __( 'Stylesheet' ),
+       'wp-comments.php'       => __( 'Comments Template' ),
        'wp-comments-popup.php' => __( 'Popup Comments Template' ),
        'wp-comments-popup.php' => __( 'Popup Comments Template' ),
+       'comments-popup.php'    => __( 'Popup Comments' ),
 );
 
 /**
 );
 
 /**
@@ -184,7 +194,7 @@ function wp_tempnam( $filename = '', $dir = '' ) {
 /**
  * Make sure that the file that was requested to edit, is allowed to be edited
  *
 /**
  * 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
+ * Function will die if you are not allowed to edit the file
  *
  * @since 1.5.0
  *
  *
  * @since 1.5.0
  *
@@ -214,6 +224,7 @@ function validate_file_to_edit( $file, $allowed_files = '' ) {
  * 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.
  *
  * 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.
  *
+ * @access private
  * @since 4.0.0
  *
  * @see wp_handle_upload_error
  * @since 4.0.0
  *
  * @see wp_handle_upload_error
@@ -224,7 +235,7 @@ function validate_file_to_edit( $file, $allowed_files = '' ) {
  * @param string      $action    Expected value for $_POST['action'].
  * @return array On success, returns an associative array of file attributes. On failure, returns
  *               $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
  * @param string      $action    Expected value for $_POST['action'].
  * @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_upload( &$file, $overrides, $time, $action ) {
        // The default error handler.
        if ( ! function_exists( 'wp_handle_upload_error' ) ) {
 function _wp_handle_upload( &$file, $overrides, $time, $action ) {
        // The default error handler.
        if ( ! function_exists( 'wp_handle_upload_error' ) ) {
@@ -399,7 +410,8 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) {
                'file' => $new_file,
                'url'  => $url,
                'type' => $type
                'file' => $new_file,
                'url'  => $url,
                'type' => $type
-       ), 'wp_handle_sideload' === $action ? 'sideload' : 'upload' ); }
+       ), 'wp_handle_sideload' === $action ? 'sideload' : 'upload' );
+}
 
 /**
  * Wrapper for _wp_handle_upload(), passes 'wp_handle_upload' action.
 
 /**
  * Wrapper for _wp_handle_upload(), passes 'wp_handle_upload' action.
@@ -457,7 +469,7 @@ function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
 
 
 /**
 
 
 /**
- * Downloads a url to a local temporary file using the WordPress HTTP Class.
+ * Downloads a URL to a local temporary file using the WordPress HTTP Class.
  * Please note, That the calling function must unlink() the file.
  *
  * @since 2.5.0
  * Please note, That the calling function must unlink() the file.
  *
  * @since 2.5.0
@@ -1011,19 +1023,22 @@ function get_filesystem_method( $args = array(), $context = false, $allow_relaxe
  *
  * @since 2.5.
  *
  *
  * @since 2.5.
  *
- * @todo Properly mark optional arguments as such
- *
  * @global string $pagenow
  *
  * @global string $pagenow
  *
- * @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.
+ * @param string $form_post                    The URL to post the form to.
+ * @param string $type                         Optional. Chosen type of filesystem. Default empty.
+ * @param bool   $error                        Optional. Whether the current request has failed to connect.
+ *                                             Default false.
+ * @param string $context                      Optional. Full path to the directory that is tested
+ *                                             for being writable. Default false.
+ * @param array  $extra_fields                 Optional. Extra POST fields which should be checked for
+ *                                             to be included in the post. Default null.
+ * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
+ *                                             Default false.
+ *
+ * @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 ) {
+function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false ) {
        global $pagenow;
 
        /**
        global $pagenow;
 
        /**
@@ -1034,15 +1049,16 @@ function request_filesystem_credentials($form_post, $type = '', $error = false,
         *
         * @since 2.5.0
         *
         *
         * @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 bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
-        * @param array  $extra_fields Extra POST fields.
+        * @param mixed  $output                       Form output to return instead. Default empty.
+        * @param string $form_post                    The 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 bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
+        *                                             Default false.
+        * @param array  $extra_fields                 Extra POST fields.
         */
        $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
        if ( '' !== $req_cred )
         */
        $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
        if ( '' !== $req_cred )