Community Documentation

Plupload and related modules

Last updated August 9, 2012. Created by slashrsm on June 19, 2012.
Edited by aendrew, tstoeckler. Log in to edit this page.

Plupload module integrates the Plupload library with Drupal forms. To install the Plupload library:

  1. Download it (version 1.5.1.1 or later) from http://plupload.com.
  2. Unzip it into sites/all/libraries, so that there's a
    sites/all/libraries/plupload/js/plupload.full.js file, in addition to the
    other files included in the library.

If you would like to use an alternate library location, you can install the LIbraries module and/or add

  $conf['plupload_library_path'] = PATH/TO/PLUPLOAD;

to your settings.php file.

At this time, this module only provides a 'plupload' form element type that
other modules can use for providing multiple file upload capability to their
forms. It does not provide any end-user functionality on its own. This may
change, however, as this module evolves. See http://drupal.org/node/880300.

For developers

Plupload form element can be used like this:

<?php
$form
['my_element'] = array(
 
'#type' => 'plupload',
 
'#title' => t('Upload files'),
 
'#description' => t('This multi-upload widget uses Plupload library.'),
 
'#upload_validators' => array(
   
'file_validate_extensions' => array('jpg jpeg gif png txt doc xls pdf ppt pps odt ods odp'),
   
'my_custom_file_validator' => array('some validation criteria'),
  ),
 
'#plupload_settings' => array(
   
'runtimes' => 'html5',
   
'chunk_size' => '1mb',
  ),
);
?>
  • #upload_validators - an array of validation function/validation criteria pairs, that
    will be passed to file_validate().

    Defaults to:

    <?php
     
    '#upload_validators' => array(
       
    'file_validate_extensions' => array('jpg jpeg gif png txt doc xls pdf ppt pps odt ods odp'),
      );
    ?>
  • #plupload_settings - array of settings, that will be passed to Plupload library.
    See: http://www.plupload.com/documentation.php
    <?php
      Defaults to
    :
     
    '#plupload_settings' => array(
       
    'runtimes' => 'html5,flash,html4',
       
    'url' => url('plupload-handle-uploads', array('query' => array('plupload_token' => drupal_get_token('plupload-handle-uploads')))),
       
    'max_file_size' => file_upload_max_size() . 'b',
       
    'chunk_size' => '1mb',
       
    'unique_names' => TRUE,
       
    'flash_swf_url' => file_create_url($library_path . '/js/plupload.flash.swf'),
       
    'silverlight_xap_url' => file_create_url($library_path . '/js/plupload.silverlight.xap'),
      ),
    ?>

Page status

No known problems

Log in to edit this page

About this page

Drupal version
Drupal 7.x
Level
Beginner
Audience
Programmers, Site administrators, Site builders
Keywords
Media, plupload
Drupal’s online documentation is © 2000-2013 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution-ShareAlike 2.0. PHP code is distributed under the GNU General Public License. Comments on documentation pages are used to improve content and then deleted.
nobody click here