API Documentation
Back to top  

package bbPress

 Methods

AddRule() 

AddRule($name, $rule) 

Parameters

$name

$rule

AddSmiley() 

AddSmiley($code, $image) 

Parameters

$code

$image

ClearRules() 

ClearRules() 

ClearSmileys() 

ClearSmileys() 

DoTag() 

DoTag($action, $tag_name, $default_value, $params, $contents) 

Parameters

$action

$tag_name

$default_value

$params

$contents

FillTemplate() 

FillTemplate($template, $insert_array, $default_array = array()) 

Parameters

$template

$insert_array

$default_array

FixupOutput() 

FixupOutput($string) 

Parameters

$string

GetAllowAmpersand() 

GetAllowAmpersand() 

GetDebug() 

GetDebug() 

GetDefaultLocalImgDir() 

GetDefaultLocalImgDir() 

GetDefaultLocalImgURL() 

GetDefaultLocalImgURL() 

GetDefaultRule() 

GetDefaultRule($name) 

Parameters

$name

GetDefaultRuleHTML() 

GetDefaultRuleHTML() 

GetDefaultRules() 

GetDefaultRules() 

GetDefaultSmiley() 

GetDefaultSmiley($code) 

Parameters

$code

GetDefaultSmileyDir() 

GetDefaultSmileyDir() 

GetDefaultSmileyURL() 

GetDefaultSmileyURL() 

GetDefaultSmileys() 

GetDefaultSmileys() 

GetDefaultWikiURL() 

GetDefaultWikiURL() 

GetDetectURLs() 

GetDetectURLs() 

GetEnableSmileys() 

GetEnableSmileys() 

GetIgnoreNewlines() 

GetIgnoreNewlines() 

GetLimit() 

GetLimit() 

GetLimitPrecision() 

GetLimitPrecision() 

GetLimitTail() 

GetLimitTail() 

GetLocalImgDir() 

GetLocalImgDir() 

GetLocalImgURL() 

GetLocalImgURL() 

GetPlainMode() 

GetPlainMode() 

GetPostTrim() 

GetPostTrim() 

GetPreTrim() 

GetPreTrim() 

GetRoot() 

GetRoot() 

GetRule() 

GetRule($name) 

Parameters

$name

GetRuleHTML() 

GetRuleHTML() 

GetSmiley() 

GetSmiley($code) 

Parameters

$code

GetSmileyDir() 

GetSmileyDir() 

GetSmileyURL() 

GetSmileyURL() 

GetTagMarker() 

GetTagMarker() 

GetURLPattern() 

GetURLPattern() 

GetURLTarget() 

GetURLTarget() 

GetURLTargetable() 

GetURLTargetable() 

GetWikiURL() 

GetWikiURL($url) 

Parameters

$url

HTMLEncode() 

HTMLEncode($string) 

Parameters

$string

Internal_AutoDetectURLs() 

Internal_AutoDetectURLs($string) 

Parameters

$string

Internal_CleanupWSByEatingInput() 

Internal_CleanupWSByEatingInput($pattern) 

Parameters

$pattern

Internal_CleanupWSByIteratingPointer() 

Internal_CleanupWSByIteratingPointer($pattern, $pos, $array) 

Parameters

$pattern

$pos

$array

Internal_CleanupWSByPoppingStack() 

Internal_CleanupWSByPoppingStack($pattern, $array) 

Parameters

$pattern

$array

Internal_CollectText() 

Internal_CollectText($array, $start = 0) 

Parameters

$array

$start

Internal_CollectTextReverse() 

Internal_CollectTextReverse($array, $start = 0, $end = 0) 

Parameters

$array

$start

$end

Internal_ComputeCurrentClass() 

Internal_ComputeCurrentClass() 

Internal_DoEnhancedTag() 

Internal_DoEnhancedTag($tag_rule, $params, $contents) 

Parameters

$tag_rule

$params

$contents

Internal_DoLimit() 

Internal_DoLimit() 

Internal_DumpStack() 

Internal_DumpStack($array = false, $raw = false) 

Parameters

$array

$raw

Internal_FinishTag() 

Internal_FinishTag($tag_name) 

Parameters

$tag_name

Internal_GenerateOutput() 

Internal_GenerateOutput($pos) 

Parameters

$pos

Internal_LimitText() 

Internal_LimitText($string, $limit) 

Parameters

$string

$limit

Internal_ParseEndTagToken() 

Internal_ParseEndTagToken() 

Internal_ParseStartTagToken() 

Internal_ParseStartTagToken() 

Internal_ProcessIsolatedTag() 

Internal_ProcessIsolatedTag($tag_name, $tag_params, $tag_rule) 

Parameters

$tag_name

$tag_params

$tag_rule

Internal_ProcessSmileys() 

Internal_ProcessSmileys($string) 

Parameters

$string

Internal_ProcessVerbatimTag() 

Internal_ProcessVerbatimTag($tag_name, $tag_params, $tag_rule) 

Parameters

$tag_name

$tag_params

$tag_rule

Internal_RebuildSmileys() 

Internal_RebuildSmileys() 

Internal_RewindToClass() 

Internal_RewindToClass($class_list) 

Parameters

$class_list

Internal_UpdateParamsForMissingEndTag() 

Internal_UpdateParamsForMissingEndTag($params) 

Parameters

$params

IsValidEmail() 

IsValidEmail($string) 

Parameters

$string

IsValidURL() 

IsValidURL($string, $email_too = true) 

Parameters

$string

$email_too

Parse() 

Parse($string) 

Parameters

$string

RemoveRule() 

RemoveRule($name) 

Parameters

$name

RemoveSmiley() 

RemoveSmiley($code) 

Parameters

$code

SetAllowAmpersand() 

SetAllowAmpersand($enable = true) 

Parameters

$enable

SetDebug() 

SetDebug($enable = true) 

Parameters

$enable

SetDefaultRule() 

SetDefaultRule($name) 

Parameters

$name

SetDefaultRules() 

SetDefaultRules() 

SetDefaultSmiley() 

SetDefaultSmiley($code) 

Parameters

$code

SetDefaultSmileys() 

SetDefaultSmileys() 

SetDetectURLs() 

SetDetectURLs($enable = true) 

Parameters

$enable

SetEnableSmileys() 

SetEnableSmileys($enable = true) 

Parameters

$enable

SetIgnoreNewlines() 

SetIgnoreNewlines($ignore = true) 

Parameters

$ignore

SetLimit() 

SetLimit($limit = 0) 

Parameters

$limit

SetLimitPrecision() 

SetLimitPrecision($prec = 0.15) 

Parameters

$prec

SetLimitTail() 

SetLimitTail($tail = "...") 

Parameters

$tail

SetLocalImgDir() 

SetLocalImgDir($path) 

Parameters

$path

SetLocalImgURL() 

SetLocalImgURL($path) 

Parameters

$path

SetPlainMode() 

SetPlainMode($enable = true) 

Parameters

$enable

SetPostTrim() 

SetPostTrim($trim = "a") 

Parameters

$trim

SetPreTrim() 

SetPreTrim($trim = "a") 

Parameters

$trim

SetRoot() 

SetRoot($class = 'block') 

Parameters

$class

SetRootBlock() 

SetRootBlock() 

SetRootInline() 

SetRootInline() 

SetRuleHTML() 

SetRuleHTML($html) 

Parameters

$html

SetSmileyDir() 

SetSmileyDir($path) 

Parameters

$path

SetSmileyURL() 

SetSmileyURL($path) 

Parameters

$path

SetTagMarker() 

SetTagMarker($marker = '[') 

Parameters

$marker

SetURLPattern() 

SetURLPattern($pattern) 

Parameters

$pattern

SetURLTarget() 

SetURLTarget($target) 

Parameters

$target

SetURLTargetable() 

SetURLTargetable($enable) 

Parameters

$enable

SetWikiURL() 

SetWikiURL($url) 

Parameters

$url

UnHTMLEncode() 

UnHTMLEncode($string) 

Parameters

$string

WasLimited() 

WasLimited() 

Wikify() 

Wikify($string) 

Parameters

$string

_UnHTMLEncode_chr_callback() 

_UnHTMLEncode_chr_callback($match) 

Parameters

$match

_UnHTMLEncode_chr_hexdec_callback() 

_UnHTMLEncode_chr_hexdec_callback($match) 

Parameters

$match

getInstance() 

getInstance() 
Static

nl2br() 

nl2br($string) 

Parameters

$string

__construct() 

__construct() 

 Properties

 

$allow_ampersand

$allow_ampersand 

Default

 

$current_class

$current_class 

Default

 

$debug

$debug 

Default

 

$defaults

$defaults 

Default

 

$detect_urls

$detect_urls 

Default

 

$enable_smileys

$enable_smileys 

Default

 

$ignore_newlines

$ignore_newlines 

Default

 

$limit_precision

$limit_precision 

Default

 

$limit_tail

$limit_tail 

Default

 

$local_img_dir

$local_img_dir 

Default

 

$local_img_url

$local_img_url 

Default

 

$lost_start_tags

$lost_start_tags 

Default

 

$output_limit

$output_limit 

Default

 

$plain_mode

$plain_mode 

Default

 

$post_trim

$post_trim 

Default

 

$pre_trim

$pre_trim 

Default

 

$root_class

$root_class 

Default

 

$rule_html

$rule_html 

Default

 

$smiley_dir

$smiley_dir 

Default

 

$smiley_regex

$smiley_regex 

Default

 

$smiley_url

$smiley_url 

Default

 

$smileys

$smileys 

Default

 

$start_tags

$start_tags 

Default

 

$tag_marker

$tag_marker 

Default

 

$tag_rules

$tag_rules 

Default

 

$text_length

$text_length 

Default

 

$url_pattern

$url_pattern 

Default

 

$url_target

$url_target 

Default

 

$url_targetable

$url_targetable 

Default

 

$was_limited

$was_limited 

Default

 

$wiki_url

$wiki_url 

Default

 

$instance

$instance 

Default

Static