Differences

This shows you the differences between two versions of the page.

--- devel:event:common_user_link [2014-03-16 23:50] – [Plugins handling this event] Klap-in
+++ devel:event:common_user_link [2018-05-29 17:10] – andi
@@ Line 1: / Line 1: @@
 ====== COMMON_USER_LINK ======
-[[devel:develonly]]
 ---- dataentry event ----
@@ Line 10: / Line 8: @@
 ----
-When the [[config:showuseras]] config is set to the user interwiki link, this event is signalled by [[xref>userlink()]] in [[xref>inc/common.php]]. Handlers can use it to implement there own formatted user name instead of the user interwiki link.
+When the [[config:showuseras]] config is set to the user interwiki link, this event is signalled by [[xref>userlink()]] in [[xref>inc/common.php]]. Handlers can use it to implement their own formatted user name instead of the user [[:interwiki]] link.
 ===== Passed Data =====
+The passed [[xref>Doku_Event]] object has the field: ''$data''.
-The passed $data structure:
+The ''$data'' field is an array with the structure:
   * ''$data['username']'' The unique user name
@@ Line 24: / Line 23: @@
 The BEFORE event has only the ''username'' and ''textonly'' fields filled. The AFTER event has all field filled.
+After that the COMMON_USER_LINK event is handled, the formatted user name stored in ''$data['userlink']'' will be returned  by [[xref>userlink()]].
 ===== Plugins handling this event =====
 The following plugins are known to handle this event and their source code may be a good start for understanding and implementing a handler yourself.
-  * none
+  * [[plugin:userhomepage|User HomePage Plugin]]
 ===== See also =====
+  * [[codesearch>COMMON_USER_LINK|Code related to this event]]
   * The [[config:showuseras]] config let you choice the user interwiki link as the user link format.
   * Default the user [[:interwiki|interwiki]] link is configured to refer to '':user:<username>''.