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.

Pagination Library Extension Hooks

pagination_create

pagination_create($this, $count)

Rewrite the pagination function in the Pagination library and possible expand the types of pagination available.

How it’s called:

$this->extensions->call('pagination_create', $this, $count);
if ($this->extensions->end_script === TRUE) return;
Parameters:
  • $this (object) – Currently instantiated object for EE_Pagination class, remember to call this with a reference if you want to modify the object.
  • $count (int) – Number of items being paginated
Return type:

Void

New in version 2.8.

channel_module_create_pagination

channel_module_create_pagination($this, $count)

New in version 1.4.0.

Deprecated since version 2.8: Renamed in 2.8. Use pagination_create instead.

pagination_fetch_data

pagination_fetch_data($this)

Works with the ‘pagination_create’ hook so you can modify rendered {paginate} tagdata.

How it’s called:

$this->extensions->call('pagination_fetch_data', $this);
if ($this->extensions->end_script === TRUE) return;
Parameters:
  • $this (object) – Currently instantiated object for EE_Pagination class, remember to call this with a reference if you want to modify the object.
Return type:

Void

New in version 2.8.

channel_module_fetch_pagination_data

channel_module_fetch_pagination_data($this)

New in version 1.4.0.

Deprecated since version 2.8: Renamed in 2.8. Use pagination_fetch_data instead.