Options

Options

General Settings

Page Cache

If page cache is enabled, whether through a plugin or through your host, this should be checked. If page cacheing is not enabled, deselecting this option may improve performance.

Dependencies

Plugin CSS & Javascript may be disabled. Please note, the included Javascript is required for plugin functionality. If you are combining and minifying your scripts, you may copy and paste the provided scripts. Also note, the scripts use the following global variables for localization:

• favorites.favorite (Favorite Button Text)
• favorites.favorited (Favorited Button Text)

If you are combining and minifying your scripts, these global variables must be available.

User Settings

Anonymous Users

To display buttons for anonymous users, this option should be checked.

Include in the Post Count

If anonymous users are enabled, this option displays. To exclude anonymous users’ favorites from the total favorite count for posts, deselect the option.

Note: Anonymous user options are not backwards compatible. Favorite counts are stored as a simple integer, and are not saved on a per-user basis.

Require Login to Favorite

Displays if anonymous users are disabled. If this option is selected, favorite buttons will still be displayed for unauthenticated users. If the user attempts to favorite a post, a modal window displays with messaging which may be set here.

Save Unauthenticated User Favorites as

If favorites are enabled for anonymous users, an option displays allowing their favorites to be saved in either a browser cookie or session.

Display Options: Post Types

Post Types

Favorites may be enabled for all post types.

Insert Favorite button before content

Automatically inserts the favorite button before the content, using the_content filter.

Insert Favorite button after content

Automatically inserts the favorite button after the content, using the_content filter.

Show favorite count on post edit screen

Adds a meta box on the post edit/update screen with the total number of favorites the post has received.

Show favorite count in admin columns

Adds an admin column with the total number of favorites the post has received.

Favorite Button Content (Custom Markup)

Button Type

To display custom markup in the favorite button, select this option.

Color Options

Color options override theme css. Color option specifics are covered below.

Button Markup: Unfavorited

The HTML to display in the button in an unfavorited state.

Button Markup: Favorited

The HTML to display in the button in a favorited state.

Include Total Favorite Count

Check to include the total number of times the post has been favorited in the button text.

Button Color Options

Button Types

If custom markup is not your thing, your choice of predefined button types are available.

Color Options

To override theme styles and inject custom colors in buttons, select the “Specify custom colors” checkbox. A list of color options are available for the button in favorited and unfavorited states.

Loading Indication

Displays the button in a “loading” state during page load and during button submission (helpful for slower sites with cache enabled).

Loading Text/HTML

Replaces the button text during the loading state

Loading Spinner

The loading spinner may display as an image/GIF or as an HTML icon using CSS animations. Filters are available depending on the choice. If none are selected, a spinner will not display but the loading text will.

Page Load

Adds the loading state to the favorite buttons during page load (helpful on sites with page cacheing enabled).

Listing Display

List Wrapper Element

List Wrapper Type: Choose an HTML element type for the wrapping list. Defaults to a <ul> element.

List Wrapper CSS: Add custom CSS classes to the list wrapper element.

Single List Element

Listing Element Type: Choose an HTML element type for the individual listings. Defaults to a <li> element.

Listing CSS: Add custom CSS classes to the listing elements.

Single Listing Markup

To customize the markup in each favorite listing within the list, select this option. Dynamic fields may be added to the listing by selecting them from the dropdowns and selecting “Add.” To add custom meta fields to the output, use the format [[custom_field:custom_field_name]]. Array fields like ACF relationships are not supported. The markup is also available through a filter if more advanced options are required.

Additional Display Settings

Clear Favorites Button Text

The default text to appear in “Clear Favorites” buttons generated by either the shortcode or API function.

No Favorites Text

Text to display in generated lists when user has no favorites.