Download & Extend
Wysiwyg » Issues

Document hook_wysiwyg_editor_settings_alter()

Posted by TwoD on November 7, 2010 at 10:51pm
Project:Wysiwyg
Version:7.x-2.x-dev
Component:Documentation
Category:task
Priority:normal
Assigned:Unassigned
Status:closed (fixed)

Issue Summary

We've had this wonderful and powerful hook for some time, but it's not mentioned in wysiwyg.api.php.

Login or register to post comments

Comments

#1

Posted by TwoD on November 10, 2010 at 8:09pm

Some of these are pretty obvious but included for sake of completeness.

Basics
Function signature, brief info on arguments and return value.
Purpose
Why this hook exists and when it's called. Ex: "Exists to allow modules to alter the settings passed to an editor instance when it's attached to a field. Called after [possibly cached] profile settings have been retrieved from DB and just before settings are converted to a JSON object and passed to the client."
Audience
Who is this hook meant for? Any module integrating with Wysiwyg? Users needing to customize an editor configuration beyond what the current profile GUI can handle?
Powers
What can this hook do? Add settings? Remove settings? What settings are available for each editor. (Refer to the editors' official websites.) Are changes made by it cached? (No, meaning one can use it for dynamic changes.)
Limitations
What can't this hook do. Ex: "The values set by this hook must be of the PHP types Boolean, Integer/Float/Double, String[, NULL] or Arrays/Objects containing those. These will be converted to their corresponding JavaScript types before being passed to the client. Setting values of the JavaScript types Function-/Object-references, Regular Expressions or constants/variables cannot currently be set via this hook because they can't be automatically converted from PHP to JavaScript. @See http://api.drupal.org/api/function/drupal_to_js/6."
Considerations
Overriding settings that have GUI widgets on the profile pages will make the widgets useless. Other modules may be altering the same settings, check module weights.
Precedence
Ex. "The settings set in this hook will override any previous instance where the same setting has been defined, such as in a config.js file or similar, because they are passed directly to the editor instance. See editor's official website for more info."

Suggestions?

#2

Posted by sun on November 12, 2010 at 3:48pm

I don't think this should hold up the release, but of course, we can commit anything that's ready.

From the listed sections, only basics and purpose should be documented for now. A brief sentence about audience/powers/limitations may be added, but I wouldn't want to "officially formalize" this hook's usage yet, as it's poor workaround for our API/feature limitations.

#3

Posted by scarvajal on November 17, 2010 at 2:13am

There is a way to know wich wysiwyg profile or input format is active inside this hook?

I'm trying to override Ckeditor toolbars here to circunvent the icons group limitation (no wrap).

Thanks.

#4

Posted by TwoD on December 27, 2010 at 9:23pm

Yes, the strings $context['profile']->format and $context['profile']->editor should have that information.
The profile object is the same one as retrieved from wysiwyg_profile_load($format).

EDIT: Fixed syntax, thanks!

#5

Posted by scarvajal on November 18, 2010 at 2:35am

Thanks TwoD!

Is $context['profile']->format, is not ?

#6

Posted by sun on December 27, 2010 at 12:58am
Priority:major» normal
Status:active» needs review

Couldn't think of simple example code, so I left the function body empty.

AttachmentSize
wysiwyg-HEAD.editor-settings-alter.6.patch 1.5 KB

#7

Posted by TwoD on December 27, 2010 at 9:33pm

How about this?
I added the comments to avoid questions about why something like this won't work:

<?php
function hook_wysiwyg_editor_settings_alter(&$settings, $context) {
  if ($context['profile']->editor == 'tinymce') {
    $settings['fillEmptyBlocks'] = function ( element ) {
      // Expected to be executed as JavaScript.
      if ( element.attributes[ 'class' ].indexOf ( 'clear-both' ) != -1 )
        return false;
     }
   }
}
?>

(Taken from the CKEditor config docs.)
AttachmentSize
wysiwyg-HEAD.editor-settings-alter.7.patch 1.69 KB

#8

Posted by sun on January 6, 2011 at 12:19am
Status:needs review» fixed

Thanks for reporting, reviewing, and testing! Committed with minor adjustments to all branches.

A new development snapshot will be available within the next 12 hours. This improvement will be available in the next official release.

#9

Posted by System Message on January 20, 2011 at 12:20am
Status:fixed» closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.