WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Template:Return

param (datatype) 
Description.

Description

The purpose of this template is to standardize how return values looks in Function Reference and Template Tags.

Usage

{{Return|param|datatype|description}}

Parameters

param
Return param or value (also can be: null, void...).
datatype
Datatype of return value.
description
Description of return value.

Example

{{Return|WP_User|object|[[Class_Reference/WP_User|WP_User]] object where it can be retrieved using member variables.}}

Output

WP_User (object) 
WP_User object where it can be retrieved using member variables.