Retired Documentation: You are using the documentation for version 1.7.3 which was retired in 2013. Go here for the latest version documentation or check here for your available upgrades to the latest version.
Statistics Module Tags
ExpressionEngine includes a Statistics Module that tracks a number of system statistics. The basic statistics tag consists of a tag pair:
{exp:stats}
statistics content
{/exp:stats}
Parameters
site=
site="default_site"
This parameter can be used to restrict the statistics reporting to specific sites when using the Multiple Site Manager. You can use the pipe character to separate multiple sites:
site="default_site|boston|new_york"
Or you can add the word "not" (followed by a space) to exclude sites:
site="not chicago|los_angeles"
weblog=
weblog="default_site"
This parameter can be used to restrict the statistics reporting to specific weblogs. Note that not all of the statistics variables are affected by this parameter; those that are affected will be noted. Additionally, you can use the pipe character to separate multiple weblogs:
weblog="default_site|sports|news"
Or you can add the word "not" (followed by a space) to exclude weblogs:
weblog="not weblog5|weblog6"
Here is an example of the tag with the parameter in use:
{exp:stats weblog="news|sports"}
statistics content
{/exp:stats}
Variables
- {last_comment_date format="%m/%d/%Y %h:%i %a"}
- {last_entry_date format="%m/%d/%Y %h:%i %a"}
- {last_trackback_date format="%m/%d/%Y %h:%i %a"}
- {last_visitor_date format="%m/%d/%Y %h:%i %a"}
- {most_visitor_date format="%m/%d/%Y %h:%i %a"}
- {most_visitors}
- {total_anon}
- {total_comments}
- {total_entries}
- {total_guests}
- {total_logged_in}
- {total_members}
- {total_trackbacks}
dates
Several date variables are available for use. As with other date variables, these require the "format" parameter in order to define how the date should be displayed. See the date variable formatting page for more information.
last_comment_date
{last_comment_date format="%m/%d/%Y %h:%i %a"}
The date of the most recent comment. This variable can be affected by the weblog= parameter.
last_entry_date
{last_entry_date format="%m/%d/%Y %h:%i %a"}
The date of the most recent entry. This variable can be affected by the weblog= parameter.
last_trackback_date
{last_trackback_date format="%m/%d/%Y %h:%i %a"}
The date of the most recent trackback. This variable can be affected by the weblog= parameter.
last_visitor_date
{last_visitor_date format="%m/%d/%Y %h:%i %a"}
The date of most most recent visitor to the site
most_visitor_date
{most_visitor_date format="%m/%d/%Y %h:%i %a"}
The date on which the most visitors were ever viewing the site at the same time
most_visitors
{most_visitors}
The greatest number of visitors ever online at the same time. This includes members, guests/non-members, and anonymous users.
total_anon
{total_anon}
The total number of people currently online who have chosen to be "anonymous" and not have their name revealed
total_comments
{total_comments}
The combined total number of comments for all entries. This variable can be affected by the weblog= parameter.
total_entries
{total_entries}
The total number of entries in the database. This variable can be affected by the weblog= parameter.
total_guests
{total_guests}
The total number of people currently using the system that are not logged in as members
total_logged_in
{total_logged_in}
The total number of members that are currently logged in to the system
total_members
{total_members}
The total number of registered members
total_trackbacks
{total_trackbacks}
The combined total number of trackbacks for all entries. This variable can be affected by the weblog= parameter.
Member Names
The member_names variable pair allows you to show the currently logged in users:
{member_names}
<a href="{member_path='member/index'}">{name}</a><br />
{/member_names}
This will be replaced with a list like this:
Joe<br />
Fred<br />
Sallie<br />
The {member_path=''} variable allows you to create a link that points to the member's profile page. The example above illustrates how it can be used.
There is one optional parameter that goes in the opening {member_names} variable that allows "backspacing":
{member_names backspace="6"}
Backspacing removes characters from the last iteration of the loop. For example, if you put a <br /> tag between each member name you'll have this layout:
Joe<br />
Fred<br />
Sallie<br />
You might, however, not want the <br /> tag after the final item. By adding backspacing you can remove it. Simply count the number of characters and spaces in the item you want to remove and add it to the tag (do not include trailing spaces in your count). A <br /> tag has 6 characters, so you would do this:
{member_names backspace="6"}
<a href="{member_path='member/index'}">{name}</a><br />
{/member_names}
That will produce code like this:
Joe<br />
Fred<br />
Sallie
Conditional Variables
There is one conditional variable that allows you to show the list of logged-in members only if it actually contains members. This would be useful for times when there weren't any members currently logged in:
{if member_names}
content
{/if}
The conditional might be used with something like this:
{if member_names}
<p>Currently Online Members:
{member_names backspace="6"}
{name}
{/member_names}
</p>
{/if}