ExpressionEngine® User Guide

Legacy Documentation

You are using the documentation for version 4.3.8. Go here for the latest version.

CategoryGroup Model Extension Hooks

before_category_group_insert

before_category_group_insert($category_group, $values)

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

How it’s called:

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

void

Return type:

NULL

New in version 3.3.0.

after_category_group_insert

after_category_group_insert($category_group, $values)

Called after the category group 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_group_insert', $this, $this->getValues());
Parameters:
  • $category_group (object) – Current CategoryGroup model object
  • $values (array) – The CategoryGroup model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

before_category_group_update

before_category_group_update($category_group, $values, $modified)

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

How it’s called:

ee()->extensions->call('before_category_group_update', $this, $this->getValues(), $modified);
Parameters:
  • $category_group (object) – Current CategoryGroup model object
  • $values (array) – The CategoryGroup 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_group_update

after_category_group_update($category_group, $values, $modified)

Called after the category group 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_group_update', $this, $this->getValues(), $modified);
Parameters:
  • $category_group (object) – Current CategoryGroup model object
  • $values (array) – The CategoryGroup 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_group_save

before_category_group_save($category_group, $values)

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

How it’s called:

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

void

Return type:

NULL

New in version 3.3.0.

after_category_group_save

after_category_group_save($category_group, $values)

Called after the category group 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_group_save', $this, $this->getValues());
Parameters:
  • $category_group (object) – Current CategoryGroup model object
  • $values (array) – The CategoryGroup model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

before_category_group_delete

before_category_group_delete($category_group, $values)

Called before the category group 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_group_delete', $this, $this->getValues());
Parameters:
  • $category_group (object) – Current CategoryGroup model object
  • $values (array) – The CategoryGroup model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

after_category_group_delete

after_category_group_delete($category_group, $values)

Called after the category group 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_group_delete', $this, $this->getValues());
Parameters:
  • $category_group (object) – Current CategoryGroup model object
  • $values (array) – The CategoryGroup model object data as an array
Returns:

void

Return type:

NULL

New in version 3.3.0.

before_category_group_bulk_delete

before_category_group_bulk_delete($delete_ids)

Called before a bulk of category group objects are deleted. If you need to do an expensive operation when category groups are deleted, it may be more efficient to handle it in bulk here.

How it’s called:

ee()->extensions->call('before_category_group_bulk_delete', $delete_ids);
Parameters:
  • $delete_ids (array) – The primary key IDs of the models being deleted
Returns:

void

Return type:

NULL

New in version 4.3.0.

after_category_group_bulk_delete

after_category_group_bulk_delete($delete_ids)

Called after a bulk of category group objects are deleted. If you need to do an expensive operation when category groups are deleted, it may be more efficient to handle it in bulk here.

How it’s called:

ee()->extensions->call('after_category_group_bulk_delete', $delete_ids);
Parameters:
  • $delete_ids (array) – The primary key IDs of the models being deleted
Returns:

void

Return type:

NULL

New in version 4.3.0.