Custom File Browser

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

CKEditor can be easily integrated with your own file browser.

To connect already compatible file browser with CKEditor (like CKFinder), simply follow the File Browser (Uploader) documentation.

Interaction between CKEditor and File Browser

CKEditor sends automatically some additional arguments to the filebrowser:

  • CKEditor - name of the CKEditor instance
  • langCode - CKEditor language ("en" for English)
  • CKEditorFuncNum - anonymous function number used to pass the url of a file to CKEditor
CKEditor=editor1&CKEditorFuncNum=1&langCode=en

Passing the URL of selected file

To send back the file url from an external file browser, simply call CKEDITOR.tools.callFunction and pass there CKEditorFuncNum as the first argument: 

window.parent.CKEDITOR.tools.callFunction( funcNum, fileUrl [, data] );

If data (the third argument) is a string, it will be displayed by CKEditor (usually used to display an error message if problem occurs during file upload).

Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKEditor_3.x/Developers_Guide/File_Browser_(Uploader)/Custom_File_Browser&oldid=2762"