Skip to content
  • About
    • What is Symfony?
    • Community
    • News
    • Contributing
    • Support
  • Documentation
    • Symfony Docs
    • Symfony Book
    • Screencasts
    • Symfony Bundles
    • Symfony Cloud
    • Training
  • Services
    • SensioLabs Professional services to help you with Symfony
    • Platform.sh for Symfony Best platform to deploy Symfony apps
    • SymfonyInsight Automatic quality checks for your apps
    • Symfony Certification Prove your knowledge and boost your career
    • Blackfire Profile and monitor performance of your apps
  • Other
  • Blog
  • Download
sponsored by SensioLabs
  1. Home
  2. Documentation
  3. Bundles
  4. FOSCKEditorBundle
  5. Plugin support
  • Documentation
  • Book
  • Reference
  • Bundles
  • Cloud

Table of Contents

  • Install the Plugin
  • Register the Plugin
  • Plugin dependency
  • Plugin icon

Plugin support

Edit this page

Plugin support

The bundle offers you the ability to manage extra plugins. To understand how it works, you will enable the Wordcount plugin for our CKEditor widget.

Install the Plugin

First, you need to download and extract it in the web directory. For that, you have two possibilities:

  1. Directly put the plugin in the web directory (/web/ckeditor/plugins/ for example).
  2. Put the plugin in the /Resources/public/ directory of any of your bundles.

Register the Plugin

In order to load it, you need to specify its location. For that, you can do it globally in your configuration:

1
2
3
4
5
6
7
8
9
10
# app/config/config.yml
fos_ck_editor:
    default_config: my_config
    configs:
        my_config:
            extraPlugins: "wordcount"
    plugins:
        wordcount:
            path:     "/bundles/mybundle/wordcount/" # with trailing slash
            filename: "plugin.js"

Or you can do it in your widget:

1
2
3
4
5
6
7
8
9
10
11
$builder->add('field', 'ckeditor', array(
    'config' => array(
        'extraPlugins' => 'wordcount',
    ),
    'plugins' => array(
        'wordcount' => array(
            'path'     => '/bundles/mybundle/wordcount/', // with trailing slash
            'filename' => 'plugin.js',
        ),
    ),
));

Plugin dependency

Once your plugin is installed and registered, you will also need to install and register these dependencies. Hopefully, the wordcount has no extra dependency but other plugin can require extra ones. So if it is the case, you need to redo the process for them and so on.

Plugin icon

If you don't configure a built-in toolbar or a custom toolbar, the plugin icon should be visible automatically according to the plugin configuration otherwise, it is your responsibility to configure it. Take a look to this documentation.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version
    We stand with Ukraine.
    Version:
    Check Code Performance in Dev, Test, Staging & Production

    Check Code Performance in Dev, Test, Staging & Production

    Peruse our complete Symfony & PHP solutions catalog for your web development needs.

    Peruse our complete Symfony & PHP solutions catalog for your web development needs.

    Symfony footer

    ↓ Our footer now uses the colors of the Ukrainian flag because Symfony stands with the people of Ukraine.

    Avatar of Bert Hekman, a Symfony contributor

    Thanks Bert Hekman for being a Symfony contributor

    1 commit • 10 lines changed

    View all contributors that help us make Symfony

    Become a Symfony contributor

    Be an active part of the community and contribute ideas, code and bug fixes. Both experts and newcomers are welcome.

    Learn how to contribute

    Symfony™ is a trademark of Symfony SAS. All rights reserved.

    • What is Symfony?

      • Symfony at a Glance
      • Symfony Components
      • Case Studies
      • Symfony Releases
      • Security Policy
      • Logo & Screenshots
      • Trademark & Licenses
      • symfony1 Legacy
    • Learn Symfony

      • Symfony Docs
      • Symfony Book
      • Reference
      • Bundles
      • Best Practices
      • Training
      • eLearning Platform
      • Certification
    • Screencasts

      • Learn Symfony
      • Learn PHP
      • Learn JavaScript
      • Learn Drupal
      • Learn RESTful APIs
    • Community

      • SymfonyConnect
      • Support
      • How to be Involved
      • Code of Conduct
      • Events & Meetups
      • Projects using Symfony
      • Downloads Stats
      • Contributors
      • Backers
    • Blog

      • Events & Meetups
      • A week of symfony
      • Case studies
      • Cloud
      • Community
      • Conferences
      • Diversity
      • Documentation
      • Living on the edge
      • Releases
      • Security Advisories
      • SymfonyInsight
      • Twig
      • SensioLabs
    • Services

      • SensioLabs services
      • Train developers
      • Manage your project quality
      • Improve your project performance
      • Host Symfony projects

      Deployed on

    Follow Symfony

    Search by Algolia