Favorites Documentation

Favorites:Rank_Authors template tag

The Favorites:Rank_Authors tag shows a list of top authors ranked by the number of times their entries have been saved to other member's favorites.

{exp:favorites:rank_authors} content {/exp:favorites:rank_authors}

Parameters

The following parameters are available for use:

collection=

collection="articles"

This parameter allows you to filter your results based on favorites that occurred for a specific collection name. Specify multiples with the pipe character.

collection=

collection_id="1"

This parameter allows you to filter your results based on favorites that occurred for a specific collection ID. Specify multiples with the pipe character.

favorites_start_on=

favorites_start_on="2012-09-05 12:00 PM"

You can specify a particular date/time on which to start the entries. Only entries that were saved to Favorites on or after this date will be included in the results. This parameter can be used in conjunction with the favorites_stop_before parameter for limiting the results to a specific date range.

favorites_stop_before=

favorites_stop_before="2012-09-12 12:00 PM"

You can specify a particular date/time on which to end the entries. Only entries that were saved to Favorites before this date will be included in the results (entries exactly on this date/time will not be included). This parameter can be used in conjunction with the favorites_start_on parameter for limiting the results to a specific date range.

limit

limit="5"

This parameter lets you limit the number of authors displayed on the list.

member_id

member_id="not 5|7|20"

This parameter allows you to filter the authors results by specifying member ID(s). Using not will show all authors except those specified. Separate multiples with the pipe (|) character.

username

username="pieman|mitchell"

This parameter allows you to filter the authors results by specifying username(s). Using not will show all authors except those specified. Separate multiples with the pipe (|) character.

orderby=

orderby="total_favorites"

This parameter sets the display order of the results. You can use any of the options available with Channel:Entries, or additionally you can use total_favorites (rank by most favorited).

paginate=

paginate="both"

This parameter allows you to control where the pagination will display. Options are top, bottom, or both. Used in conjunction with the favorites:paginate variable pair.

sort=

sort="asc"

This parameter sets the sort order to be ascending (asc) or descending (desc). Default order is desc.

Variables

Most standard and custom member fields are available for use as variables here. Additionally, these exist as well:

favorites:absolute_count

{favorites:absolute_count}

This variable outputs the display order number for each result in the list of members (across all pages, if using pagination).

favorites:absolute_results

{favorites:absolute_results}

This variable will return the absolute total amount of member results. This includes all members across all pages when pagination is used.

favorites:count

{favorites:count}

This variable outputs the display order number for each result in the list of members (within the page, if using pagination).

favorites:total_results

{favorites:total_results}

This variable outputs the total amount of members in the results (within the page, if using pagination). You would typically use this in a conditional statement.

favorites:total_favorites

{favorites:total_favorites}

This variable displays the number of times a member's entries have been favorited.

Variable Pairs

The following variable pairs are available for use:

favorites:paginate

{favorites:paginate}
    Page {favorites:current_page} of {favorites:total_pages} pages
    {favorites:pagination_links}
{/favorites:paginate}

OR

{favorites:paginate}
    <ul class="pagination">
    {favorites:pagination_links}
        {first_page}
            <li><a href="{pagination_url}">First</a></li>
        {/first_page}
        {previous_page}
            <li><a href="{pagination_url}">&laquo; Previous</a></li>
        {/previous_page}
        {page}
            <li{if current_page} class="active"{/if}><a href="{pagination_url}">{pagination_page_number}</a></li>
        {/page}
        {next_page}
            <li><a href="{pagination_url}">Next &raquo;</a></li>
        {/next_page}
        {last_page}
            <li><a href="{pagination_url}">Last</a></li>
        {/last_page}
    {/favorites:pagination_links}
    </ul>
{/favorites:paginate}

Pagination is available for this tag and works just like regular EE pagination, but each variable/variable pair is prepended with favorites: (except for any variables and variable pairs inside of the favorites:pagination_links variable pair). Used in conjunction with the paginate parameter.

Conditionals

Most of the standard and custom Member variables are available as conditionals. Additionally, these exist as well:

favorites:no_results

{if favorites:no_results}
    Sorry, there are no results.
{/if}

This conditional is shows its contents when there are no results, under the given parameters.

Examples

Below is a simple example of how you would display a Top Authors list, along with their rank and the number of times other members have saved their entries to favorites:

<ul>
{exp:favorites:rank_authors
    orderby="total_favorites" sort="desc"
    limit="10" paginate="bottom"
}
    <li>
        [{favorites:absolute_count}]
        <a href="{path='user/profile'}/{member_id}">{screen_name}</a>
        (saved to favorites {favorites:total_favorites} times)
    </li>
{if favorites:no_results}
    <li>Sorry, no authors were found.</li>
{/if}
{favorites:paginate}
    <li>
        <ul class="pagination">
        {favorites:pagination_links}
        {first_page}
            <li><a href="{pagination_url}">First</a></li>
        {/first_page}
        {previous_page}
            <li><a href="{pagination_url}">&laquo; Previous</a></li>
        {/previous_page}
        {page}
            <li{if current_page} class="active"{/if}><a href="{pagination_url}">{pagination_page_number}</a></li>
        {/page}
        {next_page}
            <li><a href="{pagination_url}">Next &raquo;</a></li>
        {/next_page}
        {last_page}
            <li><a href="{pagination_url}">Last</a></li>
        {/last_page}
        {/favorites:pagination_links}
        </ul>
    </li>
{/favorites:paginate}
{/exp:favorites:rank_authors}
</ul>

Support

Having problems setting up and/or using Favorites? Support is offered from 10am to 4pm EST weekdays. Send us an email at help@eeharbor.com and we will respond as quickly as we can.