Ticket #19906: 19762-quicktags-docblock.diff

wp-includes/js/quicktags.dev.js

@@ -275 +275 @@
          * 
          * Adds qt.Button or qt.TagButton depending on the args. The first three args are always required.
          * To be able to add button(s) to Quicktags, your script should be enqueued as dependent
-         * on "quicktags" and outputted in the footer. If you are echoing JS directly from PHP,
-         * use add_action( 'admin_print_footer_scripts', 'output_my_js', 100 ) or add_action( 'wp_footer', 'output_my_js', 100 )
+         * on "quicktags" and outputted in the footer. 
+         * If you are echoing JS directly from PHP use
+         *      add_action( 'admin_print_footer_scripts', 'output_my_js', 100 ) 
+         * or 
+         *      add_action( 'wp_footer', 'output_my_js', 100 )
+         *      
+         * If echoing the addButton calls directly instead of enqueing with the 'quicktags' dependency
+         * make sure to check that the QTags object is defined first, otherwise your code will throw errors 
+         * when no editor is present:
+         *      if ( typeof QTags != 'undefined' ) { QTags.addButton(...) } 
          *
          * Minimum required to add a button that calls an external function:
          *     QTags.addButton( 'my_id', 'my button', my_callback );