Interface for BP_Transients;

A BP_Transients class must be implemented by the host application for BackPress to operate. This interface supplies a boilerplate for that class but can only be implemented in PHP 5 environments.

since r205
package BackPress

 Methods

Deletes an existing transient.

delete(string $transient) 
since r205

Parameters

$transient

string

Transient name.

Retrieve the value of the transient.

get(string $transient) 
since r205

Parameters

$transient

string

Transient name.

Retrieve the prefix to be appended to the beginning of the transient key.

prefix() 
since r205

Sets the value of a transient with a given value.

set(string $transient, mixed $value, integer $expiration = 0
since r205

Parameters

$transient

string

Transient name.

$value

mixed

Transient value.

$expiration

integer

The time in seconds the transient will be held for. Default is 0, meaning it is held indefinitely.