J4.x

J4.x:Users List and Details Views

From Joomla! Documentation

Revision as of 10:26, 1 April 2020 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎català • ‎français • ‎hrvatski
GSoC 2018
Users List and Details Views
Documentation
Gsoc2016.png
Joomla! 
4.x

Introduction

The Enhance Users Component project purpose was to improve the users component and to add two new useful views to the component. This article is going to describe the two new views that are:

  • A list view based on user groups
  • A detailed view of an user

Set the access level

The access level is used to know what information is shown to the current user and also to which type of access level the current user details view is available.

In order to set the access level for the current user, go to Users    Manage.

AccessLevel-en.png

Here you have the Access column that can be modified in two ways:

  1. By editing a single user and setting the value in the Access dropdown from Account Details tab
    Access level from user options
  2. Using batch processing. You have to select the users to which you want to apply the changes, click batch and then select the value from the Set Access Level dropdown
    Access level using batch processing

Note: The value of the Access column represents what the user that has that access level can see, e.g. Octav belongs to the registered users group but has public access, so he will be able to see only Anna and Sarah in the public users list and himself in the registered list.

Create menu item

In order to access the users list you have to create a menu item for it. Go to Menus    New Menu Item, click Select for the Menu Item Type, choose Users    User List.

User list menu item-en.png

Then select the users group which you want to display.

Select group-en.png

What will be displayed when you create a menu item with registered users group is:

  • For an user that is not logged in, the list will contain the users that are in the registered group and have access level public, if the users have access level registered or super user, they will not be displayed.
  • For an user that is logged in and has access level registered, the list will contain all users in the registered group that have access level registered or public, the ones with super user access will not be displayed.

There is also the possibility to create a menu item for a single user details view. The process is the same as for the list menu item, except that you have to choose an user instead of a group.

User details menu item-en.png

User List View

The information shown in the list view for each user is the name by default. Other information can be added using custom fields. The screenshot below contains the information shown in a menu item for a registered user group. The Description is a custom field.

Registered user list-en.png

User Details View

The information shown in the user details view includes by default the name, username and email of the user. The information shown is little is because there are a lot of different ways someone could want this view to look like, so we wanted it to be very customizable. In order to see additional information, you have to use custom fields and hook them to different events so that they are displayed in different parts of the page. The example below includes the Description custom field, but you can add a picture, phone number, address etc. (Note: If you are new to custom fields, see this tutorial on how to use them: Adding custom fields)

Details view-en.png

The user details view has the option to send an email to the user that can be activated via option in the user options or global options, Form tab.

Activate contact form-en.png

Once the Contact Form option is set to Show, the contact form is displayed in the user details view:

User details view with contact form-en.png