Friends 1.0 Mine

This function allows you to list the friends of a specified member.

Parameters

days =

days = "10"

The 'days' parameter allows you to limit the member list. If you're using the form in 'mine' mode, this will limit the members to those who were added to your friends list within the last number of days specified. If used in 'member' mode, the limit will be on the join date of the member.

form_name =

form_name = "this_form"

The 'form_name' parameter allows you to declare the name of the form in order to control it with Javascript.

form_id =

form_id = "this_form_id"

The 'form_id' parameter allows you to declare the id of the form in order to control it with Javascript.

friend_id =

friend_id = "4"

The 'friend_id' parameter allows you limit your member list to a friend with a specific member id. This allows you to run conditionals on one specific member to determine what kind of a friend they are.

group_id =

group_id = "6"

The 'group_id' parameter allows you to filter the list of members in the form by one or more group ids. Separate multiple groups with the pipe "|" character.

hours =

hours = "2"

The 'hours' parameter allows you to limit the member list. If you're using the form in 'mine' mode, this will limit the members to those who were added to your friends list within the last number of hours specified. If used in 'member' mode, the limit will be on the join date of the member.

limit =

limit = "10"

The 'limit' parameter allows you to limit the member list results.

member_id =

member_id = "34"

The 'member_id' parameter allows you to hard code the member id.

orderby =

orderby = "screen_name"

The 'orderby' parameter allows you to indicate by which fields to order your member list results. Separate multiple values by the pipe "|" character.

onsubmit =

onsubmit = "some_javascript()"

The 'onsubmit' parameter allows you to execute Javascript functions at form submission.

return =

return = "{path=template_group/template}"

The 'return' parameter allows you to control the landing page where users are taken once they submit your form.

screen_name =

screen_name = "some_user"

The 'screen_name' parameter allows you to filter the member list by those members who share the same first few letters of their screen name. Note that you can have 'screen_name' as a segment in a URL to indicate which letters to filter by. The next segment following the 'screen_name' segment should contain the letters.

sort =

sort = "desc"

The 'sort' parameter allows you to change the order of your member list. The default is 'asc' for ascending. Specify 'desc' for descending.

template =

template = "template_group/template"

The 'template' parameter allows you to specify what template to use among your site templates to use as the formatting template for messages from the Friends module. This is most commonly used when enabling AJAX websites.

username =

username = "some_user"

The 'username' parameter allows you to filter the member list by those members who share the same first few letters of their username. Note that you can have 'username' as a segment in a URL to indicate which letters to filter by. The next segment following the 'username' segment should contain the letters.

Variables

In addition to all of your custom member fields, the following member fields are available.

accept_messages

{accept_messages}

aol_im

{aol_im}

avatar_url

{avatar_url}

The avatar url is the full url to the directory on your server that contains member avatars.

bday_d

{bday_d}

bday_m

{bday_m}

bday_y

{bday_y}

bio

{bio}

daylight_savings

{daylight_savings}

email

{email}

group_id

{group_id}

icq

{icq}

interests

{interests}

ip_address

{ip_address}

join_date

{join_date}

language

{language}

last_activity

{last_activity}

last_bulletin_date

{last_bulletin_date}

last_comment_date

{last_comment_date}

last_email_date

{last_email_date}

last_entry_date

{last_entry_date}

last_forum_post_date

{last_forum_post_date}

last_rating_date

{last_rating_date}

last_view_bulletins

{last_view_bulletins}

last_visit

{last_visit}

location

{location}

member_id

{member_id}

msn_im

{msn_im}

occupation

{occupation}

photo_filename

{photo_filename}

photo_url

{photo_url}

The photo url is the full url to the directory on your server that contains member photos.

private_messages

{private_messages}

profile_views

{profile_views}

This variable shows the number of times that a member's profile has been viewed. Use of the user:stats function triggers the counting of a profile view. When you view your own profile it doesn't count.

public

{public}

The 'public' variable returns either 'y' or 'n' and tells you whether a given friend in your list has been marked as public or private.

reciprocal

{reciprocal}

The reciprocal variable returns either 'y' or 'n' and tells you whether a given friend in your list also has you as a friend in their list.

screen_name

{screen_name}

signature

{signature}

sig_img_filename

{sig_img_filename}

sig_img_url

{sig_img_url}

The sig img url is the full url to the directory on your server that contains member's signature images.

template_size

{template_size}

time_format

{time_format}

timezone

{timezone}

total_comments

{total_comments}

total_entries

{total_entries}

total_forum_posts

{total_forum_posts}

total_forum_topics

{total_forum_topics}

total_ratings

{total_ratings}

username

{username}

url

{url}

yahoo_im

{yahoo_im}

Conditionals

You can run conditionals on any of the variables above.