Custom Module - Textarea - Use WYSIWYG

Hmm, if it's working in a block it should be working on the full page as well.

Are you seeing any JavaScript errors?
Checked with Firebug for Firefox or a similar tool to see if all files are loaded correctly?
In some instances it may appear as if the editor has not been loaded if its stylesheets are missing. You'd see the editor's elemenets added before or after the textarea, but you should be seeing this problem both in the block and on the page...

It's a bit hard to come up with ideas on what could cause this without being able to tinker with the code.
It would be great if you could put the module somewhere where I could download and debug it myself. If you don't want to make it public you can mail me a link via my contact form.

Did anyone ever figure out a solution to this issue? I ran into the same issue on a custom form and spent hours trying to fix. The form array for the fieldset containing the textarea and the input format look exactly the same on both my custom form and the node edit form, but CKEditor loads on the node form via the WYSIWYG module but does not on my custom form. I've also checked that the same JavaScript is being written to the page...all of the following appear in the source code on both pages:

sites/all/modules/wysiwyg/wysiwyg.init.js
misc/textarea.js
sites/all/libraries/ckeditor/ckeditor.js
sites/all/modules/wysiwyg/editors/js/ckeditor-3.0.js
sites/all/modules/wysiwyg/editors/js/none.js

The WYSIWYG-related settings in Drupal.settings also seem to be the same on both pages. I've tried setting the format as a child of the fieldset array that contains the textarea, as a child of the textarea array itself, and as a direct child of the entire form array. I also tried experimenting with different functions from wysiwyg.module (see commented-out code below), and thought maybe adding $form['#after_build'][] = 'wysiwyg_process_form'; would solve the problem...no luck! Below is a sample of my code:

function mymodule_custom_form(&$form_state, $nid = NULL) {
  if (empty($nid) && isset($form_state['values']['nid'])) {
    $nid = $form_state['values']['nid'];
  }
  $node = node_load($nid);

  // A bunch of other form code here for other form elements...

  $form['description_field'] = array(
    'format' => filter_form(mymodule_get_ckeditor_format(), NULL, array('description_format')),
  );
  $form['description_field']['format']['#weight'] = 60;

  $form['description_field']['description'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#rows'  => 10,
    '#cols'  => 60,
    '#resizable' => FALSE,
    '#default_value' => $node->body,
    '#weight' => 50,
  );
  //$form['description']['format'] = filter_form(mymodule_get_ckeditor_format(), NULL, array('description_format'));
  //$form['format'] = filter_form(mymodule_get_ckeditor_format(), NULL, array('format'));

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
    '#weight' => 100,
  );
  $wysiwyg_profile = wysiwyg_get_profile(4);
  //$wysiwyg_editor = wysiwyg_load_editor($wysiwyg_profile);
  //wysiwyg_add_plugin_settings($wysiwyg_profile);
  //dpm(wysiwyg_get_editor_themes($wysiwyg_profile)); dpm($wysiwyg_editor); dpm($wysiwyg_profile);
  $editor_settings = wysiwyg_add_editor_settings($wysiwyg_profile, 'kama');
  //dpm($editor_settings);
  //dpm(filter_formats(4));
  $form['#after_build'][] = 'wysiwyg_process_form';
  //$form = wysiwyg_process_form($form);
  //dpm($form);
  return $form;
  //
}

Thanks in advance for any suggestions or pointers anyone has!

Dan

Marking as active...

Hmm, for some reason I apparently wasn't setting up the 'format' fieldset correctly, and it wasn't getting processed by wysiwyg_process_form(). I was able to get the desired behavior by setting the 'format' on the entire form (which I know is also a valid option). Maybe I had a syntax error in the way that I set up the field-specific 'format'?

Here is my new (working) code:

  $form['description'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#rows'  => 10,
    '#cols'  => 60,
    '#resizable' => FALSE,
    '#default_value' => $node->body,
    '#weight' => 50,
  );
  $ckeditor_format = mymodule_get_ckeditor_format();
  $form['format'] = filter_form($ckeditor_format, NULL, array('format'));
  $form['format']['#weight'] = 60;

Changing this issue back to original status ('postponed (maintainer needs more info)').

The 'format' key needs to be on the same form "depth" as the textarea, just like you've got it in the first and second snippets. The problem was however that 'format' must be defined after the textarea, or Wysiwyg can't be sure which textarea it belongs to. (Defined order is what matters, weight is just for visual sorting and is ignored by Wysiwyg.)

You do not need to call any of Wysiwyg's functions once the format is placed after the textarea, it's all handled automatically by wysiwyg_process_form(), just like in your second snippet.

I'm closing this issue since no additional information has been provided by the original poster. Feel free to reopen the issue and mark it "active" again when more info can be provided.

$ckeditor_format = mymodule_get_ckeditor_format();

I don't seem to have this function. I have tried mymodulename_get_ckeditor_format and also mymodulename_ckeditor_format did you need to use this function in order for this to work? Here is the c ode that I am using. I have been trying to get this to display on one of my custom fields I created in User Management -> Profiles in a text area.

function form_alter_form_alter($form, $form_state, $form_id){
global $user;


  if ($form_id == 'user_profile_form') {
    $form['Teacher Profile']['profile_teacher_schedule']['#resizable'] = 'FALSE';
	$form['Teacher Profile']['profile_teacher_schedule']['#rows'] = '10';
	$form['Teacher Profile']['profile_teacher_schedule']['#cols'] = '60';
	$form['Teacher Profile']['profile_teacher_schedule']['#weight'] = '50';
	$form['Teacher Profile']['profile_teacher_schedule']['#after_build'] = 'wysiwyg_process_form';
	$form['Teacher Profile']['profile_teacher_schedule']['format'] = filter_form($ckeditor_format, NULL, array('format'));
	$form = wysiwyg_process_form($form);
	$wysiwyg_profile = wysiwyg_get_profile(4);

  

//   print_r($form);
 
  }
  
// return($form);
}

mymodule_get_ckeditor_format() was meant as a placeholder for whatever code you use to determine which format should be the default choice (the first parameter to filter_form()). It defaults to using FILTER_FORMAT_DEFAULT if set to null, so I'll use that instead.

As I said above, one does not need to call any of Wysiwyg's functions - or assign process callbacks - for it to find the format selector and attach an editor to the corresponding textarea, as long as the format key is on the same "level" as the textarea. You've currently placed the 'format' key directly on the textarea array when it should be its "sibling".

I'm assuming this is the only textarea with a format selector below $form['Teacher Profile'], otherwise this will need a slight change. The last parameter to filter_form() will also need a change if some other element in the form uses the key 'format' or Drupal will try to write both their values to $form_state['values']['format'] when the form is submitted.

(Btw, I'm not sure "Teacher Profile" there is supported, you might want to try with just "teacher_profile" since that value won't be shown to the user anyway.)

function MYMODULE_alter_form_alter(&$form, &$form_state, $form_id){ // $form and $form_state are passed by reference.
  global $user;
  if ($form_id == 'user_profile_form') {
    $form['teacher_profile']['profile_teacher_schedule']['#resizable'] = FALSE; // No quotes, boolean value.
    $form['teacher_profile']['profile_teacher_schedule']['#rows'] = 10; // No quotes, numerical value.
    $form['teacher_profile']['profile_teacher_schedule']['#cols'] = 60;
    $form['teacher_profile']['profile_teacher_schedule']['#weight'] = 50;
    $form['teacher_profile']['format'] = filter_form(NULL, NULL, array('format'));
  }
}

If $form['teacher_profile']['#tree'] is TRUE, change array('format') to array('teacher_profile_format'), as the selected value would be in $form_state['values']['teacher_profile_format'] after submission.

Btw, if you wish to reopen an issue, please change its status back to "active" or it won't show up in the regular issue queue and there's big risk we'll miss it.

Unless this is used to be used in form.module - or you know you'll never use that module and your module is also called 'form' - please rename the function to YOUR_MODULE_NAME_form_alter() or it won't be called by Drupal.

function add_wysiwyg_form_alter($form, $form_state, $form_id){
global $user;


  if ($form_id == 'user_profile_form') {
    $form['Teacher Profile']['profile_teacher_schedule']['#resizable'] = FALSE;
	$form['Teacher Profile']['profile_teacher_schedule']['#rows'] = 10;
	$form['Teacher Profile']['profile_teacher_schedule']['#cols'] = 60;
	$form['Teacher Profile']['profile_teacher_schedule']['#weight'] = 50;
	$form['Teacher Profile']['format'] = filter_form(NULL, NULL, array('format'));
	   }

  

}

Thank you so much for your response. the space in the 'Teacher Profile' is actually what it is. And using this format does alter and change my form. So the items and changes I am doing here are showing on my form. However using this code here still does not display the wysiwyg editor to my textarea form. This form is on the Edit tab then under this it creates another tab called Teacher Profile and this info is in side here. These items were created with the profile module. Is there still something that I am doing wrong?

function add_wysiwyg_form_alter(&$form, &$form_state, $form_id){ // CHANGED!
  if ($form_id == 'user_profile_form') {
    $form['Teacher Profile']['profile_teacher_schedule']['#type'] = 'textarea';  // ADDED
    $form['Teacher Profile']['profile_teacher_schedule']['#resizable'] = FALSE;
    $form['Teacher Profile']['profile_teacher_schedule']['#rows'] = 10;
    $form['Teacher Profile']['profile_teacher_schedule']['#cols'] = 60;
    $form['Teacher Profile']['profile_teacher_schedule']['#weight'] = 50;
    $form['Teacher Profile']['format'] = filter_form(NULL, NULL, array('format')); 
  }
}

This is the exact code I put in a D6 test module called 'add_wysiwyg', and it shows the editors for the new textarea on my Edit page just fine.
Since I have no other module which creates the 'Teacher Profile' textarea, I added a line to create it right first. (Otherwise I get a notice from Wysiwyg notice: Undefined index: #id in ....sites/all/modules/wysiwyg/wysiwyg.module on line 200. and no textarea appears.)

I also added & before $form and $form_state since they are passed by reference (works without them, but better with them for clarity).

Yah, I am sorry to be a pain in the butt. But using your exact code will not get the wysiwyg editor to display. Still just shows a basic textarea. I know the function is working and the items are in the right path. Here is a print_r($form['Teacher Profile']);

Array
(
    [#type] => fieldset
    [#title] => Teacher Profile
    [#weight] => 1
    [profile_teacher_name] => Array
        (
            [#type] => textfield
            [#title] => Teacher Name
            [#default_value] => 
            [#maxlength] => 255
            [#description] => Enter your name as you would like it to be viewed by the students.
            [#required] => 1
        )

    [profile_teacher_bio] => Array
        (
            [#type] => textarea
            [#title] => Teacher Bio
            [#default_value] => 
            [#description] => Enter some information that you would like the students to know about yourself.
            [#required] => 1
        )

    [profile_teacher_schedule] => Array
        (
            [#type] => textarea
            [#title] => Teacher Schedule
            [#default_value] => 
            [#description] => Add a schedule to show the times when you are available.
            [#required] => 1
            [#resizable] => 
            [#rows] => 10
            [#cols] => 60
            [#weight] => 50
        )

    [format] => Array
        (
            [#type] => fieldset
            [#title] => Input format
            [#collapsible] => 1
            [#collapsed] => 1
            [#weight] => 
            [#element_validate] => Array
                (
                    [0] => filter_form_validate
                )

            [1] => Array
                (
                    [#type] => radio
                    [#title] => Filtered HTML
                    [#default_value] => 2
                    [#return_value] => 1
                    [#parents] => Array
                        (
                            [0] => format
                        )

                    [#description] => <ul class="tips"><li>Web page addresses and e-mail addresses turn into links automatically.</li><li>Allowed HTML tags: &lt;a&gt; &lt;em&gt; &lt;strong&gt; &lt;cite&gt; &lt;code&gt; &lt;ul&gt; &lt;ol&gt; &lt;li&gt; &lt;dl&gt; &lt;dt&gt; &lt;dd&gt;</li><li>Lines and paragraphs break automatically.</li></ul>

                    [#id] => edit-format-1
                )

            [2] => Array
                (
                    [#type] => radio
                    [#title] => Full HTML
                    [#default_value] => 2
                    [#return_value] => 2
                    [#parents] => Array
                        (
                            [0] => format
                        )

                    [#description] => 
                    [#id] => edit-format-2
                )

            [3] => Array
                (
                    [#type] => radio
                    [#title] => PHP code
                    [#default_value] => 2
                    [#return_value] => 3
                    [#parents] => Array
                        (
                            [0] => format
                        )

                    [#description] => <ul class="tips"><li>You may post PHP code. You should include &lt;?php ?&gt; tags.</li></ul>
                    [#id] => edit-format-3
                )

            [4] => Array
                (
                    [#value] => <p><a href="/filter/tips">More information about formatting options</a></p>
                )

        )

)

This only seems to be happening while I am trying to edit the form going through My Account then clicking on the Edit tab and then clicking on the Teacher Profile tab that has been created. Any other ideas? Thanks!!!

No problem. I'm just trying to narrow down the problem and make sure we're using the exact same code under the same conditions.

The form array does look correct, if it was printed from within the hook_form_alter() implementation.
Wysiwyg should be able to spot the 'format' key, find that three formats are available, get the settings for each editor profile assigned to them and add that data to the page.
Is there another textarea field on the same page which does have editors?
If so, where in $form is it's 'format' key in relation to the one you're adding?

When viewing the form, does your browser show any JavaScript errors?
Does Drupal.settings.wysiwyg.configs get populated with the editor profiles' settings data for the formats which have editors assigned to them?
Are you using a custom page template for the page where the editors don't show up? If so, does it print the $closure variable just before the closing body tag?
Are the editors not showing up elsewhere where there's a textarea with a format selector?

Wow, your a life saver! I did not have the $closure at the end of my page.tpl.php file. Adding $closure into my template fixed the problem. This editor now shows on the webpage. Thank you so much for your help. I have been trying to figure this out for so long and had completely ran out of ideas to get this thing working.

Ah, that's why there were no errors, it never tried to attach an editor on the client because the script doing that was missing.

I'm glad you got it working!

FYI, there's an FAQ entry on this. ;)