Posted:September 6, 2006

Extending TinyMCE, the WordPress Rich Text Editor

NOTE: I have posted a major cleanup and update of what is now called the Advanced TinyMCE Editor, tested beginning with WP v. 2.2. Obtain the plug-in download and documentation HERE. The update announcement is now the best place to post new online comments and discussion. Let me know what you think! MKB

Author’s Note: There is a zipped plugin, code and documentation that supports the information in this post, which will allow you to extend the functionality of your TinyMCE rich text editor in WordPress; for immediate instructions see the end of the post below.
Download Extended TinyMCE code file Click here (NOW DISABLED!) to download the zipped file (101 KB)

My most recent post was about the smooth upgrade to WordPress v. 2.0.4 for my blog software and noted my popular Comprehensive Guide to a Professional Blog Site recounting my own experiences setting up, configuring and maintaining my own blog site. A key aspect of that earlier Guide dealt with (what I perceived to be) an oversight in older versions of WordPress that lacked a bundled WYSIWYG editor. For my own site and installation, I had chosen the Xinha editor, and had devoted a number of entries in the Guide to its configuration and use.

However, as of WordPress version 2x, the developers have now chosen to bundle the proven Javascript rich text editor, TinyMCE, as part of the standard distribution package. Since I had come to rue some of the aspects of Xinha in my earlier implementation (namely, bad HTML for carriage returns and VERY slow times when publishing a post), I decided to give TinyMCE a go as my new replacement editor.

(Actually, this was not such a major shift since we had adopted a sibling TinyMCE application, the Joomla Content Editor (JCE), for the Joomla-based BrightPlanet corporate Web site.)

As implemented, the TinyMCE editor in WordPress is configured more akin to the prior QuickTags feature set, with the few available editing functions being bold, underline, bullets, text alignment, and so forth. Here is a screen shot from my WordPress administration center with TinyMCE as delivered with WordPress v. 2.0.4:

The only problem is that I have become used to editing support for items such as tables, image manipulation, special characters, font types, and so forth. While I (generally) edit and clean up the HTML before final posting, I very much enjoy the productivity benefits of a more full-featured WYSIWYG editor. So, the rhetorical question to myself was: If I’m going to use TinyMCE, how can I extend its functionality?

The Investigations Begin

Having been familiar with other TinyMCE instantiations, I began my investigations with the (as it turns out naive) assumption that upgrading to a full featured TinyMCE would be a snap. Boy, was I wrong.

I first began with the TinyMCE Web site itself checking out the standard distribution package. Like many open source sites, I found the online documentation for TinyMCE to be fragmented, incomplete and hard to navigate. I looked under the ‘Plugins’ tab and found it was documentation for developers in creating a new plugin. My first lead came from the online manual (which can also be downladed for local browsing) and its reference to installation options, specifically these options at the bottom of that page:

Bingo! Clearly, TinyMCE had the advanced features I was seeking and they were packaged as part of the direct TinyMCE distribution to boot! Now I assumed my only needed step was to find how to “turn on” these features in my WordPress installation.

What Was Learned
This line of thinking led me to an unfortunate waste of time in Web search and poking through the forums at both the TinyMCE and WordPress sites. It became clear that the TinyMCE integration in WordPress was both highly tailored and limited to just the simple functionality (Example 00 above). I saw references by others to the “wisdom” of the WordPress developers to making this choice and therefore reducing the overall size of the WordPress download, but I don’t see it that way. It seems rather arbitrary and taking available choices from the user by unilaterally “whittling down” a more fully featured option from Moxiecode. Oh, well.

One dead end among many I pursued was instructions from the TinyMCE staff on integrating Moxiecode’s commercial plugins. That reference — http://tinymce.moxiecode.com/downloads/integration/ — got me way too into specific WordPress code that I was also unable to modify for my specific plugin purposes (though perhaps more capable programmers could have seen a clear path). I also found many requests but little guidance from the WordPress forums.

The first breakthough occurred on the TinyMCE Wishlist postings on the WordPress forum, which led me to the Advanced WYSIWYG plugin by Assaf Arkin of Labnotes. Part of the problem in finding this in the first place was that the actual plugin file name was misspelled as “advacned-wysiwyg”. So, I followed the instructions for the plugin and, voila, it didn’t work!

Grr! More investigation indicated that the likely problem resided in new version 2x plugins for TinyMCE as NOT working with the Advanced WYSIWYG plugin. As Paul Finch reported on the Labnotes site, reverting back to earlier advanced plugins for TinyMCE in versions 1.45 and earlier, which could be found on the Sourceforge download site, solved the problem.

As indeed it does, as this updated editor on my blog administration panel shows:

These “standard” advanced plugins for TinyMCE provide possible functionality beyond the simple installation (marked with an asterisk [*]) (also, ones I could not get to work — but I did not test all of them! — are shown with double asterisks [**]) for:

Default buttons available in the advanced theme:

* bold
italic
* underline
* strikethrough
* justifyleft
* justifycenter
* justifyright
* justifyfull
* bullist
* numlist
outdent
* indent
cut
copy
paste
* undo
* redo
* link
* unlink
* image
cleanup
help
* code
hr
removeformat
formatselect
fontselect
fontsizeselect
styleselect
sub
sup
forecolor
backcolor
charmap
visualaid
anchor
newdocument
separator

Plugins with the button name same as plugin name:

save
emotions
flash
iespell
preview
print
zoom
fullscreen
advhr
fullpage
spellchecker

Plugins with custom buttons:

advlink (will override the “link” button)

advimage (will override the “image” button)

paste

  • pastetext
  • pasteword
  • selectall

** searchreplace

  • search
  • replace

insertdatetime

  • insertdate
  • inserttime

table

  • tablecontrols
  • table
  • row_props
  • cell_props
  • delete_col
  • delete_row
  • col_after
  • col_before
  • row_after
  • row_before
  • row_after
  • row_before
  • split_cells
  • merge_cells

directionality

  • ltr
  • rtl

layer

  • moveforward
  • movebackward
  • absolute
  • insertlayer

** style

  • styleprops

Early Use Observations

With one major exception — and it is MAJOR! — I have generally been pleased with the new TinyMCE editor in its full functionality version. I have been working with it for nearly a week and have completed four or five published posts. The writing of posts is now much quicker. There are no longer problems with line breaks and paragraph formatting. For most functionality, the editor just feels more “solid” than my previous Xinha editor. For all of that, I am very thankful.

The major issue I have encountered is with long posts (such as this one), particularly when I am toggling between the code (HTML) view and WYSIWYG view. Without warning, I will suddenly lose entire portions of text at the bottom of the post. This appears to be either strictly a TinyMCE issue or perhaps an issue related to my Firefox browser that others have noted on the WordPress forum.

Best practices, as I have reported on elsewhere and as part of my Guide, generally suggest drafting long posts external to WordPress anyway, though the loss of any work is distressing. I will monitor this “long posting” issue carefully, and until I see a resolution I will likely save to the clipboard or take other steps to prevent future losses.

Specific Upgrade Instructions

So, because I have generally been pleased with these extensions, I thought I would package and write them up for others to use, saving you the fits and starts I went through. The download at the top of this post includes the instructions and all files noted below. The instructions are included as the readme.txt file in the package. I also chose to make some minor updates to plugin operation (better sizing of popups, for example) and also corrected the spelling error in the file name and allowed for multi-line bullets for the extended TinyMCE in the Advanced WYSIWYW plugin. All of these changes, plus the vetted TinyMCE ver. 1.45 advanced plugins, are included in the distribution. Please note this information is being provided “as is”; you can also only do this if you have direct file access to your WordPress installation.

1. Download the enclosed zip file and unzip it to a clean subdirectory; these instructions are repeated in the enclosed readme.txt file.

2. If you don’t like the button order shown in the image above, you may remove buttons or change ordering or add or remove separator bars by editing the advanced-wysiwyg.php file:

< ?php
/*
Plugin Name: Advanced WYSIWYG Editor
Plugin URI: http://www.labnotes.org/
Description: Adds more styling options to the WYSIWYG post editor, updated for multi-line buttons.
Version: 0.3
Author: Assaf Arkin
Author URI: http://labnotes.org/
License: Creative Commons Attribution-ShareAlike
Tags: wordpress tinymce
*/

if (isset($wp_version)) {
add_filter(“mce_plugins”, “extended_editor_mce_plugins”, 0);
add_filter(“mce_buttons”, “extended_editor_mce_buttons”, 0);
add_filter(“mce_buttons_2”, “extended_editor_mce_buttons_2”, 0);
add_filter(“mce_buttons_3”, “extended_editor_mce_buttons_3”, 0);
}


function extended_editor_mce_plugins($plugins) {
array_push($plugins, “table”, “fullscreen”, “searchreplace”, “advhr”, “advimage”);
return $plugins;
}


function extended_editor_mce_buttons($buttons) {
return array(
“undo”, “redo”, “separator”, “cut”, “copy”, “paste”, “separator”, “bold”, “italic”, “underline”, “strikethrough”, “separator”,
“bullist”, “numlist”, “separator”, “indent”, “outdent”, “separator”,
“justifyleft”, “justifycenter”, “justifyright”, “justifyfull”, “separator”,
“sub”, “sup”, “charmap”, “hr”, “advhr”,”separator”, “link”, “unlink”, “anchor”, “separator”,
“code”, “cleanup”, “separator”, “search”, “replace”, “separator”, “wphelp”);
}

function extended_editor_mce_buttons_2($buttons) {
// the second toolbar line
return array(
“formatselect”, “fontselect”, “fontsizeselect”, “styleselect”, “separator”, “forecolor”, “backcolor”, “separator”,”removeformat”);
}

function extended_editor_mce_buttons_3($buttons) {
// These are the buttons for third toolbar line
return array(
“image”, “separator”, “tablecontrols”, “separator”, “fullscreen”, “wordpress”);
}
?>

3. Copy the resulting advanced-wysiwyg.php file into your standard WordPress plugins directory (wp-content\plugins)

4. Copy all files from the extracted plugins subdirectory to the TinyMCE plugins subdirectory in your WordPress directory (wp-includes\js\tinymce\plugins)

5. Under ‘Plugins’ in your WordPress administrative center, ‘activate’ the Advanced WYSIWYG Editor plugin

6. Now, when you write or manage posts or pages you will have the extended TinyMCE functionality available

7. Enjoy!

Schema.org Markup

headline:
Extending TinyMCE, the WordPress Rich Text Editor

alternativeHeadline:

author:

image:

description:
NOTE: I have posted a major cleanup and update of what is now called the Advanced TinyMCE Editor, tested beginning with WP v. 2.2. Obtain the plug-in download and documentation HERE. The update announcement is now the best place to post new online comments and discussion. Let me know what you think! MKB Author’s Note: […]

articleBody:
see above

datePublished:

58 thoughts on “Extending TinyMCE, the WordPress Rich Text Editor

  1. This is for Halina,

    You can find the ’emotions’ plugin at (for the latest v. 2.061):

    http://tinymce.moxiecode.com/download.php

    Moxiecode’s instructions for installing it is at:

    http://tinymce.moxiecode.com/tinymce/docs/plugin_emotions.html

    I don’t know if this will work without change. If it doesn’t you may want to go to Sourceforge and get an older version; that seemed to work for the plugins I included with my distribution. Older versions at Sourceforge can be found at:

    http://sourceforge.net/project/showfiles.php?group_id=103281

    I know that versions 2.02 and 1.43 of TinyMCE come packaged with this plugin.

    Good luck!

  2. cool! plugins
    merci ÃÆ’ƒÆ’ vous

  3. Halina,

    Follow the instructions for the other plugins per my initial post. You will also need to edit the advanced-wywiwyg.php file by adding ’emotions’ to one of the three button extended_editor_mce_buttons lines.

    Mike

  4. When I alter the button array, I then go to the PlugIns page and the text of the entire php file is shown as the PlugIn file. Any hints?

    The good news is that my altered buttons look OK on the Entry page.

  5. No, unfortunately I do not know why the php file is displaying. Perhaps another reader can offer an explanation.

  6. This is a godsend, specifically for someone like me who’s trying to tailor WordPress into a formidable CMS for clients. Thanks for doing the hard work for us! 😉

  7. Thanks Assaf.

    Just installed and am testing. …

    Works well though slower than no editor at all. Perhaps I will switch on TinyMCE just when I need it.

    One bug I noticed immediately in my set-up.

    When I place an image “right”, the editing window expands too far to the right. The final page is fine, however. This is in Firefox for Mac.

    It is not clear in your notes that I need to CLICK “Use the visual rich editor” when writing on the Your Profile page under USERS. Seems this needs to be on as well as the plugin activated. Yes?

    It is the best yet, no doubt. I appreciate it.

    But the AJAX editing interface I really need (i.e. Writely) is not here yet.

  8. There is something strange. When I use “select color” for text, then Internet Explorer opens new window if I select color. In Firefox if I select color for text then window will close. I was try to fix this bug in wp-includes/js/tinymce/themes/advanced/jscript/color_picker.js, but I cann’t found error. Maybe someone know where I must fix some code?

  9. Great work, now my editor is very complete!
    I have a question: how to integrate in this plugin the “pasteword” button?
    I’ve tried a lot of time, but no result…help me!
    Bye,
    Gigi

  10. I installed the plugin and it looked good – but I had a lot of probelms with teh table insertion

    1. The icons did not appear they were invisible but when I cursored over them the were there

    2. The table gest inserted with no lines so it si really hard to see where you are when you are filling in the table.

    I then could not save/publish the content of a post and decided I would uninstall the plugin.

    Then the defaulyt editor wont either.

    I have re-installed the default wordpress scripts and still I canoto sav/publish posts –

    I get the pop up box that says “You are navigating away from this page and all your conent will be lost..

    What am I missing please ?

  11. I have discovered a possible bug. With EditorMonkey, I had no problem with paragraph tags. With this plugin, I do. They do not get deleted from the posts, but they do not display when the posts are loaded. Instead, there are line breaks (not br tags) separating paragraphs. Obviously, browsers won’t treat those breaks as br tags. Any suggestions?

  12. Here’s a stupid question: How do you get it to work for comments? I added the script to my comments.php but it’s not working.

    (And yes, I refreshed. I even tried 2 different browsers so nyah nyah! 🙂 )

    I’m using WP 2.0.4

    Thanks

  13. The sad part is that now TinyMCE supports Safari browsers (even your linked examples work on Safari), but as the TinyMCE version in WordPress is so “integrated” there is no easy way to use this newer version with it.

    *sigh*

  14. got this Java Script error – Object Doesn’t support this property or method. And all buttons disappeared.

    Anyone can help?

  15. THANK YOU MIKE! Your work is, obviously, saving countless individuals a lot of time (and from the need to “reinvent the wheel” with each installation of Advanced WYSIWYG).

    I had a quick question about the use the “Styles” Drop-down that I haven’t seen mentioned anywhere else.

    While the Styles Dropdown appears within the Advanced WYSIWYG, I have not been able to find where to add/edit the styles in that dropdown menu. It only offers the styles of "mce_plugin_wordpress_more" and "mce_plugin_wordpress_page." So, I guess I need to know BOTH: how do I get that drop-down to list additional styles AND to which CSS file do I add the new styles?

    Thanks again!

  16. Hi, unfortunately, I have to second #42 in the replies section. I have installed v. 2.0.5 WP, but it does not show up after activating the plugin section. I tried installing the wp-includes/tinmce…/plugins (excuse the exact location) using all of your extended plugins in their orig. folder, and with the extended plugins extracted (mixed with the existing folders under the “plugins” section…neither function after activation. I aalso did NO editing to the wp-content/plugins/ .php file, just uploaded it as is.
    Okay, it sounds like it would be super.
    PS: I already have 2 other “attachment plugins” to the whysiwig (spelling?) editor installed, imageManager, and another image upload plugin – i only deactivated one, and tried re-activating your plugin, but it did not work.
    Thanks for any response.
    Claire

  17. Works for me with 2.0.5. It didn’t at first. I had to start a new session of IE and then refresh. Then it worked.
    One thing though, editing posts doesn’t work. Menu goes away and html tags stay. So you really can’t edit posts.
    Any fix for this?

  18. A big thank you for this plugin…works great. However, how do install other plugins like emoticons, flash movie, printing, and preview…. into the TinyMCE?

    Now, that would be just wonderful!

  19. To All,

    I think I now have the file permissions set correctly to download this zip file. I apologize for the snafu.

    I also have tested the file against WP 2.05 and have corrected some popup dialog sizing issues.

    Enjoy, Mike

  20. Hey there. There are still issues with the accessibility of the file. If you want a second download site send me the file via email and I’ll post it on one of my domains for public download access and send you a link so you can post it here as well.

  21. John and Others,

    Thanks for finding still additional download problems and thanks to you, John, for offering to post an alternative download. However, I don’t think that will be necessary and FINALLY the download should work for all browsers.

    It turns out that chmod on my host server needs to be set to allow execution for the zip files for Internet Explorer. The earlier chmod file access settings worked fine with Firefox. Oh, well . . .

    Please post a message if new problems should arise.

    Thanks, Mike

  22. Mike,

    This is perfect! I just installed WP 2.1b1 because I was itching for spellcheck and am tired of Chenpress. I simply added ‘spellchecker’ into the array and it works!

    Thank you so much for making this so easy for the rest of us!

  23. Hi, Thanks for your work and making this available.

    I have installed the plugin; with Firefox I only see buttons for search and replace and the drop-down menus. The style dropdown only shows names of 2 files:
    mce_wordpress_plugin_page
    mce_wordpress_plugin_more

    I emptied the cache and reloaded the page as someone noted abvoe.

    The plugin does work with I.E. except for the Styles dropdown as shown above.

    What’s up with Firefox? 1.5.0.9 If part of the plugin shows why doesn’t all of it? I love the way this plugin sounds and would love for it to work but would hate to have to boot up IE to do that.

  24. TJR,

    I use Firefox myself and have had no problems (v 1.5x and 2.0x). It has also been validated for WP 1.6, 2.0 and 2.1b.

    I guess all I can suggest is re-do the installation, following the steps very carefully. Maybe something else is going on, but I’m afraid I can’t diagnose it further.

    Sorry I can’t be of more help.

    Good luck, Mike

  25. Mike,

    Thanks for the quick reply. I’m still not able to get it to work with Firefox. As with #40 above, Copernicus,
    I still have the issue in the Style dropdown only showing
    mce_wordpress_plugin_page
    mce_wordpress_plugin_more

    This is true for Internet Explorer as well.
    As for the ExtTinyMCE plugin,

    I deleted the plugin completely;

    deactivated all other plugins

    redownloaded from here, reinstalled.

    I also tried deleting the entire TinyMCE subdir. and downloaded another copy and reinstalled that, then again reinstalling the plugin.
    I have javascript allowed and popups also.

    It still doesn’t work completely with Firefox. I realize others have gotten it to work with Firefox — just letting you know what’s up.

  26. TJR,

    Wow, that sounds like alot of work and a royal pain in the ass. Sorry you spent so much time. Let’s hope that someone with more of a clue than I have can diagnose this fix and post it here.

    Oh, well . . . .

    Mike

  27. oops…

    a space at the opening php tag before the ?

    it should be taken out — that is why #12 sees the code as text on the plug in page.

  28. Great Work, Mike, thanks a lot…

    I am maintaining several blogs and CMS-Applications based on WordPress and an enhanced editor has been on the list for quite some time.
    One minor bug – table row props and table cell props delivered a 48px-wide-popup in Firefox 1.5, should have been 480, I discovered after clawing my way through wp-includes/js/tinymce/plugins/table/editor_plugin.js – I have no idea of how Javascript works, but got it working 😉

  29. Hi, Mike,
    Because your plugin wasn’t working for me, I tried the Mudbomb WYSIWYG but had the same problem. One of the comments on that page had the answer. This could help other commenters on this page; perhaps you’d want to put this information in your readme file.

    The Firefox problem is in usercontent.css. Some people may have added the adblocker code, as I had. Here’s the info from the post on Mudbomb:

    I'm fairly sure he's using the userContent.css chunk found here:
    http://www.mozilla.org/support/firefox/adblock
    There's a css selector in there that kills any img element with "/adv" in it's src string.
    As the editing buttons' src path contains "/advanced", it gets selected.
    either delete this line:
    img[src*=”/adv”],
    or, as I did, replace it with:
    img[src*=”/advert”],

    After all this work, I did not reinstall your plugin as the Mudbomb editor is working great now, but I’m assuming this is the reason why yours wouldn’t work for me but did for other Firefox users.

  30. TJR,

    Super thanks for the great detective work. I will add to the next update of the readme file, plus fix the popup sizing mentioned by Peter.

    Thanks, Mike

  31. All what I can see after the installation is: Same buttons (options) as before…but now they just show up as text. No images anymore to press. I tried to install and also reinstall everything but always the same. IE show the same as FF. What ´s wrong ? 🙁 I use WordPress 2.0.6

Leave a Reply

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