Functions

Add a custom Comcode tag.

add_custom_comcode_tag(\ID_TEXT $tag, mixed $title, mixed $description, \LONG_TEXT $replace, \LONG_TEXT $example, \SHORT_TEXT $parameters, \BINARY $enabled, \BINARY $dangerous_tag, \BINARY $block_tag, \BINARY $textual_tag, boolean $uniqify = false) : \ID_TEXT
package custom_comcode

Parameters

$tag

\ID_TEXT

Tag name.

$title

mixed

Tag title (string, or language ID).

$description

mixed

Tag description (string, or language ID).

$replace

\LONG_TEXT

Tag replacement text.

$example

\LONG_TEXT

Tag example.

$parameters

\SHORT_TEXT

Tag parameters.

$enabled

\BINARY

Whether the tag is enabled.

$dangerous_tag

\BINARY

Whether the tag is disabled.

$block_tag

\BINARY

Whether the tag is a block tag.

$textual_tag

\BINARY

Whether the tag is a textual tag.

$uniqify

boolean

Whether to force the name as unique, if there's a conflict

Returns

\ID_TEXTThe tag name

Delete a custom Comcode tag.

delete_custom_comcode_tag(\ID_TEXT $tag) 
package custom_comcode

Parameters

$tag

\ID_TEXT

Tag name.

Edit a custom Comcode tag.

edit_custom_comcode_tag(\ID_TEXT $old_tag, \ID_TEXT $tag, \SHORT_TEXT $title, \LONG_TEXT $description, \LONG_TEXT $replace, \LONG_TEXT $example, \SHORT_TEXT $parameters, \BINARY $enabled, \BINARY $dangerous_tag, \BINARY $block_tag, \BINARY $textual_tag, boolean $uniqify = false) : \ID_TEXT
package custom_comcode

Parameters

$old_tag

\ID_TEXT

Current tag name.

$tag

\ID_TEXT

New tag name.

$title

\SHORT_TEXT

Tag title (string, or language ID).

$description

\LONG_TEXT

Tag description (string, or language ID).

$replace

\LONG_TEXT

Tag replacement text.

$example

\LONG_TEXT

Tag example.

$parameters

\SHORT_TEXT

Tag parameters.

$enabled

\BINARY

Whether the tag is enabled.

$dangerous_tag

\BINARY

Whether the tag is disabled.

$block_tag

\BINARY

Whether the tag is a block tag.

$textual_tag

\BINARY

Whether the tag is a textual tag.

$uniqify

boolean

Whether to force the name as unique, if there's a conflict

Returns

\ID_TEXTThe tag name