The Commands

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.

Note: This information is intented for programmers interested in modifying the CKFinder core.
If you are interested in installing/configuring CFKinder, please take a look at the Developer's Guide.

The Commands

The current CKFinder throws several commands to the server side connectors. All commands expect XML formatted responses, with a few exceptions:

  • Init: this is the first command issued by CKFinder. It returns the general settings of the connector and all configured resource types.
  • GetFolders: gets the list of the children folders of a folder.
  • GetFiles: similar to the above command, gets the list of the children files of a folder.
  • CreateFolder: creates a child folder.
  • RenameFolder: renames a folder.
  • DeleteFolder: deletes a folder.
  • RenameFile: renames a file.
  • DeleteFile: deletes a file.
  • CopyFiles copies files.
  • MoveFiles moves files.
  • FileUpload (non XML): adds a file in a folder.
  • QuickUpload (non XML): adds a file in a folder.
  • DownloadFile (non XML): downloads a file from the server.
  • Thumbnail (non XML): downloads the thumbnail of an image file.

All security and ACL checks must be done before executing any of the above commands. For ACL related attributes, see “ACL – Access Control List” later in this documentation.

This page was last edited on 14 May 2010, at 21:02.