Convert custom widget to use the core field options widget.

I've added one to the country element if it is not required. I'll hook this up latter to the field settings:

/**
 * Our process callback to expand the control.
 */
function countries_country_expand($element) {
  if (empty($element['#options'])) {
    if (empty($element['#filters'])) {
      include_once DRUPAL_ROOT . '/includes/locale.inc';
      $element['#options'] = country_get_list();
    }
    else {
      $element['#options'] = countries_get_countries('name');
    }
  }
  $element['#options'] = countries_filter($element['#options'], $element['#filters']);

  // If not required, add a none option. This can be overridden via setting
  // the $element['#empty_value'] parameter to NULL.
  if (empty($element['#required']) && !isset($element['#empty_value'])) {
    $element['#empty_value'] = '';
  }
  return $element;
}

Committed to master, and the issue is postponed to remind me to add field setting options latter.

Hi i reworked this patch and introduced field settings rather than widget settings. This patch provides two core widget (selectbox and checkboxes/radios) as in #1090416: Add 'checkboxes/radiobuttons' widget and fixes the continent filter issue.

The size option is still available but not used in drupal core widgets.

It looks like you both have been active. I really like the look of the use of hook_options_list(), I did not know of this hook!

If either would like access to git to push these changes into the dev version, contact me via my profile. I can not really review or test things out for the next two / three months as we are hitting the back roads of Peru / Bolivia and have very limited internet access.

Big thanks!

Alan

I've just pushed through an update script that will convert the instances that use country widgets to options_list widgets and pull over the first found instance settings into the field settings (if not already set).

@webflo
The recursive continents filter has been simplified and renamed to _countries_checkbox_filter(). I discovered that the $element['#value'] is already filtered.

I think that I've found a minor issue with the code, but for the life of me I can find no documentation on this.

The existing code is:

/**
 * Implements hook_options_list().
 */
function countries_options_list($field) {
  $function = !empty($field['settings']['options_list_callback']) ? $field['settings']['options_list_callback'] : 'countries_country_expand';

  $filters = array(
    'continents' => array_filter($field['settings']['continents']),
    'enabled' => $field['settings']['enabled'],
  );

  if (!isset($field['#filters'])) {
    $field['#filters'] = $filters;
  }
  $field = $function($field);
  return $field['#options'];
}

But I think that the callback should be returning an options list if set. So I think that the valid usage is to not have this function to return the field and parse the options, but to return the results of that function directly. IE:

/**
 * Implements hook_options_list().
 */
function countries_options_list($field) {
  $function = !empty($field['settings']['options_list_callback']) ? $field['settings']['options_list_callback'] : 'countries_country_expand';

  $filters = array(
    'continents' => array_filter($field['settings']['continents']),
    'enabled' => $field['settings']['enabled'],
  );

  if (!isset($field['#filters'])) {
    $field['#filters'] = $filters;
  }
  if ($function == 'countries_country_expand') {
    $field = $function($field);
    return $field['#options'];
  }
  else {
    return $function($field);
  }
}

As I stated in the intro, I can not find the documentation on this and I have no idea how to test this either!

Let the options_list_callback handle this instead of adding some special behavior for countries_country_expand in countries_options_list().

Looks good, but maybe this is superseded with the changes in #1292044: Code cleanup and filter changes?

Patch added as part of #1132510: Integration with Entity API / Rules