Activity::list_( $args,  $assoc_args )

Retrieve a list of activities.


Description Description

Top ↑

OPTIONS OPTIONS

[–=] : One or more parameters to pass to \BP_Activity_Activity::get()

[–user-id=] : Limit activities to a specific user id. Accepts a numeric ID.

[–component=] : Limit activities to a specific or certain components.

[–type=] : Type of the activity. Ex.: activity_update, profile_updated.

[–primary-id=] : Object ID to filter the activities. Ex.: group_id or forum_id or blog_id, etc.

[–secondary-id=] : Secondary object ID to filter the activities. Ex.: a post_id.

Top ↑

[–count=] : How many activities to list. [–count=] : How many activities to list.

Top ↑

default: 50 default: 50

Top ↑

[–format=] : Render output in a particular format. [–format=] : Render output in a particular format.

default: table options:

Top ↑

AVAILABLE FIELDS AVAILABLE FIELDS

These fields will be displayed by default for each activity:

  • ID
  • user_id
  • component
  • type
  • action
  • content
  • item_id
  • secondary_item_id
  • primary_link
  • date_recorded
  • is_spam
  • user_email
  • user_nicename
  • user_login
  • display_name
  • user_fullname

Top ↑

EXAMPLES EXAMPLES

$ wp bp activity list --format=ids
$ wp bp activity list --format=count
$ wp bp activity list --per_page=5
$ wp bp activity list --search_terms="Activity Comment"
$ wp bp activity list --user-id=10
$ wp bp activity list --user-id=123 --component=groups

Source Source

File: cli/src/activity.php


			

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.