TinyMCE uploads edited images with the image uploader. This complements TinyMCE’s image editing functionality.
Local images that are added through other means are also uploaded using this function, such as images added by drag and drop when using the
paste_data_images
configuration property, or using the Tiny
PowerPaste
plugin
.
TinyMCE automatically updates the
<img>
src attribute with the new path to the remote image.
Local images are uploaded to TinyMCE using the
editor.uploadImages()
function. This functionality makes it possible for users to save their content
before
all images have completed uploading. If this occurs and no server path to the remote image is available, the images are saved as
Base64
.
tinymce.activeEditor.uploadImages().then(() => {
$.post('ajax/post.php', tinymce.activeEditor.getContent()).done(() => {
console.log("Uploaded images and posted content as an ajax request.");
Set the images_upload_url
or images_upload_handler
option for image uploads to function. The other options shown here are optional.
Required:
Be sure to checkout a demo implementation of the server-side upload handler here (written in PHP).
Type: String
tinymce.init({
selector: 'textarea', // change this value according to your HTML
images_upload_url: 'postAcceptor.php'
This option allows you to specify a function that is used to replace TinyMCE’s default JavaScript upload handler function with custom logic.
The upload handler function takes two arguments:
When this option is not set, TinyMCE utilizes an XMLHttpRequest
to upload images one at a time to the server and resolves the Promise
with the JSON location
property for the remote image returned by the server.
Type: Function
const example_image_upload_handler = (blobInfo, progress) => new Promise((resolve, reject) => {
const xhr = new XMLHttpRequest();
xhr.withCredentials = false;
xhr.open('POST', 'postAcceptor.php');
xhr.upload.onprogress = (e) => {
progress(e.loaded / e.total * 100);
xhr.onload = () => {
if (xhr.status === 403) {
reject({ message: 'HTTP Error: ' + xhr.status, remove: true });
return;
if (xhr.status < 200 || xhr.status >= 300) {
reject('HTTP Error: ' + xhr.status);
return;
const json = JSON.parse(xhr.responseText);
if (!json || typeof json.location != 'string') {
reject('Invalid JSON: ' + xhr.responseText);
return;
resolve(json.location);
xhr.onerror = () => {
reject('Image upload failed due to a XHR Transport error. Code: ' + xhr.status);
const formData = new FormData();
formData.append('file', blobInfo.blob(), blobInfo.filename());
xhr.send(formData);
tinymce.init({
selector: 'textarea', // change this value according to your HTML
images_upload_handler: example_image_upload_handler
This option lets you specify a basepath
to prepend to URLs returned from the configured images_upload_url
page.
Type: String
tinymce.init({
selector: 'textarea', // change this value according to your HTML
images_upload_url: 'postAcceptor.php',
images_upload_base_path: '/some/basepath'
The images_upload_credentials option specifies whether calls to the configured images_upload_url
should pass along credentials (such as cookies, authorization headers, or TLS client certificates) for cross-domain uploads. When set to true
, credentials will be sent to the upload handler, similar to the withCredentials
property of XMLHttpRequest
.
Type: Boolean
Default value: false
Possible values: true
, false
tinymce.init({
selector: 'textarea', // change this value according to your HTML
images_upload_url: 'postAcceptor.php',
images_upload_credentials: true
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 the Image Editing plugin, results in file upload and each time under a different filename, despite the fact that the image stays the same.
Setting images_reuse_filename
to true tells 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 gets replaced with whatever filename you send back from the server (see images_upload_url). It can be the same filename or something else, but the next time that filename is used for the upload.
Type: Boolean
Default value: false
Possible values: true
, false
tinymce.init({
selector: 'textarea', // change this value according to your HTML
automatic_uploads: true,
images_upload_url: 'postAcceptor.php',
images_reuse_filename: true
Configure Cross-origin resource sharing (CORS) to upload image data to a separate domain and to comply with JavaScript "same origin" restrictions.
CORS maintains stringent rules about what constitutes a cross-origin request. The browser can require CORS headers when uploading to the same server the editor is hosted on. For example:
The upload script URL origin must exactly match the origin of the URL in the address bar, or the browser will require CORS headers to access it. Use a relative URL to specify the script address instead of an absolute one to guarantee this.
All supported browsers print messages to the JavaScript console if there is a CORS error.
The PHP Upload Handler Script provided here configures CORS in the $accepted_origins
variable. Configure CORS at the web application layer or the HTTP server layer.
W3C Wiki - CORS Enabled
MDN - HTTP access control (CORS)
W3C - Cross-Origin Resource Sharing Specification