File & Image Upload

These settings affect TinyMCE's image and file upload capabilities.

Contribute to this page

file_browser_callback

This option enables you to add your own file or image browser to TinyMCE.

If this option is set with a value a browse button will appear in different dialogs such as "insert/edit link" or "insert/edit image". If this option hasn't got a value set (or equals to false or null) the dialogs in question won't show any browse button.

This function is executed each time a user clicks on the "browse" buttons in various dialogs. The format of this callback function is: fileBrowser(field_name, url, type, win) where field_name is the id/name of the form element that the browser should insert its URL into. The url parameter contains the URL value that is currently inside the field. The type parameter contains what type of browser to present; this value can be file, image or flash depending on what dialog is calling the function. The win parameter contains a reference to the dialog/window that executes the function.

Type: JavaScript Function

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  file_browser_callback: function(field_name, url, type, win) {
    win.document.getElementById(field_name).value = 'my browser value';
  }
});

You can fiddle with this example at the fiddle.tinymce.com site.

file_browser_callback_types

This option enables you to specify what types of file pickers you need by using a space or comma separated list of type names. There are currently three valid types: file, image and media.

Type: String

Possible Values: file, image, media

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  file_browser_callback_types: 'file image media'
});

file_picker_callback

This hook can be used to add custom file picker to those dialogs that have it. Internally we support this in Image, Media and Link dialogs. Option replaces deprecated file_browser_callback. New hook provides a way to update values of other fields in the dialog.

Once you define file_picker_callback, small browse button will appear along the fields of supported file types (see file_picker_types). When user clicks the button, TinyMCE will automatically call the callback with three arguments:

It should be noted, that we only provide a hook. It is up to you to implement specific functionality.

Type: JavaScript Function

The following example demonstrates how you can use file_picker_callback API, but doesn't pick any real files. Check Basic Local File Picker demo for a more functional example.

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  file_picker_callback: function(callback, value, meta) {
    // Provide file and text for the link dialog
    if (meta.filetype == 'file') {
      callback('mypage.html', {text: 'My text'});
    }

    // Provide image and alt text for the image dialog
    if (meta.filetype == 'image') {
      callback('myimage.jpg', {alt: 'My alt text'});
    }

    // Provide alternative source and posted for the media dialog
    if (meta.filetype == 'media') {
      callback('movie.mp4', {source2: 'alt.ogg', poster: 'image.jpg'});
    }
  }
});

file_picker_types

This option enables you to specify what types of file pickers you need by a space or comma separated list of type names. There are currently three valid types: file, image and media.

Type: String

Possible Values: file, image, media

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  file_picker_types: 'file image media'
});

automatic_uploads

Enable or disable automatic upload of images represented by data URLs or blob URIs. Such images get generated, for example, as a result of image manipulation through Image Tools plugin, or after image is drag-n-dropped onto the editor from the desktop.

Warning: Note that, this option will do nothing if images_upload_url is not specified.

Type: Boolean

Default Value: true

Possible Values: true, false

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  images_upload_url: 'postAcceptor.php',
  automatic_uploads: false
});

images_upload_url

This option lets you specify a URL for the server-side upload handler. Upload will get triggered whenever you call editor.uploadImages() or - automatically, if automatic_uploads option is enabled. Upload handler should return a new location for the uploaded file in the following format:

{ "location": "folder/sub-folder/new-location.png" }

Be sure to checkout a demo implementation of the server-side upload handler here (written in PHP).

Type: String

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  images_upload_url: 'postAcceptor.php'
});

images_upload_base_path

This option lets you specify a basepath to prepend to URLs returned from the configured images_upload_url page.

Type: String

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  images_upload_base_path: '/some/basepath'
});

images_upload_credentials

This option lets you specify if calls to the configured images_upload_url should pass along credentials like cookies etc cross domain.

Type: Boolean

Default Value: false

Possible Values: true, false

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  images_upload_credentials: true
});

images_upload_handler

This option allows you to specify a function that will be used to replace TinyMCE's default JavaScript upload handler function with custom logic.

The upload handler function takes three arguments: blobInfo, a success callback and a failure callback. When this option is not set, TinyMCE utilizes an XMLHttpRequest to upload images one at a time to the server, and calls the success callback with the location of the remote image.

Please note that when using this option, no other image uploader options are necessary. Additionally, if you would like TinyMCE to replace the <image> tag's src attribute with the remote location, please use the success callback defined in the images_upload_handler function with the returned JSON object's location property.

Type: JavaScript Function

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  images_upload_handler: function (blobInfo, success, failure) {
    var xhr, formData;

    xhr = new XMLHttpRequest();
    xhr.withCredentials = false;
    xhr.open('POST', 'postAcceptor.php');

    xhr.onload = function() {
      var json;

      if (xhr.status != 200) {
        failure('HTTP Error: ' + xhr.status);
        return;
      }

      json = JSON.parse(xhr.responseText);

      if (!json || typeof json.location != 'string') {
        failure('Invalid JSON: ' + xhr.responseText);
        return;
      }

      success(json.location);
    };

    formData = new FormData();
    formData.append('file', blobInfo.blob(), blobInfo.filename());

    xhr.send(formData);
  }
});

images_dataimg_filter

This option lets you specify a filter predicate function for disabling the logic that converts base64 images into blobs while within the editor. This is normally used for very advanced integrations where you handle all base64/blob images with custom logic.

Type: JavaScript Function

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  images_dataimg_filter: function(img) {
    return img.hasAttribute('internal-blob');
  }
});

images_reuse_filename

By default TinyMCE will generate unique filename for each uploaded file (for details refer to Upload Images). Sometimes this might have undesirable side-effects. For example when automatic_uploads is enabled, every manipulation on the image, done with Image Tools plugin, will result in file upload and each time under a different filename, despite of the fact that image basically stays the same.

Setting images_reuse_filename to true will tell TinyMCE to use the actual filename of the image, instead of generating a new one each time. Take into account that src attribute of the corresponding <img> tag will get replaced with whatever filename you send back from the server (see images_upload_url). It can be the same filename or something else, but next time that filename will be the one used for the upload.

Type: Boolean

Default Value: false

Possible Values: true, false

Example
tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  automatic_uploads: true,
  images_upload_url: 'postAcceptor.php',
  images_reuse_filename: true
});

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.