Getting started with IvoryCKEditorBundle

4.0 version
Maintained

Getting started with IvoryCKEditorBundle

Overview

The bundle integrates CKEditor into Symfony via the Form Component. It automatically registers a new type called ckeditor which can be fully configured. This type extends the textarea one, meaning all textarea options are available.

Here, an example where we customize the CKEditor config:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
// Symfony 2.7 and previous versions
$builder->add('field', 'ckeditor', array(
    'config' => array(
        'uiColor' => '#ffffff',
        //...
    ),
));

// Symfony 2.8 and newer versions
use Ivory\CKEditorBundle\Form\Type\CKEditorType;

$builder->add('field', CKEditorType::class, array(
    'config' => array(
        'uiColor' => '#ffffff',
        //...
    ),
));

Note

If you're using PHP < 5.5 and Symfony 2.8+, you must rely on Ivory\CKEditorBundle\Form\Type\CKEditorType instead of CKEditorType::class as this constant does not exist.

Installation

To install the bundle, please, read the Installation documentation.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.