Skip to:
Content

BuddyPress.org

Opened 10 years ago

Closed 10 years ago

#7398 closed defect (bug) (fixed)

Incorrect inline docs for third parameter of activity comment posted actions

Reported by: jdgrimes Owned by: boonebgorges
Priority: normal Milestone: 2.8
Component: Activity Version:
Severity: normal Keywords: has-patch
Cc:

Description

The bp_activity_comment_posted and bp_activity_comment_posted_notification_skipped actions are fired in bp_activity_new_comment() with three parameters, the third one being $activity. The $activity var is a BP_Activity_Activity object, but it is documented as an int and said to be the "ID of the activity item being commented on".

I think these docs are just in error and should be updated to indicate that an activity object is passed, not an ID.

Attachments (1)

7398.diff​ (1.4 KB ) - added by jdgrimes 10 years ago.
Correct the docs

Download all attachments as: .zip

Change History (4)

@jdgrimes
10 years ago

Correct the docs

#1 @jdgrimes
10 years ago

  • Keywords has-patch added

In 7398.diff​ I've just corrected the docs. Somebody might want to double check that this is the correct course of action and the parameter values themselves haven't actually changed at some point.

#2 @boonebgorges
10 years ago

  • Milestone Awaiting Review → 2.8

Good catch. It appears that the docs have been incorrect since the filters were introduced. See [10543].

#3 @boonebgorges
10 years ago

  • Owner set to boonebgorges
  • Resolution → fixed
  • Status new → closed

In 11311:

Correct param docs for bp_activity_new_comment() actions.

Props jdgrimes.
Fixes #7398.

Note: See TracTickets for help on using tickets.