Difference between revisions of "Template:CKFinder 2.x Writing Plugins Introduction"

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.

(Article contents proof-read and formatted)
(Article contents proof-read)
 
Line 1: Line 1:
CKFinder functionality can be extended with server-side plugins. Although the full source code of the CKFinder server connector is available and can be changed in any way, a much better way of enhancing the CKFinder connector is to create a plugin.
+
CKFinder functionality can be extended with server-side plugins. Although the full source code of the CKFinder server connector is available and can be modified in any way desired, a much better way of enhancing the CKFinder connector is to create a plugin.
  
 
The main advantages of plugins are:
 
The main advantages of plugins are:
 
* Upgrades are much easier.
 
* Upgrades are much easier.
* The plugin code is in a single place.
+
* The plugin code is stored in a single place.
* Plugins can be easily turned off when are not needed anymore.
+
* Plugins can be easily disabled when they are not needed anymore.
  
 
Common use cases:
 
Common use cases:
* Adding a new server side command (i.e. <code>fileditor</code> and <code>imageresize</code> plugin).
+
* Adding a new server-side command (i.e. <code>fileditor</code> and <code>imageresize</code> plugin).
* Working with uploaded file (i.e. <code>watermark</code> plugin).
+
* Working with uploaded files (i.e. <code>watermark</code> plugin).
* Extending the information returned by the <code>Init</code> command (i.e. <code>imageresize</code> plugin).
+
* Extending information returned by the <code>Init</code> command (i.e. <code>imageresize</code> plugin).

Latest revision as of 07:09, 18 May 2011

CKFinder functionality can be extended with server-side plugins. Although the full source code of the CKFinder server connector is available and can be modified in any way desired, a much better way of enhancing the CKFinder connector is to create a plugin.

The main advantages of plugins are:

  • Upgrades are much easier.
  • The plugin code is stored in a single place.
  • Plugins can be easily disabled when they are not needed anymore.

Common use cases:

  • Adding a new server-side command (i.e. fileditor and imageresize plugin).
  • Working with uploaded files (i.e. watermark plugin).
  • Extending information returned by the Init command (i.e. imageresize plugin).
This page was last edited on 18 May 2011, at 07:09.