AbstractShortcode
in package

Tags
since
1.0

Table of Contents

$attributes  : array<string|int, mixed>
$name  : string
__construct()  : mixed
getAttributes()  : array<string|int, mixed>
getDefaultArgs()  : array<string|int, mixed>
getLabel()  : string
getName()  : string
register()  : mixed
render()  : string
validateArgs()  : array<string|int, mixed>
addActions()  : mixed
getAttributeType()  : string
parseArgs()  : array<string|int, mixed>
renderContent()  : string

Properties

$attributes

protected array<string|int, mixed> $attributes = []
Tags
since
1.2

$name

protected string $name
Tags
since
1.0

Methods

__construct()

public __construct() : mixed
Tags
since
1.0
Return values
mixed —

getAttributes()

public getAttributes() : array<string|int, mixed>
Tags
since
1.2
Return values
array<string|int, mixed> —

getDefaultArgs()

public getDefaultArgs() : array<string|int, mixed>
Tags
since
1.2
Return values
array<string|int, mixed> —

getLabel()

public abstract getLabel() : string
Tags
since
1.2
Return values
string —

getName()

public abstract getName() : string
Tags
since
1.0
Return values
string —

register()

public register() : mixed
Tags
access

protected

since
1.0
Return values
mixed —

render()

public render(array<string|int, mixed> $args[, string $content = '' ][, string $shortcodeTag = '' ]) : string
Parameters
$args : array<string|int, mixed>
$content : string = ''

Optional. '' by default.

$shortcodeTag : string = ''

Optional. '' by default.

Tags
since
1.0
Return values
string —

validateArgs()

public validateArgs(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>
Tags
since
1.2
Return values
array<string|int, mixed> —

addActions()

protected addActions() : mixed
Tags
since
1.0
Return values
mixed —

getAttributeType()

protected getAttributeType(string $name[, string $default = 'undefined' ]) : string
Parameters
$name : string
$default : string = 'undefined'

Optional. 'undefined' by default.

Tags
since
1.2
Return values
string —

parseArgs()

protected parseArgs(array<string|int, mixed> $args, array<string|int, mixed> $defaults, string $content, string $shortcodeTag) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>
$defaults : array<string|int, mixed>
$content : string
$shortcodeTag : string
Tags
since
1.2
Return values
array<string|int, mixed> —

renderContent()

protected abstract renderContent(array<string|int, mixed> $args, string $content, string $shortcodeTag) : string
Parameters
$args : array<string|int, mixed>
$content : string
$shortcodeTag : string
Tags
since
1.0
Return values
string —

Search results