total()

Fetch the total row count.

Fetch the total row count returned by the last call to find(), based on the ‘limit’ parameter set. This is different than the total number of rows found in the database, which you can get with total_found().

Function Definition

public function total ()

Source File: /pods/classes/Pods.php

Since: 2.0

Returns

(int) Number of rows returned by find(), based on the ‘limit’ parameter set

Examples

Example 1

<?php
    // Pod is 'rabbits' Pod and it has 8 records

    // Let's get 3 items ordered by name
    $params = array(
        'limit'   => 3,
        'orderby' => 't.name'
    );

    $rabbits = pods( 'rabbits', $params );
?>

total_found(): <?php echo $rabbits->total_found(); ?>
total(): <?php echo $rabbits->total(); ?>

The above example will output:

total_found(): 8
total(): 3

Other Helpful Documentation on pods()

add_to()

Add an item to the values of a relationship field.

add()

Add an item to a Pod.

data()

Return an array of all rows returned from a find() call.

delete()

Delete an item from the Pod.

display()

Return the output for a field.

do_magic_tags()

Replace magic tags with their values.

duplicate()

Duplicate an item.

exists()

Whether a Pod item exists or not when using fetch() or construct with an ID or slug.

export_data()

Export data from all items.

export()

Export an item’s data.

fetch()

Fetch an item from a Pod.

field()

Return the value for a field.

fields()

Return field array from a Pod, a field’s data, or a field option.

filters()

Output search filters to be used with find().

find()

Find items of a pod.

first_id()

Return the first item ID.

form()

Embed a form to add / edit a pod item from within your theme.

helper()

Run a helper within a Pod Page or WP Template.

id()

Return the item ID.

import()

Import data.

index()

Return the item name.

last_id()

Return the last item ID.

next_id()

Return the next item ID.

nth()

Fetch the nth state.

pagination()

Display the pagination controls.

position()

Fetch the current position in the loop.

prev_id()

Return the previous item ID.

raw()

Return the raw output for a field.

remove_from()

Remove values from fields.

reset_pod()

Delete all items from the Pod.

reset()

Reset the item position back to the start of the find() list.

row()

Return row array for an item.

save()

Save an item.

template()

Display the page template.

total_found()

Fetch to total number of rows found.

valid()

Pod object validity.

zebra()

Fetch the zebra switch.