WordPress.org

Ready to get started?Download WordPress

Plugin Directory

Black Studio TinyMCE Widget

The visual editor widget for WordPress.

Troubleshooting

If you are experiencing issues with the plugin please read entirely these FAQ before posting a new topic in our support forum. 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 provides 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 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 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 Fourteen) 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 and provide the following information:

  • Detailed description of the problem, including the steps to reproduce it
  • Error messages, if any, in particular in browser's javascript console
  • Browser and Operating System in use
  • Plugin version in use
  • WordPress version in use
  • WordPress theme in use
  • WordPress default 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 in 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 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 archiviation. When changing the site URL, the recommended way is to use the Search and Replace for WordPress Databases Script, as suggested by the Codex.

How to translate widgets using WPML

The current version of Black Studio TinyMCE Widget plugin works together with the WPML String translation plugin. To translate a widget created with Black Studio TinyMCE Widget plugin you have to create it on the widgets panel and then go to WPML => String translation and translate the title and text from there (unfortunately the translation textarea has not the visual editor). Note: If you installed WPML after the creation of the widgets, just re-save them and they will appear on the String translation list.

How to embed video and other contents

WordPress has a nice autoembed feature 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:

[embed]http://www.youtube.com/watch?v=XXXXXXXXXXX[/embed]

Ensure that the URL has not an hyperlink on it. Alternatively, if you don't want to use [embed] shortcode, ensure that the URL is not surrounded by a <p> tag.

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 explicitely insert <style> in your widget using the the Text / HTML mode (this option is not recommended though). As for the HTML, most of the markup is controlled by WordPress and by the theme. The HTML output of a widget includes the following parts:

[before_widget]
    [before_title]
        [title]
    [after_title]
    [before_text]
        [text]
    [after_text]
[after_widget]

which can be customized as following:

  • The [title] and [text] are the values that you insert in Widgets administration panel.
  • The markup of [before_widget], [after_widget], [before_title], [after_title] is usually defined by your theme when registering a sidebar with the register_sidebar function.
  • The [before_text] and [after_text] are the only piece of HTML markup added by the plugin. The default markup is the same as native WordPress text widgets to ensure visual compatibility with styles created for text widgets: <div class="textwidget"> [text] </div>. You may customize the markup using the black_studio_tinymce_before_text and black_studio_tinymce_after_text filter hooks. They both take two parameters, the first is the default text and the second is the widget instance. See examples below.

Example 1: Custom markup for [before_text] and [after_text]

add_filter( 'black_studio_tinymce_before_text', 'my_widget_before_text', 10, 2 );
function my_widget_before_text( $before_text, $instance ) {
    return '<div class="mytextwidget">';
}
add_filter( 'black_studio_tinymce_after_text', 'my_widget_after_text', 10, 2 );
function my_widget_after_text( $after_text, $instance ) {
    return '</div>';
}

Example 2: Totally remove markup for [before_text] and [after_text]

add_filter( 'black_studio_tinymce_before_text', '__return_empty_string' );
add_filter( 'black_studio_tinymce_after_text', '__return_empty_string' );

There's also an additional hook, that you may use to specify to not display widgets if their content is empty:

add_filter( 'black_studio_tinymce_hide_empty', '__return_true' );

How to customize widget contents (using hooks)

You may alter widget title and text via code using the widget_title and widget_text filter hooks (see Codex for details). The plugin also internally uses widget_text filter to apply specific features:

  • icl_t (priority 2): applies WPML translation (called only if WPML is activated on the site).
  • autoembed (priority 4): converts embed urls to relevant embed codes.
  • convert_smilies (priority 6): converts text equivalent of smilies to images.
  • wpautop (priority 8): applies paragraphs automatically (if the relevant option is selected).
  • do_shortcode (priority 10): processes the shortcodes.

If for any reason you need to remove the filters above, you may use the following code snippet (or a custom version of it):

add_action( 'init', 'remove_bstw_widget_text_filters' );
function remove_bstw_widget_text_filters() {
    if ( function_exists( 'bstw' ) ) {
        remove_filter( 'widget_text', array( bstw()->compatibility()->plugins(), 'wpml_widget_text' ), 2 );
        remove_filter( 'widget_text', array( bstw()->text_filters(), 'autoembed' ), 4 );
        remove_filter( 'widget_text', array( bstw()->text_filters(), 'convert_smilies' ), 6 );
        remove_filter( 'widget_text', array( bstw()->text_filters(), 'wpautop' ), 8 );
        remove_filter( 'widget_text', array( bstw()->text_filters(), 'do_shortcode' ), 10 );
    }
}

Plugin's data location and cleanup

Plugin's data is stored in serialized format inside a record in the wp_options table having option_name = 'widget_black-studio-tinymce'. Data storage is handled by WordPress and not directly by the plugin itslef. The widgets data is intentionally kept in the datatbase upon plugin deactivation / deletion to avoid content loss. If you want to totally remove the plugin including its data, just remove that record after plugin removal.

Requires: 3.1 or higher
Compatible up to: 4.1.1
Last Updated: 2015-2-17
Active Installs: 400,000+

Ratings

4.7 out of 5 stars

Support

22 of 38 support threads in the last two months have been resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

0,1,0
100,2,2 100,1,1 100,1,1 50,2,1 100,4,4 50,2,1 50,2,1 100,1,1
100,2,2 100,2,2 75,4,3 100,1,1 100,1,1
71,7,5 81,21,17
100,10,10 100,3,3 100,2,2 100,1,1
100,2,2 33,3,1
80,5,4 100,1,1 100,12,12 0,1,0
75,4,3 100,1,1 100,3,3 100,4,4 100,1,1
67,6,4 100,7,7
100,4,4 80,5,4 100,1,1
88,8,7
67,3,2
100,1,1
67,3,2
50,2,1
0,1,0 100,7,7 83,6,5
0,1,0
67,3,2
100,1,1 100,2,2 50,2,1 100,1,1 100,1,1
100,1,1 100,1,1 100,2,2 50,2,1 100,1,1 100,1,1
100,2,2
100,3,3 75,8,6 100,1,1