vBulletin Mods

The Official vBulletin Modifications Site
https://www.vbulletin.org/forum/showthread.php?t=278828

[HOW-TO - vB4] Create a Custom Button for CK Editor (no file edits)
by cellarius
19 Feb 2012 15:58

This article explains how to add or remove buttons from CKEditor by using Ckeditor and vBulletin plugins. No standard file edits needed.

To add a button to CKEditor, you need to create a CKE plugin. This is an example code for such a plugin. It will add "Hello World" to the editor and spawn a JS alert.
Important note: This article is on the technique of adding a button, not on how you will get your button to do whatever it is you want it to do. There are plenty sites out there that give support for CKEditor plugins. The CKE API documentation can be found here.



First step: Create the CKEditor plugin

The editor plugin files reside in the folder [forumroot]/clientscript/ckeplugins. Create a new folder in there. For the purpose of this article, I'll name it celButtonDemo. Inside that folder, create a file called plugin.js. So you end up with this:
[forumroot]/clientscript/ckeplugins/celButtonDemo/plugin.js
Important note: Please take notice that "celButtonDemo" will have to be replaced in the folder name and in the following code examples accordingly!.

Inside plugin.js goes the plugin code:

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.



Second step: vB Operations - register your button, add it to the toolbar, and more

In a second step we will create two vB plugins and a vB phrase. You should bundle all that together to a product, to have it all nicely together.

Let's start with the phrase: Go to AdminCP, create a phrase in the CKEditor phrase group, and name it CelButtonDemo. Enter "Hello World, hello Button" - or whatever. Save. Done.

Then create a new plugin at hook "editor_construct". This will add our button to the CKE configuration.


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

OK, now let's create the second plugin at hook "editor_toolbar_filter":
In this example, our button will be inserted after the Quote-Button. Your options to place the button can be found in /vb/ckeditor.php. See line 7 in the following code:


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Last, not least, we need a nice little icon for our button. Upload that to /images/buttons and name it celButtonsDemo.png. Dimensions: 21x21 px.



Result (Screencast):
http://screencast-o-matic.com/watch/clnqDcazQ



Removing buttons

The technique used above to add the button can also be used to remove a button. Example: Removing the image button would look like that (hook "editor_toolbar_filter")


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Please note that removing the button will not render the attached bbcode inactive! However, you can use

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

at hook editor_construct to remove plugins.



Restricting buttons by editor-mode or usergroup

You have everything available to you in the vB-universe to restrict access to your button, just extend the if-condition. You can restrict by usergroup, or you can show a button only in a certain editor

The editor mode can be queried via $this->editor_type in plugins at editor_toolbar_filter:
fe = full
qr = quick reply
qe = quick edit
cms_article

Example:


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.


Have fun!
cellarius
.
.

Princeton 20 Feb 2012 14:27

A lot of people will find this helpful. :up:

Great article!

Lynne 20 Feb 2012 16:26

Nice! Thanks for taking the time to write this all out. :)

cellarius 20 Feb 2012 17:46

Thought I'd save everyone else some time and effort. :)

socialteenz 22 Feb 2012 01:57

Thanks Cellarius for the neat writeup!

abdobasha2004 24 Mar 2012 19:50

this is real nice coding...thanks a lot :)

Sworm 11 Apr 2012 12:42

Hi all, i don't know if this is the correct place, but i want to ask here.... This hack is super, but i have only need to add the "code" (standard vbulletin bbcode) in my QR - QE.

I have addedd in my qe and qr my custom bbcode (like spoiler for example) just adding this plugin via vbulletin ACP

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

on the editor_construct hook. It's work fine for me.... but i have triyed to add the "code" button in my QE and QR without fortune .... Nobody can suggest me how to add just only the code button in qr and qe? Thanks

Lynne 11 Apr 2012 15:50

Quote:

Originally Posted by Sworm (Post 2319001)
Nobody can suggest me how to add just only the code button in qr and qe? Thanks

Did you try what I have written in my Quick Tip here - http://www.vbulletin.org/forum/showthread.php?t=265865

Sworm 11 Apr 2012 19:49

Yes i did.... but please lynne, can u check my last post if mine it is a correct solution? Thanks

cstreater 02 Jul 2012 03:55

Great article, and I was able to accomplish what I wanted to accomplish for a single button. However, what if I wanted to add 3-4 buttons? Do I need to create unique JS files and plug-in's for each?

cellarius 02 Jul 2012 06:58

Yes.

cstreater 02 Jul 2012 06:59

Thanks. Got it working great.

Badshah93 02 Jul 2012 08:20

Quote:

Originally Posted by cstreater (Post 2344420)
Great article, and I was able to accomplish what I wanted to accomplish for a single button. However, what if I wanted to add 3-4 buttons? Do I need to create unique JS files and plug-in's for each?

you can do it with one js file also, like i have done it in this mod.

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.


cstreater 02 Jul 2012 22:37

Quote:

Originally Posted by Badshah93 (Post 2344449)
you can do it with one js file also, like i have done it in this mod.

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

This is awesome. Thanks to both of you :)

cstreater 05 Jul 2012 00:21

Back again -- I can't get this permissions piece of the code to work:


Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

If I include that line, the code that follows does not execute for anyone, regardless of group. I've been trying to figure this out for a while now, and I'm totally stuck.


All times are GMT. The time now is 08:08.

Powered by vBulletin® Version 3.8.14
Copyright © 2021, MH Sub I, LLC dba vBulletin. All Rights Reserved. vBulletin® is a registered trademark of MH Sub I, LLC
Copyright ©2001 - , vbulletin.org. All rights reserved.