BP Friends Hooks Documentation

[tw2113]

This ticket will be where all BP Friends patches go for the Hooks Documentation.

Relevant files:
bp-friends-actions.php
bp-friends-activity.php
bp-friends-cache.php
bp-friends-classes.php
bp-friends-filters.php
bp-friends-functions.php
bp-friends-loader.php
bp-friends-notifications.php
bp-friends-screens.php
bp-friends-template.php
bp-friends-widgets.php

[DJPaul]

Moving into Future Release; we can keep these here and move them into particular releases' milestones as we commit things (or work on them).

[tw2113]

What I have so far for the Friends component.

bp-friends-classes, bp-friends-notifications, bp-friends-functions, and bp-friends-template remain.

[boonebgorges]

In 9154:

Hook documentation for part of the Friends component.

Includes bp-friends-activity, bp-friends-widgets, and bp-friends-screens.

Props tw2113.
See #5942.

[tw2113]

Finished up the notifications file after the friends component diff for #5970 landed.

[tw2113]

While I was at it, got the template file finished up.

Remaining files are bp-friends-classes and bp-friends-functions

[tw2113]

bp-friends-functions.php is going to need a unit test set up because one of the filters was done via variables, and I'm moving it to one variable filter.

Stay tuned.

[tw2113]

Do not commit bp-friends-functions-5942.diff until the accompanying unit tests are ready for commit as well.

[tw2113]

Hopefully these two tests suffice :)

[boonebgorges]

In 9173:

Generate friend initiation hook dynamically.

This makes it easier to document per WP standards.

Props tw2113.
See #5942.

[boonebgorges]

In 9174:

Add hook documentation in bp-friends-functions.php.

Props tw2113.
See #5942.

[boonebgorges]

tw2113 - A couple comments on [9174]:

• do_action_ref_array() technically gets an array as a parameter, but it should not be documented as such, because when using add_action() it will receive separate params like a normal do_action() hook would pass.
• I've switched to the proper hash notation for array params. See eg 'friends_get_newest'.

[boonebgorges]

In 9175:

Add hook documentation in bp-friends-notifications.php.

Props tw2113.
See #5942.

[boonebgorges]

In 9176:

Add hook documentation in bp-friends-template.php.

Props tw2113.
See #5942.

[tw2113]

bp-friends-classes.php ended up being a lot quicker than I thought :)

Unless I missed something, this ticket should be good for BuddyPress 2.2.

[boonebgorges]

In 9206:

Add hook documentation to bp-friends-classes.php.

Props tw2113.
Fixes #5942.