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:Parameter

{{{1}}}
({{{2}}}) (required) {{{3}}}
Default: None

Notes

This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called:

{{Parameter|$something|string|This is a string.|optional|bah}}

The usage of this template is below:

{{Parameter|name|datatype|description|importance|default}}

Let's take a closer look at the parameters..

name
The name of the parameter.
datatype
The datatype that should be given for this parameter when called.
description
A short description of the parameter.
importance
Set this parameter to optional if the parameter is optional. Otherwise, do not declare this parameter—it defaults to required.
default
If this parameter is optional, default is the value that will be used if the parameter is not declared.