data/TWiki/VarUSERINFO.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1170579877" format="1.1" version="3"}%
colas@0
     2
%META:TOPICPARENT{name="TWikiVariables"}%
colas@0
     3
#VarUSERINFO
colas@0
     4
---+++ USERINFO{"WikiName"} -- retrieve details about a user
colas@0
     5
   * Syntax: =%<nop>USERINFO%=
colas@0
     6
   * Expands to: <code>%USERINFO%</code> (comma-separated list of the username, wikiusername, and emails)
colas@0
     7
   * With formatted output, using tokens =$emails=, =$username=, =$wikiname=, =$wikiusername=, =$groups= and =$admin= ($admin returns 'true' or 'false'):
colas@0
     8
      * Example: =%<nop>USERINFO{ format="$username is really $wikiname" }%=
colas@0
     9
      * Expands to: =%USERINFO{ format="$username is really !$wikiname" }%=
colas@0
    10
   * Retrieve information about another user:
colas@0
    11
      * Example: =%<nop>USERINFO{ "TWikiGuest" format="$username is really $wikiname" }%=
colas@0
    12
      * Expands to: <code>%USERINFO{ "TWikiGuest" format="$username is really !$wikiname" }%</code>
colas@0
    13
      * __Note:__ The parameter should be the wikiname of a user. You can only get information about another user if the ={AntiSpam}{HideUserDetails}= configuration option is not enabled, or if you are an admin. %IF{"{AntiSpam}{HideUserDetails}" then=" _(User details are hidden in this TWiki)_ "}%
colas@0
    14
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarUSERNAME][USERNAME]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarWIKINAME][WIKINAME]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarWIKIUSERNAME][WIKIUSERNAME]], TWikiUserAuthentication, ChangeEmailAddress