develop:functionh

An Index of PHPlist Functions and Class Methods

The location of the definition of each function or method is listed by file name and line number. Each file is located relative to the admin directory in the phplist distribution, that is, relative to the subdirectory public_html/lists/admin.

For each function or method, the arguments are listed and explained, as well as the return value if any. Some explanation of the function is planned to be given among the Comments. These pages are under construction. Most entries are incomplete. But every entry has the location for the definition of the function or method, so that you can look up the definition in file containing the source code.

The line numbers shown for each function listed correspond to version 3.05 of Phplist. In most cases the locations of these functions have changed in later releases, Usually these functions involve only a small change in the line number, so that you can locate the function in the vicinity of the line number specified.

Back

Up to Index

commonlib/lib/interfacelib.php, line 1336

Arguments:
Return value:
Comments:

HelloWorld($params)

defaultplugin.php, line 356

Arguments:
1. $params
Return value:
Comments:

Help($topic, $text = '?')

connect.php, line 1275

Arguments:
1. $topic
2. $text
Return value:
Comments:

hide()

commonlib/lib/interfacelib.php, line 1178

Arguments:
Return value:
Comments:

hideadminbar()

commonlib/lib/interfacelib.php, line 761

Arguments:
Return value:
Comments:

HTML2Text($text)

commonlib/lib/maillib.php, line 12

Arguments:
1. $text
Return value:
Comments:

i18nLanguageDir()

defaultplugin.php, line 175

Arguments:
Return value:
Comments:

image_exists($templateid,$filename)

class.phplistmailer.php, line 479

Arguments:
1. $templateid
2. $filename
Return value:
Comments:

importContent()

defaultplugin.php, line 744

Arguments:
Return value:
Comments:

importReport($report)

defaultplugin.php, line 591

Arguments:
1. $report
Return value:
Comments:

includeStyles($text)

lib.php, line 863

Arguments:
1. $text
Return value:
Comments:

index()

commonlib/lib/interfacelib.php, line 355

Arguments:
Return value:
Comments:

Info($msg)

commonlib/lib/errorlib.php, line 171

Arguments:
1. $msg
Return value:
Comments:

Info($msg,$noClose = false)

connect.php, line 474

Arguments:
1. $msg
2. $noClose
Return value:
Comments:

initFSTranslations($language = '')

languages.php, line 462

Arguments:
1. $language
Return value:
Comments:

initialise()

defaultplugin.php, line 145

Arguments:
Return value:
Comments:

initialiseUserSession()

commonlib/lib/userlib.php, line 12

Arguments:
Return value:
Comments:

interval($seconds = 0)

connect.php, line 1883

Arguments:
1. $seconds
Return value:
Comments:

is_email($email)

commonlib/lib/userlib.php, line 494

Arguments:
1. $email
Return value:
Comments:

isBlackListed($email = "",$immediate = true)

commonlib/lib/userlib.php, line 344

Arguments:
1. $email
2. $immediate
Return value:
Comments:

isBlackListedID($userid = 0)

commonlib/lib/userlib.php, line 361

Arguments:
1. $userid
Return value:
Comments:

isGuestAccount()

commonlib/lib/userlib.php, line 922

Arguments:
Return value:
Comments:

isSuperUser()

accesscheck.php, line 26

Arguments:
Return value:
Comments:

isValidRedirect($url)

lib.php, line 909

Arguments:
1. $url
Return value:
Comments:

join_clean($sep,$array)

connect.php, line 417

Arguments:
1. $sep
2. $array
Return value:
Comments:

keepLock($processid)

lib.php, line 775

Arguments:
1. $processid
Return value:
Comments:

langChange()

installer/home.php, line 24

Arguments:
Return value:
Comments:

lanSort($a,$b)

languages.php, line 60

Arguments:
1. $a
2. $b
Return value:
Comments:

linkencode($p_url)

sendemaillib.php, line 1037

Arguments:
1. $purl
  * Return value:
  * Comments:
  ===ListAllAttributes()===
  <code>subscribelib2.php, line 1263</code>
  * Arguments:
  * Return value:
  * Comments:
  ===listArray($array,$indent = 0)===
  <code>commonlib/lib/errorlib.php, line 37</code>
  * Arguments:
  -$array
  -$indent
  * Return value:
  * Comments:
  ===ListAttributes($attributes,$attributedata,$htmlchoice = 0,$userid = 0,$emaildoubleentry='no' )===
  <code>subscribelib2.php, line 734</code>
  * Arguments:
  -$attributes
  -$attributedata
  -$htmlchoice
  -$userid
  -$emaildoubleentry
  * Return value:
  * Comments:
  ===ListAttributes2011($attributes,$attributedata,$htmlchoice = 0,$userid = 0,$emaildoubleentry='no' )===
  <code>subscribelib2.php, line 1016</code>
  * Arguments:
  -$attributes
  -$attributedata
  -$htmlchoice
  -$userid
  -$emaildoubleentry
  * Return value:
  * Comments:
  ===ListAvailableLists($userid = 0,$liststoshow = “”)===
  <code>subscribelib2.php, line 667</code>
  * Arguments:
  -$userid
  -$liststo_show
Return value:
Comments:

lib.php, line 1493

Arguments:
Return value:
Comments:

listingElement($element)

commonlib/lib/interfacelib.php, line 489

Arguments:
1. $element
Return value:
Comments:

listingEnd()

commonlib/lib/interfacelib.php, line 576

Arguments:
Return value:
Comments:

listingHeader()

commonlib/lib/interfacelib.php, line 457

Arguments:
Return value:
Comments:

listingStart($class="")

commonlib/lib/interfacelib.php, line 453

Arguments:
1. $class
Return value:
Comments:

listName($id)

lib.php, line 42

Explanation: Returns the name of a list from the database, given the ID of the list.
Arguments:
1. $id: The numerical ID of the list in the database
Return value: The list name as a string
Comments:

ListofLists($current,$fieldname,$subselect)

connect.php, line 1102

Arguments:
1. $current
2. $fieldname
3. $subselect
Return value:
Comments:

listOwner($listid = 0)

lib.php, line 612

Arguments:
1. $listid
Return value:
Comments:

listPlaceHolders()

connect.php, line 1725

Arguments:
Return value:
Comments:

listSelectHTML ($current,$fieldname,$subselect,$alltab = '')

connect.php, line 1165

Arguments:
1. $current
2. $fieldname
3. $subselect
4. $alltab
Return value:
Comments:

listStyle($style)

commonlib/lib/interfacelib.php, line 847

Arguments:
1. $style
Return value:
Comments:

listUsedInSubscribePage($listid = 0)

lib.php, line 618

Arguments:
1. $listid
Return value:
Comments:

loadBounceRules($all = 0)

lib.php, line 1283

Arguments:
1. $all
Return value:
Comments:

loadCCvalidationFile($ccrangefile)

commonlib/lib/userlib.php, line 720

Arguments:
1. $ccrangefile
Return value:
Comments:

loadMessageData($msgid)

lib.php, line 82

Explanation: loads all of the data of the next message to be processed in the queue.
Arguments:
1. $msgid: The numerical id of the message in the data base.
Return value: the array of data. For a list of the elements of this array see lines 104 to 132 in lib.php
Comments:

loadUser($loginname = "")

commonlib/lib/userlib.php, line 808

Arguments:
1. $loginname
Return value:
Comments:

LogError($error)

commonlib/lib/errorlib.php, line 175

Arguments:
1. $error
Return value:
Comments:

logEvent($msg = '')

defaultplugin.php, line 655

Arguments:
1. $msg
Return value:
Comments:

logEvent($msg)

lib.php, line 650

Arguments:
1. $msg
Return value:
Comments:

logout()

defaultplugin.php, line 665

Arguments:
Return value:
Comments: