Contributors: black-studio, marcochiesi, thedarkmist
Donate link: https://www.blackstudio.it/en/wordpress-plugins/black-studio-tinymce-widget/
Tags: widget, visual, editor, wysiwyg, html, text, tinymce, image, media, gallery, embed, wpml
Requires at least: 3.1
Tested up to: 5.3
Requires PHP: 5.2
Stable tag: 2.6.9
License URI: https://www.gnu.org/licenses/gpl.html
The visual editor widget for WordPress.
== Description ==
This plugin adds a new `Visual Editor` widget type that allows you to insert rich text and media objects in your sidebars with no hassle. With Black Studio TinyMCE Widget you will be able to edit your widgets in a WYSIWYG manner using the native WordPress TinyMCE editor, just like you do in posts and pages. And if you are a developer you may still switch back and forth from Visual to HTML mode.
For years the default WordPress text widget has been very basic and it required HTML knowledge to add formatting and images/media to the text. This plugin was born in 2011 to overcome these limitations. After a long time, in June 2017, version 4.8 of WordPress finally introduced a new text widget that included the ability to manage text widgets with the visual editor. The new widget available in WordPress core could now be used as a basic replacement of Black Studio TinyMCE Widget, but the plugin still offers some additional features, so it remains a must-have for advanced users.
= Basic Features =
* Add rich text widgets to your sidebars and edit them using the TinyMCE visual editor
* Switch between Visual mode and HTML mode (including Quicktags toolbar)
* Insert images, videos, and other media from WordPress Media Library
* Insert links to existing WordPress pages/posts or external resources
* Support for shortcodes, smilies and embed in widget text (including preview)
* Support for Customizer with live preview and quick edit
* Support for widgets accessibility mode
* Compatible with multi-site (WordPress networks)
* Compatible with the most common multi-language plugins
* Compatible with Page Builder plugin by SiteOrigin
* Translations available in 20+ languages
= Advanced Features =
These features are what makes this plugin better than the WordPress (4.8+) native widget:
* Full featured TinyMCE Visual Editor (the same you have for pages and posts)
* Wide text area for an enhanced editing experience
* Compatible with 3rd party TinyMCE customization plugins (TinyMCE Advanced, WP Edit, ...)
* Support for distraction-free (fullscreen) editing mode
* Option to "Automatically add paragraphs" to widget text
= About the plugin =
The story of the plugin was featured in a talk at WordCamp Europe 2018 in Belgrade.
See the video [Once upon a time, there was a plugin...](https://wordpress.tv/2018/07/11/francesco-canovi-marco-chiesi-once-upon-a-time-there-was-a-plugin/) on WordPress.tv.
= Links =
* [Author's web site](https://www.blackstudio.it/en/)
* [Plugin's page](https://www.blackstudio.it/en/wordpress-plugins/black-studio-tinymce-widget/)
* [Support forum](https://wordpress.org/support/plugin/black-studio-tinymce-widget)
* Follow us on [Twitter](https://twitter.com/blackstudioita), [Facebook](https://www.facebook.com/blackstudiocomunicazione), [LinkedIn](https://www.linkedin.com/company/black-studio) and [GitHub](https://github.com/black-studio)
= Get involved =
* Developers can contribute to the source code on our [GitHub repository](https://github.com/black-studio/black-studio-tinymce-widget).
* Translators can contribute through the [Official WordPress Translation platform](https://translate.wordpress.org/projects/wp-plugins/black-studio-tinymce-widget).
* Users can contribute by leaving a 5 stars [review](https://wordpress.org/support/view/plugin-reviews/black-studio-tinymce-widget#postform) or making a [donation](https://www.blackstudio.it/en/wordpress-plugins/black-studio-tinymce-widget/).
== Installation ==
This section describes how to install and use the plugin.
1. Install automatically through the `Plugins` menu and `Add New` button (or upload the entire `black-studio-tinymce-widget` folder to the `/wp-content/plugins/` directory)
2. Activate the plugin
3. Go to `Appearance` => `Widgets`
4. Drag and drop the `Visual Editor` widget to the desired sidebar (or, if using Accessibility mode, click the `Add` link)
5. Fill in title and (rich) text
Note: the plugin doesn't have nor requires any settings.
== Screenshots ==
1. Black Studio TinyMCE Widget in Visual mode
2. Black Studio TinyMCE Widget in HTML mode
3. Black Studio TinyMCE Widget combined with WP Edit plugin
== Frequently Asked Questions ==
= Purpose of the plugin =
This plugin gives you the ability to use the WordPress visual editor (TinyMCE) in widgets as you do in posts and pages, but it doesn't affect the editor behavior itself or its functionalities. If you are looking for additional editor features, take a look at plugins like [WP Edit](https://wordpress.org/plugins/wp-edit/), [TinyMCE Advanced](https://wordpress.org/plugins/tinymce-advanced/) or any other feature specific plugin you may need. Any additional TinyMCE plugin written following WordPress guidelines should work fine with Black Studio TinyMCE Widget.
= Troubleshooting =
If you are experiencing issues with the plugin please read entirely these FAQ before posting a new topic in our [support forum](https://wordpress.org/support/plugin/black-studio-tinymce-widget). Most of the times issues are caused by incompatibility with other plugins or themes, which may prevent our plugin from working as expected. In order to troubleshoot issues please complete the following steps:
1. First, ensure you have understood the purpose of the plugin. What this plugin does is to give you the ability to use the WordPress visual editor (TinyMCE) in widgets as you do in posts and pages, but it doesn't alter the editor behavior itself or its functionalities. So if you are experiencing issues with the editor even when editing posts or pages, they're definitely not related to our plugin (unless you're using some additional plugins that provide widgets support for pages, i.e. Page Builder).
2. Ensure that you are running the latest versions of both WordPress and the plugin.
3. Search in our [support forum](https://wordpress.org/support/plugin/black-studio-tinymce-widget) for threads with similar issues.
4. Disable all other plugins and check if the problem is fixed. In that case, enable the other plugins one by one and figure out which one is causing the issue. Please see [Conflict Diagnosis Guide for WordPress plugins](https://rtcamp.com/rtmedia/docs/troubleshooting/conflict-diagnosis-guide-wordpress-plugins/) for further info.
5. If the problem persists even with all other plugins disabled, try to switch to a WordPress default theme (i.e. Twenty Fifteen) and check if that fixes the issue.
If you found a conflict with a plugin or theme, or if your problem is still present after the steps above, open a topic in the [support forum](https://wordpress.org/support/plugin/black-studio-tinymce-widget) and provide the following information:
* Detailed description of the problem, including the steps to reproduce it
* Location(s) where the problem occurs (Appearance -> Widgets, Theme Customizer, Accessibility mode, Page Builder, etc)
* Browser and Operating System in use
* Plugin version in use
* WordPress version in use
* WordPress theme in use
* WordPress language in use, if other than English
* WordPress plugins causing conflicts, if any
* A link to a screenshot, if it can be useful to understand the problem
* A link to your website, if it can be useful to show the problem
= Can't find it in my available widgets =
Since version 1.3.1 the name of the widget changed from `Black Studio TinyMCE Widget` to `Visual Editor` to enhance user-friendliness. `Black Studio TinyMCE Widget` is still the name of the plugin, but it was a bit too long and not very intuitive for inexperienced users. You may find references to the old name in articles and videos on the web, so don't panic if you don't see the `Black Studio TinyMCE Widget` in your available widgets, just look for `Visual Editor`. Note: if you are using WordPress in a language other than English you may have a corresponding name translated into your language.
= Widgets disappeared after migrating or changing the site URL =
When dealing with a WordPress site URL change it is necessary to face the serialized fields issue: data may become corrupted if using a simple search/replace (see the [Codex](https://codex.wordpress.org/Moving_WordPress#When_Your_Domain_Name_or_URLs_Change) for further info). This is not an issue specifically related to our plugin, but it affects all the parts (plugins, themes and WordPress core files too) that use serialized data archiving. When changing the site URL, the recommended way is to use the [Search and Replace for WordPress Databases Script](https://interconnectit.com/products/search-and-replace-for-wordpress-databases/), as suggested by the Codex.
= How to translate widgets using WPML =
[WPML](https://wpml.org) is the leading commercial plugin for WordPress multi-language sites.
If you're using WPML v3.8 or newer and you need to translate a widget, we recommend to create a separate widget for each language of your site and assign the language to each widget accordingly using the selector "Display on language" provided by WPML. This way you will be able to work with the visual editor also for translations.
For older versions of WPML (up to 3.7.x), we recommend to install the 3rd party [WPML Widgets](https://wordpress.org/plugins/wpml-widgets/) plugin, which provides the same feature described above, that was not available natively on WPML. In the past, we also suggested to translate the widgets using the official WPML String Translation plugin, but this method is now deprecated as it was not very friendly due to the inability of using the visual editor for translations. If you were using WPML String Translation, we recommend to switch to the aforementioned translation method and remove the entries in WPML String Translation list after you moved them to be real widgets. Starting from version 2.6.0 of Black Studio TinyMCE Widget, a warning will be displayed if any deprecated translation is detected.
= How to embed video and other contents =
WordPress has a nice [autoembed feature](https://codex.wordpress.org/Embeds) that allows you to embed videos and other stuff in an easy way, by just putting the URL in the content area. This is also possible for widgets created with this plugin.
If you are using a version of WordPress prior to 4.0 or a version of Black Studio TinyMCE Widget prior to 2.0, for best results it is recommended to put the URL inside an `[embed]` shortcode. Example:
Ensure that the URL has not a hyperlink.
Alternatively, if you don't want to use `[embed]` shortcode, ensure that the URL is not surrounded by a `
= How to customize widget appearance =
The appearance of widgets in the frontend depends on both CSS and HTML. This plugin does not insert any additional CSS to your website frontend, so if you need to customize the styling you'll have to do at theme level, or you have to insert explicitly insert `