Codex

Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Difference between revisions of "TinyMCE"

m (Added Japanese interlanguage link)
(TinyMCE Plugins: update broken TinyMCE 4 docs link)
 
(9 intermediate revisions by 5 users not shown)
Line 15: Line 15:
 
* And generally many improvements everywhere.
 
* And generally many improvements everywhere.
   
There is a [http://www.tinymce.com/presentation/#/ slideshow] and [http://www.tinymce.com/develop/changelog/?type=tinymce changelog] which highlights many of the new features.
+
There is a [https://www.tinymce.com/docs/changelog/#version40-june132013 changelog] which highlights many of the new features.
   
 
== TinyMCE Plugins ==
 
== TinyMCE Plugins ==
 
Generally, there are three groups of TinyMCE plugins added by WordPress plugins:
 
Generally, there are three groups of TinyMCE plugins added by WordPress plugins:
   
* Custom plugin created specifically for the WordPress plugin. If you’ve developed this kind of plugin, please see the [http://www.tinymce.com/wiki.php/Tutorial:Migration_guide_from_3.x 3.x to 4.0] migration guide and the [http://www.tinymce.com/wiki.php/api4:index 4.0 API documentation].
+
* Custom plugin created specifically for the WordPress plugin. If you’ve developed this kind of plugin, please see the [https://www.tiny.cloud/docs-4x/advanced/migration-guide-from-3.x 3.x to 4.0] migration guide and [https://www.tiny.cloud/docs-4x/ the 4.0 API documentation].
 
* WordPress plugins that add third-party or default TinyMCE plugins need to be updated to include the 4.0 version of the plugin. The PHP global $tinymce_version can be used to determine which plugin to load.
 
* WordPress plugins that add third-party or default TinyMCE plugins need to be updated to include the 4.0 version of the plugin. The PHP global $tinymce_version can be used to determine which plugin to load.
 
* Mini-plugins that only add a button to the toolbar. This works pretty much the same. It is advisable to update to use the ‘dashicons’ icon font instead of image icon.
 
* Mini-plugins that only add a button to the toolbar. This works pretty much the same. It is advisable to update to use the ‘dashicons’ icon font instead of image icon.
Line 38: Line 38:
 
There is a simple (if you understand the Plugin API and hooks) means of adding your own buttons to TinyMCE in WordPress on the [[TinyMCE Custom Buttons]] page. See also [[Plugin_API/Filter_Reference#Rich_Text_Editor_Filters|Plugin API Rich Text Editor Filters]] for more information.
 
There is a simple (if you understand the Plugin API and hooks) means of adding your own buttons to TinyMCE in WordPress on the [[TinyMCE Custom Buttons]] page. See also [[Plugin_API/Filter_Reference#Rich_Text_Editor_Filters|Plugin API Rich Text Editor Filters]] for more information.
   
A detailed tutorial is also available on [http://wp.tutsplus.com/tutorials/theme-development/guide-to-creating-your-own-wordpress-editor-buttons/ WP Tuts +]
+
A detailed tutorial is also available on [http://code.tutsplus.com/tutorials/guide-to-creating-your-own-wordpress-editor-buttons--wp-30182 WP Tuts +] and [https://www.gavick.com/blog/wordpress-tinymce-custom-buttons#tmce-section-1 here ]
   
 
== Advanced Editing Plugins ==
 
== Advanced Editing Plugins ==
Line 61: Line 61:
 
* On specific Template pages
 
* On specific Template pages
 
* With specific page items
 
* With specific page items
 
 
Options Include:
 
 
* [http://redrokk.com/2010/08/16/removing-p-tags-in-wordpress/ Removing P Tags in WordPress]
 
   
 
You may also find plugins to assist with this at [http://wordpress.org/extend/plugins/ WordPress Plugins]
 
You may also find plugins to assist with this at [http://wordpress.org/extend/plugins/ WordPress Plugins]
Line 102: Line 97:
 
== Change Log ==
 
== Change Log ==
   
  +
* [[Version 4.8|WordPress 4.8]]: TinyMCE 4.6.2
  +
* [[Version 4.5.1|WordPress 4.5.1]]: TinyMCE 4.3.10
  +
* [[Version 4.5|WordPress 4.5]]: TinyMCE 4.3.8
 
* [[Version 4.0|WordPress 4.0]]: TinyMCE 4.1.3
 
* [[Version 4.0|WordPress 4.0]]: TinyMCE 4.1.3
 
* [[Version 3.9|WordPress 3.9]]: TinyMCE 4.0
 
* [[Version 3.9|WordPress 3.9]]: TinyMCE 4.0

Latest revision as of 03:17, 31 March 2023

WordPress is bundled with the open source HTML WYSIWYG editor TinyMCE by Moxiecode Systems, AB.

TinyMCE 4

WordPress 3.9 was released with a major update to TinyMCE version 4.0 in WordPress core. TinyMCE version 4 provides many changes:

  • New UI and UI API.
  • New theme.
  • Revamped events system/API.
  • Better code quality, readability and build process.
  • Lots of (inline) documentation.
  • And generally many improvements everywhere.

There is a changelog which highlights many of the new features.

TinyMCE Plugins

Generally, there are three groups of TinyMCE plugins added by WordPress plugins:

  • Custom plugin created specifically for the WordPress plugin. If you’ve developed this kind of plugin, please see the 3.x to 4.0 migration guide and the 4.0 API documentation.
  • WordPress plugins that add third-party or default TinyMCE plugins need to be updated to include the 4.0 version of the plugin. The PHP global $tinymce_version can be used to determine which plugin to load.
  • Mini-plugins that only add a button to the toolbar. This works pretty much the same. It is advisable to update to use the ‘dashicons’ icon font instead of image icon.

Advanced Editing Buttons

Looking for more buttons in the WYSIWYG editor? You can toggle the Advanced Editor Toolbar (row 2 of the editor) and unlock a dozen or so extra buttons.

Simply hover over each button in the toolbar, noting the tooltips. When you see "Toggle Toolbar" as a tooltip, click that button. Note the purpose of this button is to expand/collapse row 2 of the editor buttons.

If the "Toggle Toolbar" button is moved to another row of the editor (via custom hooks or filters), it's possible clicking the button will remove all editor button rows. In this case; you must use Alt-V (IE) or Shift-Alt-V (Firefox) to toggle the advanced buttons back "on".

In WP version 3.3.1 the correct toggle command for IE and Firefox is Shift-Alt-Z.

Adding Buttons

There is a simple (if you understand the Plugin API and hooks) means of adding your own buttons to TinyMCE in WordPress on the TinyMCE Custom Buttons page. See also Plugin API Rich Text Editor Filters for more information.

A detailed tutorial is also available on WP Tuts + and here

Advanced Editing Plugins

If the Advanced Editing Toolbar buttons are not sufficient, and writing your own buttons isn't your thing, perhaps you're looking for a plugin to extend the functionality of the TinyMCE editor. Examples include:

You can find more in the WordPress Plugin Directory.

Automatic use of Paragraph Tags

By default Wordpress & the TinyMCE WYSIWYG editor will automatically add paragraph tags ( P tags or <p> ) around line breaks. This default functionality was installed to assist new users in adhering to standard coding principles.

For many advanced users there are times when the additional spacing caused by paragraph tags interferes with the overall design of the site. For these users the ability to remove the automatic use of P tags or a specific use of P tags is required.

In the case where P tags are disabled completely the user will then be responsible for manually adding paragraph tags themselves via the Text editor instead.

There are 3 primary options for removing P tags. These include:

  • Through out entire site
  • On specific Template pages
  • With specific page items

You may also find plugins to assist with this at WordPress Plugins

Customize TinyMCE with Filters

If you want to customize which buttons are shown in the editor, or you want to use a custom css file to stylize the visual editor contents, or to prevent tinyMCE from removing styles, spans, etc.. or to customize every aspect of TinyMCE, you can modify the init settings array with the use of the filter tiny_mce_before_init.

You can see the default settings in /wp-includes/class-wp-editor.php, here are some options.

function my_format_TinyMCE( $in ) {
	$in['remove_linebreaks'] = false;
	$in['gecko_spellcheck'] = false;
	$in['keep_styles'] = true;
	$in['accessibility_focus'] = true;
	$in['tabfocus_elements'] = 'major-publishing-actions';
	$in['media_strict'] = false;
	$in['paste_remove_styles'] = false;
	$in['paste_remove_spans'] = false;
	$in['paste_strip_class_attributes'] = 'none';
	$in['paste_text_use_dialog'] = true;
	$in['wpeditimage_disable_captions'] = true;
	$in['plugins'] = 'tabfocus,paste,media,fullscreen,wordpress,wpeditimage,wpgallery,wplink,wpdialogs,wpfullscreen';
	$in['content_css'] = get_template_directory_uri() . "/editor-style.css";
	$in['wpautop'] = true;
	$in['apply_source_formatting'] = false;
        $in['block_formats'] = "Paragraph=p; Heading 3=h3; Heading 4=h4";
	$in['toolbar1'] = 'bold,italic,strikethrough,bullist,numlist,blockquote,hr,alignleft,aligncenter,alignright,link,unlink,wp_more,spellchecker,wp_fullscreen,wp_adv ';
	$in['toolbar2'] = 'formatselect,underline,alignjustify,forecolor,pastetext,removeformat,charmap,outdent,indent,undo,redo,wp_help ';
	$in['toolbar3'] = '';
	$in['toolbar4'] = '';
	return $in;
}
add_filter( 'tiny_mce_before_init', 'my_format_TinyMCE' );

Change Log

See Also

External Resources

Related

This article is marked as in need of editing. You can help Codex by editing it.