template()

Display the page template.

Display the page template

Function Definition

public function template ( $template, $code = null, $deprecated = false )

Source File: /pods/classes/Pods.php

Since: 2.0

Parameters

PARAMETERTYPEDETAILS
$template(string)The template name
$code(string)Custom template code to use instead
$deprecated(bool)Whether to use deprecated functionality based on old function usage

Returns

(mixed) Template output

Examples

Display Items With A Template

This method does its own internal loop, therefore parsing Pods items with template() is very easy.

<?php
echo pods( 'pod_name', array( 'limit' => 5 ) )->template( 'template_name' );

Using template() In A Loop

While using a while loop around template() is not necessary, it might be required. If that is the case, it is necessary to reset the id before calling template(). This causes its internal loop to only output one item and allows the main loop to function as expected.

<?php
$params = array( 'limit' => -1 );
$pods = pods( 'pod_name', $params );
if ( $pods->total() > 0 ) {
    while( $pods->fetch() )  {

        //reset id
        $pods->id = $pods->id();
        
        //get the template
        $temp = $pods->template( 'name of template' );
        //output template if it exists
        if ( isset( $temp )  ) {
            echo $pods->display( 'some_other_field' );
            echo $temp;
        }

    }
    //pagination
    echo $pods->pagination();

}
else {
    echo 'No content found.';

}

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.

total_found()

Fetch to total number of rows found.

total()

Fetch the total row count.

valid()

Pod object validity.

zebra()

Fetch the zebra switch.