Changeset 10194 for trunk/src/bp-core/classes/class-bp-attachment.php

Timestamp:

10/06/2015 11:53:33 PM (9 years ago)

Author:

imath

Message:

Allow class extending the BP_Attachment class to get the original WordPress upload dir within their upload_dir_filter() method.

To do so, you simply need to add the argument $upload_dir_filter_args to the array you use inside your constructor and set it to 1.

Props rittesh.patel

Fixes #6591

File:

• trunk/src/bp-core/classes/class-bp-attachment.php (modified) (8 diffs)

trunk/src/bp-core/classes/class-bp-attachment.php

@@ -35 +35 @@
      */
     protected $default_args = array(
-        'original_max_filesize' => 0,
-        'allowed_mime_types'    => array(),
-        'base_dir'              => '',
-        'action'                => '',
-        'file_input'            => '',
-        'upload_error_strings'  => array(),
-        'required_wp_files'     => array( 'file' ),
+        'original_max_filesize'  => 0,
+        'allowed_mime_types'     => array(),
+        'base_dir'               => '',
+        'action'                 => '',
+        'file_input'             => '',
+        'upload_error_strings'   => array(),
+        'required_wp_files'      => array( 'file' ),
+        'upload_dir_filter_args' => 0,
     );
 
@@ -48 +49 @@
      *
      * @since 2.3.0
+     * @since 2.4.0 Add the $upload_dir_filter_args argument to the $arguments array
      *
      * @param array|string $args {
-     *     @type int    $original_max_filesize Maximum file size in kilobytes. Defaults to php.ini settings.
-     *     @type array  $allowed_mime_types    List of allowed file extensions (eg: array( 'jpg', 'gif', 'png' ) ).
-     *                                         Defaults to WordPress allowed mime types.
-     *     @type string $base_dir              Component's upload base directory. Defaults to WordPress 'uploads'.
-     *     @type string $action                The upload action used when uploading a file, $_POST['action'] must be set
-     *                                         and its value must equal $action {@link wp_handle_upload()} (required).
-     *     @type string $file_input            The name attribute used in the file input. (required).
-     *     @type array  $upload_error_strings  A list of specific error messages (optional).
-     *     @type array  $required_wp_files     The list of required WordPress core files. Default: array( 'file' ).
+     *     @type int    $original_max_filesize  Maximum file size in kilobytes. Defaults to php.ini settings.
+     *     @type array  $allowed_mime_types     List of allowed file extensions (eg: array( 'jpg', 'gif', 'png' ) ).
+     *                                          Defaults to WordPress allowed mime types.
+     *     @type string $base_dir               Component's upload base directory. Defaults to WordPress 'uploads'.
+     *     @type string $action                 The upload action used when uploading a file, $_POST['action'] must be set
+     *                                          and its value must equal $action {@link wp_handle_upload()} (required).
+     *     @type string $file_input             The name attribute used in the file input. (required).
+     *     @type array  $upload_error_strings   A list of specific error messages (optional).
+     *     @type array  $required_wp_files      The list of required WordPress core files. Default: array( 'file' ).
+     *     @type int    $upload_dir_filter_args 1 to receive the original Upload dir array in the Upload dir filter, 0 otherwise.
+     *                                          Defaults to 0 (optional).
      * }
      * @uses  sanitize_key()
@@ -91 +95 @@
             } elseif ( 'base_dir' === $key ) {
                 $this->{$key} = sanitize_title( $param );
+
+            // Sanitize the upload dir filter arg to pass
+            } elseif ( 'upload_dir_filter_args' === $key ) {
+                $this->{$key} = (int) $param;
 
             // Action & File input are already set and sanitized
@@ -269 +277 @@
         // Make sure the file will be uploaded in the attachment directory
         if ( ! empty( $upload_dir_filter ) ) {
-            add_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+            add_filter( 'upload_dir', $upload_dir_filter, 10, $this->upload_dir_filter_args );
         }
 
@@ -277 +285 @@
         // Restore WordPress Uploads data
         if ( ! empty( $upload_dir_filter ) ) {
-            remove_filter( 'upload_dir', $upload_dir_filter, 10, 0 );
+            remove_filter( 'upload_dir', $upload_dir_filter, 10, $this->upload_dir_filter_args );
         }
 
@@ -346 +354 @@
      *
      * @since 2.3.0
+     * @since 2.4.0 Add the $upload_dir parameter to the method
      *
      * @uses apply_filters() call 'bp_attachment_upload_dir' to eventually override the upload location
      *       regarding to context
      *
+     * @param  array $upload_dir The original Uploads dir.
      * @return array The upload directory data.
      */
-    public function upload_dir_filter() {
+    public function upload_dir_filter( $upload_dir = array() ) {
 
         /**
@@ -358 +368 @@
          *
          * @since 2.3.0
+         * @since 2.4.0 Include the original Upload directory as the second parameter of the filter.
          *
-         * @param array $value Array containing the path, URL, and other helpful settings.
+         * @param array $value          Array containing the path, URL, and other helpful settings.
+         * @param array $upload_dir     The original Uploads dir.
          */
         return apply_filters( 'bp_attachment_upload_dir', array(
@@ -368 +380 @@
             'baseurl' => $this->url,
             'error'   => false
-        ) );
+        ), $upload_dir );
     }