Ticket #6591: 6591.03.patch

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

@@ -34 +34 @@
          * @var array
          */
         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,
         );
 
         /**
@@ -91 +92 @@
                         } 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
                         } elseif ( 'action' !== $key && 'file_input' !== $key ) {
                                 $this->{$key} = $param;
@@ -268 +273 @@
 
                 // 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 );
                 }
 
                 // Upload the attachment
@@ -276 +281 @@
 
                 // 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 );
                 }
 
                 // Remove the pre WordPress 4.0 static filter
@@ -344 +349 @@
         /**
          * Default filter to save the attachments.
          *
-         * @since BuddyPress (2.3.0)
+         * @since 2.3.0
+         * @since 2.4.0 Added `$upload_dir_data` parameter
          *
          * @uses apply_filters() call 'bp_attachment_upload_dir' to eventually override the upload location
          *       regarding to context
          *
+         * @param  array $upload_dir_data The original upload directory data.
          * @return array The upload directory data.
          */
-        public function upload_dir_filter() {
+        public function upload_dir_filter( $upload_dir_data = array() ) {
 
                 /**
                  * Filters the component's upload directory.
@@ -367 +374 @@
                         'basedir' => $this->upload_path,
                         'baseurl' => $this->url,
                         'error'   => false
-                ) );
+                ), $upload_dir_data );
         }
 
         /**

tests/phpunit/testcases/core/class-bp-attachment.php

@@ -328 +328 @@
                 // clean up!
                 $this->clean_files();
         }
+
+        /**
+         * @group upload
+         * @group avatar
+         */
+        public function test_bp_attachment_upload_dir_filter_arg() {
+                $attachment_class = new BPTest_Attachment_Extension( array(
+                        'action'                 => 'attachment_action',
+                        'file_input'             => 'attachment_file_input',
+                        'base_dir'               => 'attachment_base_dir',
+                        'upload_dir_filter_args' => 1,
+                ) );
+
+                $this->assertTrue( 1 === $attachment_class->upload_dir_filter_args );
+
+                $avatar_attachment = new BP_Attachment_Avatar();
+
+                $this->assertTrue( 0 === $avatar_attachment->upload_dir_filter_args );
+        }
 }