Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

trash_count

Summary

Fetches the number of objects that are in the trash.

Usage

fetch('content', 'trash_count', hash ('attribute_filter', array))
 

Parameters

NameTypeDescriptionRequired
attribute_filter mixed A new parameter since eZ Publish 4.1. This enables you to run attribute filtering for trash items No.

Returns

An integer revealing the number of objects that are in the trash.

Description

This function returns the number of objects (as an integer) that are in the trash. An object is considered to be in the trash if its status field is set to archived.

For more information regarding the use of the "attribute_filter" parameter, please visit the following page.

Examples

Example 1

{def $trash_count=fetch('content', 'trash_count' )}
There are {$trash_count} objects in the trash.

Outputs the number of items that are in the trash.

Example 2

fetch('content', 'trash_count', hash('attribute_filter', array(...)))</pre>

Balazs Halasy (06/02/2004 12:13 pm)

Ester Heylen (18/11/2009 3:31 pm)

Balazs Halasy, Ester Heylen


Comments

There are no comments.