Activity Shorcode [youzify_activity]

Accepted Parameters

The Activity stram shortcode function will accept a number of parameters that will manipulate the data being returned.

• show_filter optional

Whether or not to display the activity filter bar area.

• Accepted arguments: true, false
• Default value: true

• show_sidebar optional

Whether or not to display the activity sidebar.

• Accepted arguments: true, false
• Default value: false

• show_form optional

Whether or not to display the activity posting form.

• Accepted arguments: true, false
• Default value: true

• form_roles optional

Display the activity posting form to the entered roles. separate roles by comma with no empty spaces.

• Accepted arguments: any site roles like : administrator, editor, subscriber ...
• Default value: empty

• load_more optional

Whether or not to display activity load more button.

• Accepted arguments: true, false
• Default value: true

• scope optional

  Pre-defined filtering of the activity stream. Show only activity for the scope you pass (based on the logged in user or a user_id you pass).

  • Accepted arguments: just-me, friends, groups, favorites, mentions, following<br>
  • Default value: Empty

• display_comments optional

  Whether or not to display comments along with activity items. Threaded will show comments threaded under the activity. Stream will show comments within the actual stream in chronological order along with activity items.

  • Accepted arguments: false, threaded, stream
  • Default value: threaded

• include optional

  Pass an activity_id or string of comma separated ids to show only these entries.

  • Default value: false

• sort optional

  Sort the stream chronologically ascending or descending.

  • Accepted arguments: ASC, DESC
  • Default value: DESC

• per_page optional

  Number of activity items to show per page.

  • Default value: 20

• page optional

  Which page to return based on the number per page value.

  • Default value: 1

• max optional

  The limit on number of activity items that can be returned

  • Default value: false

• show_hidden optional

  Show items that have been hidden site wide? For example private or hidden group posts.

  • Default value: false

• search_terms optional

  Return only activity items that match these search terms

  • Default value: false

Filtering Options

Using filtering you can use the activity loop to return any specific information that has been recorded on the entire site. For example you could use it to return all of the latest comments site wide.

Listed below are the parameters you can use to filter the activity stream.

• user_id optional

  Limit activity items to a specific user ID. You can also pass in a comma separated string of user ids – see example below.

  • Default value: false (no filter)

• object optional

  The object type to filter on (can be any active component ID as well as custom component ID’s)

  • Example arguments: groups, friends, profile, status, blogs
  • Default value: false (no filter)

• action optional

  The action type to filter on (can be any active component action as well as custom component actions)

  • Example arguments:new_blog_post, friendship_created, joined_group, created_group, new_forum_topic, activity_update, bbp_topic_create , bbp_reply_create 
  • Default value: false (no filter)

• primary_id optional

  The ID to filter on for a specific object. For example if you used groups as the object you could pass a group_idas the primary_id and restrict to that group.

  • Possible arguments: Any specific object ID
  • Default value: false (no filter)

• secondary_id optional

  The secondary ID to filter on for a specific object. For example if you used blogs as the object you could pass a blog_id as the primary_id and a post_id as the secondary_id the list all comments for that post using new_blog_comment as the action.

  • Possible arguments: Any specific object ID
  • Default value: false (no filter)