remove Delete checkbox from user location form

Tagging with a theming tag for now.

Awesome, I got the code implemented in a module I made called formtheme.module which also uses hook_form_alter() to modify node forms. However, I'm trying to implement this on a case by case basis, so on one node type form the location fields are themed like x, and on another node type form the location fields are themed like y. I figure the most logical approach to this would be a 'switch' statement, but I'm not sure what to switch on. Going by hook_form_alter() I added the $form_id as a parameter at location_element_alter(), switching by $form_id, but it doesen't seem to be working. Here is my code

function formtheme_location_element_alter(&$element, $form_id) {
	if (module_exists('devel')) {
  dsm(func_get_args(), "formtheme_location_element_alter");
	}
	switch ($form_id) {
		
	case 'uprofile_node_form':
  if (isset($element['locpick'])) {
    $element['locpick']['user_latitude']['#description'] = ' ' . t('Use decimal notation.');
    $element['locpick']['user_longitude']['#description'] = '&nbsp;' . t('See <a href=!url target=_blank>our help page</a> for more information.', array('!url' => url('latlon_help')));
  }
}
}

I'd like to make it contextual by $form_id like I can with hook_form_alter(), do you know a good way to go about doing this?

I appreciate the help very much!

/subscribe for the #3 addition.

Tested, works, I think it can be commited to allow to alter form element without having a hacked location module;

Excellent Dave Cohen, this really worked.

Hello,

@Dave Cohen, I want to remove the 'delete location' checkbox from all forms. Module version is 'Location 6.x-3.1-rc1'. I have applied the patch you provided at 1 but I don't know what to do next. I'm a beginner in both PHP and Drupal. I have no idea about how to use the code for hook_form_alter. I don't even know where hook_form_alter is located.

Any help will be very much appreciated.

Thanks.

Thanks a lot, Dave.

Here is a patch containing Dave's one line calling of drupal_alter for D6, worked like a charm for me. It would be great to get this in for D5 and 6

The above patch for D6 doesn't work for me. I still can't access the location form fields in my hook_form_alter implementation after installing the patch.

The patch creates a new hook called hook_location_element_alter

Within that hook, you can access the fields as $element['country'] etc. (edit - see comment #6)

Ahhhh, that works! I skimmed through the comments too quickly and didn't piece it all together. Thanks!

though the alter is nice, I believe there's already a core drupal 6 way in: after_build.

The issue with altering elements in form alter is that the element hasn't been processed.

However form calls after build functions after elements are processed(expanded) and before they're rendered.

function modulename_form_alter(&$form, $form_state, $form_id) {
    switch($form_id) {
        case 'nodetype_node_form':
             $form['#after_build'][] = 'remove_location_description';
    }
}
function remove_location_description(&$form) {
	$form['field_location'][0]['locpick']['instructions']['#value'] = '';
	$form['field_location'][0]['locpick']['map_instructions']['#value'] = '';
    return $form; 
}

(Another example of an after_build on my 'blog' http://foxis.intheclosets.com/text/adding-attributes-changing-cck-field )

Haven't tested if can get the delete box gone, but should be able to.

Doing a quick test it seems to work :>.

assume above has been done so after_build function is called

Assume field_location is the cck location field.

in the after_build function

function remove_location_description(&$form) {
	if ($form['field_location'][0]['delete_location']) $form['field_location'][0]['delete_location']['#access'] = 0;
    return $form; 
}

or for multi value:

function remove_location_description(&$form) {
        if (!is_array($form['field_location'])) return $form;
	foreach ($form['field_location'] as $key => $dontcare ) if (is_numeric($key) && $form['field_location'][$key]['delete_location']) $form['field_location'][$key]['delete_location']['#access'] = 0;
    return $form; 
}

It's import to return $form or else the $form array will disappear (the after_build functions are called as $form = after_build_function = $form).

(Why I did access instead of unset or set to array: I prefer #access when removing an element on a forum so it's still there in the array in case a later piece of code expects it to be there it'll be there. Access will disallow access to an element; I believe it changes the element to a 'value' instead of whatever it was. For example #access = 0 on the author field, the author field will turn into 'author'=>array('#type'=>'value','#value'=>'whatever the value (default value) was?'). I believe it works the same in after_build as in form_alter.

Haven't tested to see how it'd be done with location_node or location_user, just location cck, but I bet something similar.

Hi Guys,
I can't seem to get this to work for location cck - nothing in dpm($form['field_profile_location'][0]['delete_location']) at all - curious

Actaully - there is no linked patch in #12 (simply goes to http://drupal.org/files/issues) so perhaps I'm missing an important piece of the puzzle. Can someone clarify? I will be happy to test, re-roll patch, pitch in, etc

Scottrigby, what steps did you follow exectly?
Are you trying to do the alterations in just form_alter? If you are, then the field hasn't been built so there would be no delete_location yet.

@hefox, yes - i think i was unsure about the state of this patch, or what patch was RTBC, or if wasn't a patch at all finally but a few possible solutions. Now i gather the patch in #12 was necessary :p -- was that just an expansion of #3?

I think so, however I never tried that patch since as detailed above, the location element can also be reached in an after_build function, so I'm not sure if the patch will make it into module (even if figures itself out and reappears D:!)

Hi - I uploaded that patch in #12, but not sure what has happened to it, I can confirm that it is just #3 in patch form.

#16 worked for me.

No hacked location.module. Don't forget 'return $form' !

Also, use loop for multi-location nodes.

Thanks Dave Cohen and hefox.

<?
function my_module_form_alter(&$form, $form_state, $form_id) {
  switch ($form_id) {
    case 'vendor_node_form':
     $form['#after_build'][] = 'change_additional';
     break;
  }
}

function change_additional(&$form) {
 foreach ($form['locations'] as $key => $value) {
  if (is_numeric($key)) {
   $form['locations'][$key]['additional']['#title'] = "Hours of Operation";
  }
 }

 return $form;
}

Just wanted to say #16 worked for me. Thanks hefox for pointing out #after_build, it's great! If I hadn't got this working I would have had to throw out Location for no better reason than the labels were wrong. Pesky customers.

Thanks again.

soooo no patch is needed? the solution in #16 will work?

Solution in #16 absolutely works.

I have locations set for a number of content types, and so I used:

function {your module name}_form_alter(&$form, $form_state, $form_id) {
  if (preg_match("/node_form/", $form_id)) $form['#after_build'][] = 'change_location_fieldset';
}

which will match any $form_id with 'node_form' in it and then add the function change_location_fieldset() [which you define - the name is irrelevant] to the list of functions that are called after the form is built (when all the location items are available to be altered).

--

Another tip was that I called:

die (print_r($form));

as the first line inside my #after_build function (here 'change_location_fieldset()') to dump the $form array in my browser window. Then selecting 'view source' lets you see a nicely laid out version of the array. For me this is the quickest way of seeing the variables I needed to change. Once you've got the list of things you want to change, you remove the line.

--

Changes to labels (and descriptions) are straightforward, i.e.

$form['locations'][0]['name']['#title'] = 'Name';

--

I had an issue with the 'additional' field showing before the street line. It seems that the weight of the additional field is set to the same as the weight of the street field. On the node I looked at (with die(print_r($form))) they both had a weight of -99, so I set the weight of additional to -98 and the problem went away. However, on a different node form, where the location field was displayed in a different place, this had the effect of floating the additional field to the top of the fieldset.

The reliable solution to putting the additional field underneath the street field for me was simply to make it one heavier than the street field:

$form['locations'][0]['additional']['#weight'] = $form['locations'][0]['street']['#weight'] + 1;

--

My complete code (for the changes I wanted - it needs to be put in a module) is:

/**
 * Implements hook_form_alter()
 */

function {module name}_form_alter(&$form, $form_state, $form_id) {
  if (preg_match("/node_form/", $form_id)) $form['#after_build'][] = 'change_location_fieldset';
}


// This function assumes there is only one location allowed. For more, you would loop: foreach($form['field_location') as $key => $value) and use $key in place of [0]
function change_location_fieldset(&$form) {
    //die (print_r($form));
	$form['locations'][0]['name']['#title'] = 'Name';
	$form['locations'][0]['name']['#description'] = '';
	$form['locations'][0]['additional']['#weight'] = $form['locations'][0]['street']['#weight'] + 1;
	$form['locations'][0]['additional']['#title'] = 'Locality';
    return $form; 
}

have fun - this is really very easy (as easy as hook_form_alter() - but with the one additional step of having to put your changes in a function that is called once the form is built)

adding tag so someone might find this snippet of useful code.

It seems to me like the module itself should contain logic that decides when to hide the 'Delete' check box—there are some cases where having it just doesn't make sense. Consider for example the case where I've set both the maximum and minimum addresses for a node to 1, and the address contains required fields.

dboulet, are there other programmable cases?
What happens in your case, does it work to delete the location even though it is required?
I wonder if this might be too much of an edge case. Using form alter is pretty easy and common.
Is the need for a UI for folks who are uncomfortable trying to make their own module to do a form alter?
Maybe a generic checkbox config for "provide a Delete check box' somewhere in the location config? Where do people think that type of thing might go?

guess I'm tempted to mark this wont fix, because at first thought, it seems like an edge case. (from a module perspective) Or at least postponed as there might be more generally useful things to work on location (like proximity search and views).

I couldn't think of any other cases, but thought that others could post some.

In my case, yes, I can still delete a location even though it is required. If I try to edit the node again, the fields are blank and I'm forced to re-enter the required fields in order to save the node. I don't think that this scenario, one where a node type contains exactly one location which itself contains a required field, would be described as an edge-case, I would assume that it would be a pretty common configuration.

Either way, I just wanted to get a discussion going, and see what others thought.

Hi All,

I tried to implement these methods but I get this error.

Fatal error: Unsupported operand types in /home/topseque/public_html/rb4/includes/common.inc on line 2937

I define the $form['#after_build'] inside my hook form alter. After this function is closed, I call the named function, as described above.

It seems to hang on the '#', because when I remove it it no longer brings up the error.

Also, once it gets to my custom named function, the following line causes an error as well. The 'node' comes from when I printed out the output to see how the variables are called.

$form['node']['field_rest_location'][0]['phone'] = '12345';

creating this error:

Fatal error: Cannot use string offset as an array in /home/topseque/public_html/rb4/includes/form.inc on line 990

Any ideas on what might be going on or what is wrong?

Thanks,
Rob

For my part showing a delete checkbox on a location form when it is required should be classified as a bug. Definitely not an edge case, simple common sense.

It's great that workarounds exist (including some that are hack free) but the module shouldn't be providing an invalid option in the first place.

The module from #33 dont work for me.

Is changed anything in Location 6.x.3.1-code so thats module lost his function?

Regards Matthias

I completely agree with mandclu. Required location fields should not display the delete location check box.
Thankfully, the work around isn't painful and does the job.

Yep, #36 is right !

Here is the code for 7.x (if someone needs it):

/**
 * Implements hook_form_alter().
 */
function mymod_custom_form_alter(&$form, &$form_state, $form_id) {
  // One location is required, so do not show delete box.
  if (isset($form['field_location']['und'][0])) {
    $form['field_location']['und'][0]['#after_build'][] = '_mymod_custom_remove_location_delete';
  }
}

/**
 * Remove the delete checkbox from location element.
 */
function _mymod_custom_remove_location_delete(&$form_element, &$form_state) {
  unset($form_element['delete_location']);
  unset($form_element['#value']);
  return $form_element;
}

It does assume usage of Location CCK and the CCK field be named "field_location".

Best Wishes,

Fabian

#40 worked for me, though I had to delete the "custom_" from "custom_form_alter."

Thanks Fabian!

for #40, is that a custom module? Is there a way to do this through the template.php file?

Thanks for the code Fabianx, works great

Solution in #40 might work. But I've found that there is an alter-hook that makes this a bit easier. And cleaner imo.

<?php
/**
 * Implements hook_location_element_alter().
 */
function HOOK_location_element_alter(&$element) {
  unset($element['delete_location']);
}
?>

#44: Nice :-)

Can confirm I dropped #44 in a custom module and it worked!

Cool.
Thanks to #44 I finnaly created my first module and hook.
Working like a charm.

#44 works fine for me!. Thanks!

#44 worked for me.

tried to implement #44. Created a module folder a locationdelete.module file and a locationdelete.info file. Activated the module, but the field is still visible. Do I have to do more steps? Cleared the cache also.

locationdelete.module

<?php
/**
 * Implements hook_location_element_alter().
 */
function HOOK_location_element_alter(&$element) {
  unset($element['delete_location']);
  unset($element['re_geocode_location']);
}
?>

locationdelete.info

name = Location Delete
description = Removes delete and geocode checkboxes
core = 7.x

Hi fruitsalad, you need to make sure to replace the prefix HOOK in the function name with the name of your module. So in your case, the function should be called locationdelete_location_element_alter.