How To Install And Use CKEditor In Laravel

Do you want to install CKEditor in Laravel? CKEditor is a WYSIWYG(what you see is what you get) HTML editor that allows us to write rich text formats. In this article, I show you how to install and use CKEditor in Laravel.

Why Need to Use CKEditor?

The rich text editor is necessary to write rich content for your pages or articles. On the web page, we need to have different elements like images, paragraphs, links, etc. All these different elements can be added using the CKEditor.

HTML provides a textarea element for writing description. But, it comes with limitations. In textarea, it’s not easy and user-friendly to write other HTML elements like p, div, img, etc.

To overcome such limitations, you can use CKEditor which itself is a rich text editor. Our final editor will look like the below screenshot.

Laravel CKEditor

Install CKEditor In Laravel

There are 2 ways to install CKEditor in Laravel – CDN or CKEditor package. You can get both resources from their download page.

CDN link is //cdn.ckeditor.com/4.14.0/standard/ckeditor.js. If you go for CDN you don’t need to download anything from the CKEditor website.

If you intend to install it without CDN then download the package(Standard Package recommended). Next, create a folder ‘ckeditor’ under the ‘public’ directory of your Laravel project. And inside this ‘ckeditor’ folder copy below files and folders from the downloaded package.

CKEditor Files

How to Use CKEditor

At this stage, you have completed the steps for installing the CKEditor package. Now let’s see how to use the CKEditor.

Let’s say you have a ‘textarea’ that should get replaced by CKEditor. To do so I am adding id ‘summary-ckeditor’ to the ‘textarea’.

<textarea class="form-control" id="summary-ckeditor" name="summary-ckeditor"></textarea>

Next, you need to include ckeditor.js file and write a JavaScript code that replaces ‘textarea’ with CKEditor.

<script src="{{ asset('ckeditor/ckeditor.js') }}"></script>
<script>
CKEDITOR.replace( 'summary-ckeditor' );
</script>

Above JavaScript code replaces textarea with the CKEditor. If you want to use CDN then above code would be as follow:

<script src="//cdn.ckeditor.com/4.14.0/standard/ckeditor.js"></script>
<script>
CKEDITOR.replace( 'summary-ckeditor' );
</script>

Run your page on the browser and you should now be able to see the CKeditor. You can now add your content to the editor and use it on your website.

Upload and Insert Image in CKEditor

CKEditor by default does not give the option to upload the image. If someone is looking to give this option then keep reading this article. It needs to add a Laravel route, write a code for image upload, and some JavaScript to your application. First, to enable the image upload option you need to call CKEditor in the following way.

<script>
CKEDITOR.replace( 'summary-ckeditor', {
    filebrowserUploadUrl: "{{route('upload', ['_token' => csrf_token() ])}}",
    filebrowserUploadMethod: 'form'
});
</script>

Here for the key filebrowserUploadUrl I passed the route URL and csrf token. Let’s define the route ‘upload’.

Route::post('ckeditor/image_upload', 'CKEditorController@upload')->name('upload');

Reload the page. Now if you click on CKEditor’s image icon you will see the image upload option as shown below.

Image Upload in CKEditor

In order to use the uploaded image in CKEditor, you need to upload the image in your application folder and send back an image URL. For storing an image on a server, I’ll use the Laravel storage feature. So first I need to create a symlink of a ‘storage’ folder. Run the command below to create a symlink:

php artisan storage:link

Our route ‘upload’ map with the upload method of CKEditorController. So create a controller CKEditorController and define upload method in it as follows:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class CKEditorController extends Controller
{
    public function upload(Request $request)
    {
        if($request->hasFile('upload')) {
            //get filename with extension
            $filenamewithextension = $request->file('upload')->getClientOriginalName();
     
            //get filename without extension
            $filename = pathinfo($filenamewithextension, PATHINFO_FILENAME);
     
            //get file extension
            $extension = $request->file('upload')->getClientOriginalExtension();
     
            //filename to store
            $filenametostore = $filename.'_'.time().'.'.$extension;
     
            //Upload File
            $request->file('upload')->storeAs('public/uploads', $filenametostore);

            $CKEditorFuncNum = $request->input('CKEditorFuncNum');
            $url = asset('storage/uploads/'.$filenametostore);
            $msg = 'Image successfully uploaded';
            $re = "<script>window.parent.CKEDITOR.tools.callFunction($CKEditorFuncNum, '$url', '$msg')</script>";
            
            // Render HTML output
            @header('Content-type: text/html; charset=utf-8');
            echo $re;
        }
    }
}

That’s it now try to upload the image from CKEditor’s built-in image option and you will get the image added in your editor.

I hope you understand how to install and use CKEditor in Laravel. Please share your thoughts and suggestions in the comment below.

Related Articles

If you liked this article, then please subscribe to our YouTube Channel for video tutorials.

52 thoughts on “How To Install And Use CKEditor In Laravel

  1. I try this one on windows, then it functions well but when i put it on linux server the image upload does not function.
    can some one help me?

  2. Good system, but I need code highlighting for programming languages. Please tell me how to implement code highlighting in ckeditor, for example php, css, sql, html. P.S. everything is simple: 1) add a plugin to ckeditor. 2) add the language selection button to the ckeditor panel. 3) Then add everything to the vendor. http: / / ckeditor. com / ke4/addon/prism

  3. I save the images to the Storage folder and they are physically deposited there, already run in CMD $ php artisan storage: link, the folder pointing to storage was created, but even so when I enter the URL of the uploaded image it marks me 404 error, I’m sure the route is correct

  4. Not Found
    The requested URL /blog/ckeditor/image_upload was not found on this server.

    Apache Server at localhost Port 80

    1. I don’t have their full package so never tested with it. But I believe you need to copy files, folders from your full package to public/vendor/unisharp/laravel-ckeditor directory.

    1. Image upload feature does not come default in CKEditor. It needs customization. We’ll try to publish an article on this topic soon.

  5. hello
    editor worked and save data in database , but when i want show text on front page . show html tag in page
    like ” some ting ”
    don’t hidden html tag .
    how i can fix that problem ?

  6. i use ck editor for in laravel but i have a problem is aries . all the tag are display in the view hoe to hide such display tab in my view page

  7. The Editor works okay but is saving the HTML tags as well to the Database. Is there a way to trim of the HTML tags when rendering the Database response in the blade view?

  8. i keep on getting this error
    Class ‘Unisharp\Ckeditor\ServiceProvider::class’ not found
    how can this be fixed?

Leave a Reply

Your email address will not be published. Required fields are marked *