previousPageLink()

Signature

previousPageLink() — returns string

Available in: controller Category: Pagination Functions

Description

Creates a link to the previous page, or a disabled span when on the first page.

Parameters

Name	Type	Required	Default	Description
text	string	no	Previous	The text for the link.
handle	string	no	query	The handle given to the query that the pagination should be displayed for.
name	string	no	page	The name of the param that holds the current page number.
class	string	no	—	CSS class for the link element.
disabledClass	string	no	disabled	CSS class for the disabled span element.
showDisabled	boolean	no	true	Whether to render a disabled span when on the first page.
pageNumberAsParam	boolean	no	true	Decides whether to link the page number as a param or as part of a route.
encode	any	no	true	Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content.

Examples

//--------------------------------------------------------------------
// Example 1: Basic usage — show a "Previous" link above a paginated list;
// renders a disabled span when already on the first page

// Controller code
param name="params.page" type="integer" default="1";
posts = model("Post").findAll(page=params.page, perPage=10, order="createdAt DESC");

// View code
<cfoutput>
    #firstPageLink()#
    #previousPageLink()#
    #pageNumberLinks()#
    #nextPageLink()#
    #lastPageLink()#
</cfoutput>


//--------------------------------------------------------------------
// Example 2: Custom link text and CSS classes

// View code
<cfoutput>
    #previousPageLink(
        text="&laquo; Previous",
        class="page-link",
        disabledClass="page-link disabled"
    )#
</cfoutput>


//--------------------------------------------------------------------
// Example 3: Hide the disabled element entirely when on the first page

// View code
<cfoutput>
    #previousPageLink(showDisabled=false)#
</cfoutput>


//--------------------------------------------------------------------
// Example 4: Use a named route so page numbers appear in the URL path
// instead of as a query-string param (e.g. /articles/page/2)

// Route setup in app/config/routes.cfm
mapper()
    .get(name="paginatedArticles", pattern="articles/page/[page]", to="articles##index")
    .get(name="articles", pattern="articles", to="articles##index")
.end();

// Controller code
param name="params.page" type="integer" default="1";
articles = model("Article").findAll(page=params.page, perPage=20, order="title");

// View code
<cfoutput>
    #previousPageLink(route="paginatedArticles", pageNumberAsParam=false)#
</cfoutput>