Skip to content

Commit

Permalink
Member tags, adding more tags updating nav
Browse files Browse the repository at this point in the history
  • Loading branch information
robinsowell committed Oct 14, 2020
1 parent f667686 commit 0560a14
Show file tree
Hide file tree
Showing 12 changed files with 625 additions and 389 deletions.
31 changes: 26 additions & 5 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,29 @@
href: fieldtypes/url.md

- name: Member Management
href: member/index.md

items:
- name: Overview
href: member/index.md
- name: Registration Tag
href: member/registration.md
- name: Login Tag
href: member/login.md
- name: Forgot Password
href: member/forgot-password.md
- name: Forgot Username
href: member/forgot-username.md
- name: Reset Password
href: member/reset-password.md
- name: Member List Tag
href: member/memberlist.md
- name: Member Search Form
href: member/search.md
- name: Custom Profile Data Tag
href: member/custom-profile-data.md
- name: Ignore List Tag
href: member/ignore-list.md
- name: Profile Templates (Legacy)
href: member/profile-templates.md

- name: Control Panel
items:
Expand Down Expand Up @@ -409,7 +430,7 @@
- name: The addon.setup.php File
href: development/addon-setup-php-file.md
- name: Add-on Installer
href: development/addon-installer.md
href: development/addon-installer.md
- name: Plugins
href: development/plugins.md
- name: Modules
Expand Down Expand Up @@ -548,7 +569,7 @@
- name: Fieldtypes
href: development/fieldtypes.md
- name: Jump Menu
href: development/jump-menu.md
href: development/jump-menu.md
- name: Architecture
href: development/architecture.md
- name: Services
Expand Down Expand Up @@ -787,7 +808,7 @@
- name: View Files and PHP Syntax
href: development/guidelines/view-php-syntax.md
- name: v3 Add-on Migration
href: development/v3-add-on-migration.md
href: development/v3-add-on-migration.md
- name: v4 Add-on Migration
href: development/v4-addon-migration.md
- name: v6 Add-on Migration
Expand Down
174 changes: 174 additions & 0 deletions docs/member/custom-profile-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<!--
This source file is part of the open source project
ExpressionEngine User Guide (https://github.com/ExpressionEngine/ExpressionEngine-User-Guide)
@link https://expressionengine.com/
@copyright Copyright (c) 2003-2020, Packet Tide, LLC (https://packettide.com)
@license https://expressionengine.com/license Licensed under Apache License, Version 2.0
-->

# Custom Profile Data Tag

[TOC]

## Overview

The Custom Profile Data Tag allows you to display member profile information in your Templates. The data can either be shown from the currently logged-in user or from a specified user using the member_id="" parameter.

NOTE: **Note:** Remember that the profile information for the current visitor, such as {screen_name}, {email}, etc. are always available in any template as [Global Variables](templates/globals/single-variables.md). Therefore, only use this tag if you need to show custom profile data (that is, Member Fields that you have created yourself) or information for a specific user.

{exp:member:custom_profile_data}
<p>{age}, {gender}</p>
{/exp:member:custom_profile_data}

NOTE: **Important:** If you omit the member_id= parameter as in the above example, do _not_ enable Template Caching on any Template containing this tag. Otherwise the data will not be dynamic and whoever happens to load the page when it is cached will have their information shown for everyone until the cache expires. Unlike this tag, [Global Variables](templates/globals/single-variables.md) _can_ be used in templates that are cached.


## Parameters

### `member_id=`

member_id="147"

Specifies a particular member's information to display. By default (if you do not include the member_id parameter), the tag will simply display information pertaining to the currently logged-in user.

## Variables

### `{avatar_height}`

The height of the avatar image associated with the user. Typically used as such:

{if avatar}
<img src="{avatar_url}" width="{avatar_width}" height="{avatar_height}" alt="{screen_name}'s avatar">
{/if}

### `{avatar_width}`

The width of the avatar image associated with the user. Typically used as such:

{if avatar}
<img src="{avatar_url}" width="{avatar_width}" height="{avatar_height}" alt="{screen_name}'s avatar">
{/if}

### `{avatar_url}`

The URL to the avatar image associated with the user. Typically used as such:

{if avatar}
<img src="{avatar_url}" width="{avatar_width}" height="{avatar_height}" alt="{screen_name}'s avatar">
{/if}

### `{email}`

The user's Javascript-encoded email address.

### `{group_id}`

The user's Group ID.

### `{join_date}`

{join_date format="%Y %m %d"}

The date the user joined the site.

### `{language}`

The user's language.

### `{last_activity}`

{last_activity format="%Y %m %d"}

The time of the user's last page load.

### `{last_comment_date}`

{last_comment_date format="%Y %m %d"}

The date of the user's last comment.

### `{last_entry_date}`

{last_entry_date format="%Y %m %d"}

The date of the user's last channel entry.

### `{last_forum_post_date}`

{last_forum_post_date format="%Y %m %d"}

The date of the user's last forum post.

### `{last_visit}`

{last_visit format="%Y %m %d"}

The date when the user was last active on the site PRIOR to their current session.

### `{local_time}`

{local_time format="%Y %m %d"}

The user's local time.

### `{member_group}`

The user's member group.

### `{member_id}`

The user's Member ID.

### `{screen_name}`

The user's screen name.

### `{search_path}`

The search path to show entries and posts by this user:

<a href="{search_path}">View Entries by User</a>

### `{send_private_message}`

The URL to send a Private Message to this user:

<a href="{send_private_message}">Send Private Message to {screen_name}.</a>

### `{signature}`

The user's signature.

### `{timezone}`

The user's timezone.

### `{total_comments}`

The total number of comments made by the user.

### `{total_entries}`

The total number of entries made by the user.

### `{total_forum_posts}`

The total number of forum posts made by the user.

### `{total_forum_topics}`

The total number of forum topics made by the user.

### `{username}`

The user's username.

## Other Member Fields

All other member fields that you created can be accessed using the Short Name of the field:

{age}
{gender}
{zodiac}
etc..
6 changes: 3 additions & 3 deletions docs/member/forgot-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ The name (short name) of the channel. This is a **required** parameter.
### `return=`

return="member/forgot-password/sent"
# Form Inputs


## Form Inputs

### Email

Expand Down
4 changes: 2 additions & 2 deletions docs/member/forgot-username.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Output a forgotten username form that sends an email with instructions for reset

email_template="member/email-forgot-username"

### `inline=`
### `inline_errors=`

inline_errors="yes"

Expand All @@ -45,7 +45,7 @@ Something something.
return="member/login/forgot-username"


# Form Inputs
## Form Inputs

### Email

Expand Down
49 changes: 49 additions & 0 deletions docs/member/ignore-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!--
This source file is part of the open source project
ExpressionEngine User Guide (https://github.com/ExpressionEngine/ExpressionEngine-User-Guide)
@link https://expressionengine.com/
@copyright Copyright (c) 2003-2020, Packet Tide, LLC (https://packettide.com)
@license https://expressionengine.com/license Licensed under Apache License, Version 2.0
-->

# Forgot Username Form Tag

[TOC]

## Overview

The Ignore List Tag allows you to display member profile information for members in a member's Ignore List. Fields can either be shown from the ignore list of currently logged-in user or from a specified user.

NOTE: **Important:** Avoid using Template Caching on any Template containing this tag. If you do not avoid caching, then data will not be dynamic for each user. Instead, whoever happens to load the page when it is cached will have their information shown for everyone until the cache expires. Unlike this tag, [Global Variables](templates/globals/single-variables.md) can be used in templates that are cached.

{exp:member:ignore_list}
<p>{ignore_screen_name}</p>
{/exp:member:ignore_list}

### Parameters

### `member_id=`

member_id="147"

You can specify a particular member's information to display. By default (if you do not include the member_id parameter), the tag will simply display information pertaining to the currently logged-in user.

### Variables

The following member variables are available. The unique prefix "ignore\_" ensures that the Ignore List variables do not conflict with Global Variables or member variables from other tags.

- {ignore_member_id}
- {ignore_group_id}
- {ignore_group_description}
- {ignore_username}
- {ignore_screen_name}
- {ignore_email}
- {ignore_ip_address}
- {ignore_location}
- {ignore_total_entries}
- {ignore_total_comments}
- {ignore_private_messages}
- {ignore_total_forum_topics}
- {ignore_total_forum_replies}
- {ignore_total_forum_posts}
Loading

0 comments on commit 0560a14

Please sign in to comment.