Using CKFinder Plugins

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 added)
 
(Java Plugins text corrected)
Line 2: Line 2:
  
 
== Enabling Java Plugins ==
 
== Enabling Java Plugins ==
To add a plugin to CKFinder, upload it to the <code>plugins</code> folder and add it to the <code><plugins></code> element in the XML configuration file (<code>config.xml</code>).
+
To add a plugin to CKFinder, upload its <code>.jar</code> file to the <code>WEB-INF/lib</code> folder and add it to the <code><plugins></code> element in the XML configuration file (<code>config.xml</code>).
  
 
Each plugin is added as a separate <code><plugin></code> element, with <code><name></code>, <code><class></code>, and <code><params></code> parameters set accordingly.
 
Each plugin is added as a separate <code><plugin></code> element, with <code><name></code>, <code><class></code>, and <code><params></code> parameters set accordingly.
Line 22: Line 22:
 
== Related topics ==
 
== Related topics ==
 
* [[/Writing_JavaScript|Writing JavaScript plugins]]
 
* [[/Writing_JavaScript|Writing JavaScript plugins]]
* [[/Writing_PHP|Writing PHP plugins]]
 

Revision as of 11:22, 1 April 2011

CKFinder is a plugin-based application and as such it can be extended relatively easily.

Enabling JavaScript Plugins

To add a plugin to CKFinder, upload it to the plugins folder and enable it by using the extraPlugins configuration option in the config.js file:

CKFinder.customConfig = function( config )
{
	config.extraPlugins = 'dummy';
};

Enabling Java Plugins

To add a plugin to CKFinder, upload its .jar file to the WEB-INF/lib folder and add it to the <plugins> element in the XML configuration file (config.xml).

Each plugin is added as a separate <plugin> element, with <name>, <class>, and <params> parameters set accordingly.

<plugins>
	<plugin>
		<name>imageresize</name>
		<class>com.ckfinder.connector.plugins.ImageResize</class>
		<params>
			<param name="smallThumb" value="90x90"></param>
			<param name="mediumThumb" value="120x120"></param> 
			<param name="largeThumb" value="180x180"></param>
		</params>
	</plugin>
</plugins>

Related topics