Procedural File: _user.funcs.php
Source Location: /blogs/inc/users/model/_user.funcs.php
Functions
get_user_admin_link [line 306]
string get_user_admin_link(
[string $before = ''], [string $after = ''], [string $link_text = ''], [string $link_title = '#'], [string $not_visible = '']
)
|
|
Template tag: Get a link to the backoffice.
Usually provided in skins in order for newbies to find the admin interface more easily...
Parameters:
|
string |
$before: |
To be displayed before the link. |
|
string |
$after: |
To be displayed after the link. |
|
string |
$link_text: |
The page/controller to link to inside of $admin_url |
|
string |
$link_title: |
Text for the link. |
|
string |
$not_visible: |
Title for the link. |
get_user_logout_link [line 234]
string get_user_logout_link(
[string $before = ''], [string $after = ''], [string $link_text = ''], [ $link_title = '#'], [ $params = array()]
)
|
|
Template tag: Get a link to logout
Parameters:
|
string |
$before: |
|
|
string |
$after: |
|
|
string |
$link_text: |
link text can include %s for current user login |
|
|
$link_title: |
|
|
|
$params: |
|
get_user_profile_link [line 351]
string|false get_user_profile_link(
[ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#']
)
|
|
Template tag: Get a link to user profile
Parameters:
|
|
$before: |
|
|
|
$after: |
|
|
|
$link_text: |
|
|
|
$link_title: |
|
get_user_register_link [line 170]
string get_user_register_link(
[string $before = ''], [string $after = ''], [string $link_text = ''], [boolean $link_title = '#'], [string $disp_when_logged_in = false], [ $redirect = null]
)
|
|
Template tag: Get a link to new user registration
Parameters:
|
string |
$before: |
|
|
string |
$after: |
|
|
string |
$link_text: |
|
|
boolean |
$link_title: |
Display the link, if the user is already logged in? (this is used by the login form) |
|
string |
$disp_when_logged_in: |
Where to redirect |
|
|
$redirect: |
|
profile_check_params [line 451]
void profile_check_params(
array $params, [User|NULL $User = NULL]
)
|
|
Check profile parameters and add errors through param_error().
Parameters:
|
array |
$params: |
associative array. Either array( $value, $input_name ) or just $value; ($input_name gets used for associating it to a form fieldname) - 'login': check for non-empty
- 'nickname': check for non-empty
- 'icq': must be a number
- 'email': mandatory, must be well formed
- 'url': must be well formed, in allowed scheme, not blacklisted
- 'pass1' / 'pass2': passwords (twice), must be the same and not == login (if given)
- 'pass_required': false/true (default is true)
|
|
User|NULL |
$User: |
A user to use for additional checks (password != login/nick). |
user_admin_link [line 288]
void user_admin_link(
[string $before = ''], [string $after = ''], [string $link_text = ''], [string $link_title = '#'], [string $not_visible = '']
)
|
|
Template tag: Output a link to the backoffice.
Usually provided in skins in order for newbies to find the admin interface more easily...
Parameters:
|
string |
$before: |
To be displayed before the link. |
|
string |
$after: |
To be displayed after the link. |
|
string |
$link_text: |
The page/controller to link to inside of $admin_url |
|
string |
$link_title: |
Text for the link. |
|
string |
$not_visible: |
Title for the link. |
user_login_link [line 101]
void user_login_link(
[ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#']
)
|
|
Template tag: Output link to login
Parameters:
|
|
$before: |
|
|
|
$after: |
|
|
|
$link_text: |
|
|
|
$link_title: |
|
user_logout_link [line 220]
void user_logout_link(
[ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#'], [ $params = array()]
)
|
|
Template tag: Output a link to logout
Parameters:
|
|
$before: |
|
|
|
$after: |
|
|
|
$link_text: |
|
|
|
$link_title: |
|
|
|
$params: |
|
boolean user_pass_ok(
string $login, string $pass, [boolean $pass_is_md5 = false]
)
|
|
Check if a password is ok for a login.
Parameters:
|
string |
$login: |
login |
|
string |
$pass: |
password |
|
boolean |
$pass_is_md5: |
Is the password parameter already MD5()'ed? |
user_preferredname [line 425]
void user_preferredname(
integer $user_ID
)
|
|
Template tag: Display the user's preferred name
Used in result lists.
Parameters:
|
integer |
$user_ID: |
user ID |
user_profile_link [line 340]
void user_profile_link(
[ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#']
)
|
|
Template tag: Display a link to user profile
Parameters:
|
|
$before: |
|
|
|
$after: |
|
|
|
$link_text: |
|
|
|
$link_title: |
|
user_register_link [line 155]
void user_register_link(
[string $before = ''], [string $after = ''], [string $link_text = ''], [boolean $link_title = '#'], [ $disp_when_logged_in = false]
)
|
|
Template tag: Output a link to new user registration
Parameters:
|
string |
$before: |
|
|
string |
$after: |
|
|
string |
$link_text: |
|
|
boolean |
$link_title: |
Display the link, if the user is already logged in? (this is used by the login form) |
|
|
$disp_when_logged_in: |
|
user_subs_link [line 392]
void user_subs_link(
[ $before = ''], [ $after = ''], [ $link_text = ''], [ $link_title = '#']
)
|
|
Template tag: Provide a link to subscription screen
Parameters:
|
|
$before: |
|
|
|
$after: |
|
|
|
$link_text: |
|
|
|
$link_title: |
|