ExpressionEngine® 3 User Guide

Legacy Documentation

You are using the documentation for version 3.5.17. Go here for the latest version or check here for your available upgrades to the latest version.

CategoryField Model Extension Hooks

before_category_field_insert

before_category_field_insert($category_field, $values)

Called before the category field object is inserted. Changes made to the object will be saved automatically.

How it’s called:

ee()->extensions->call('before_category_field_insert', $this, $this->getValues());
Parameters:
  • $category_field (object) – Current CategoryField model object
  • $values (array) – The CategoryField model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

after_category_field_insert

after_category_field_insert($category_field, $values)

Called after the category field object is inserted. Changes made to the object object will not be saved automatically. Saving the object may trigger the save and update hooks.

How it’s called:

ee()->extensions->call('after_category_field_insert', $this, $this->getValues());
Parameters:
  • $category_field (object) – Current CategoryField model object
  • $values (array) – The CategoryField model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

before_category_field_update

before_category_field_update($category_field, $values, $modified)

Called before the category field object is updated. Changes made to the object will be saved automatically.

How it’s called:

ee()->extensions->call('before_category_field_update', $this, $this->getValues(), $modified);
Parameters:
  • $category_field (object) – Current CategoryField model object
  • $values (array) – The CategoryField model object data as an array
  • $modified (array) – An array of all the old values that were changed
Returns:

void

Return type:

NULL

New in version 3.3.0.

after_category_field_update

after_category_field_update($category_field, $values, $modified)

Called after the category field object is updated. Changes made to the object will not be saved automatically. Calling save may fire additional hooks.

How it’s called:

ee()->extensions->call('after_category_field_update', $this, $this->getValues(), $modified);
Parameters:
  • $category_field (object) – Current CategoryField model object
  • $values (array) – The CategoryField model object data as an array
  • $modified (array) – An array of all the old values that were changed
Returns:

void

Return type:

NULL

New in version 3.3.0.

before_category_field_save

before_category_field_save($category_field, $values)

Called before the category field object is inserted or updated. Changes made to the object will be saved automatically.

How it’s called:

ee()->extensions->call('before_category_field_save', $this, $this->getValues());
Parameters:
  • $category_field (object) – Current CategoryField model object
  • $values (array) – The CategoryField model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

after_category_field_save

after_category_field_save($category_field, $values)

Called after the category field object is inserted or updated. Changes made to the object will not be saved automatically. Calling save may fire additional hooks.

How it’s called:

ee()->extensions->call('after_category_field_save', $this, $this->getValues());
Parameters:
  • $category_field (object) – Current CategoryField model object
  • $values (array) – The CategoryField model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

before_category_field_delete

before_category_field_delete($category_field, $values)

Called before the category field object is deleted. If you are conditionally deleting one of your own models, please consider creating an inverse relationship instead. This will provide better performance and strictly enforce data consistency.

How it’s called:

ee()->extensions->call('before_category_field_delete', $this, $this->getValues());
Parameters:
  • $category_field (object) – Current CategoryField model object
  • $values (array) – The CategoryField model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

after_category_field_delete

after_category_field_delete($category_field, $values)

Called after the category field object is deleted. If you are conditionally deleting one of your own models, please consider creating an inverse relationship instead. This will provide better performance and strictly enforce data consistency.

How it’s called:

ee()->extensions->call('after_category_field_delete', $this, $this->getValues());
Parameters:
  • $category_field (object) – Current CategoryField model object
  • $values (array) – The CategoryField model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.