$fields->changeFieldtype() method

Change a field's type

Usage

// basic usage
$bool = $fields->changeFieldtype(Field $field1);

// usage with all arguments
$bool = $fields->changeFieldtype(Field $field1, bool $keepSettings = false);

Arguments

NameType(s)Description
field1Field

Field with the new type already assigned

keepSettings (optional)bool

Whether or not to keep custom $data settings (default=false)

Return value

bool

Exceptions

Method can throw exceptions on error:

  • WireException


Hooking $fields->changeFieldtype(…)

You can add your own hook events that are executed either before or after the $fields->changeFieldtype(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $fields->changeFieldtype(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Fields::changeFieldtype', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fields = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $field1 = $event->arguments(0);
  $keepSettings = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $field1);
  $event->arguments(1, $keepSettings);
});

Hooking after

The 'after' hooks are called immediately after each $fields->changeFieldtype(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Fields::changeFieldtype', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fields = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $field1 = $event->arguments(0);
  $keepSettings = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$fields methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022
  • New post: ProcessWire now comes with just 1 site installation profile, the "blank" profile. It makes very few assumptions, making it a minimal though excellent starting point. Here’s how you might use it— More
    10 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Starting a site with the “blank” profile
    ProcessWire 3.0.200+ comes with just 1 site installation profile, the site-blank profile. This profile makes very few assumptions, making it a minimal though excellent starting point. Here’s how you might use it. 
    Blog / 10 June 2022
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer