Pass $activity_obj in bp_activity_get_permalink()

[r-a-y]

It would be useful to pass the $activity_obj in the "bp_activity_get_permalink" filter so plugin authors can do checks against the activity item to modify the permalink.

Attached patch is against trunk.

[boonebgorges]

(In [4553]) Pass activity object to bp_activity_get_permalink filter. Fixes #3296. Props r-a-y

[boonebgorges]

New rule: No one gets new hooks and filters unless they also write PHPDoc for the function in question :)

[DJPaul]

Does this break backpat with existing filters?

[boonebgorges]

No. apply_filters_ref_array() differs from apply_filters only in the way that filter arguments are passed. So

apply_filters_ref_array( 'bp_activity_get_permalink', array( $activity_id, &$activity_obj ) );

is the same as

apply_filters( 'bp_activity_get_permalink', $activity_id, &$activity_obj );

Just tested with some filters on my local install and it's working as expected.

[r-a-y]

Re: PHPDoc - I'll keep that in mind for future patches ;)