BP Groups Hooks Documentation

[tw2113]

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

Relevant files:
bp-groups-actions.php
bp-groups-activity.php
bp-groups-admin.php
bp-groups-adminbar.php
bp-groups-cache.php
bp-groups-classes.php
bp-groups-filters.php
bp-groups-forums.php
bp-groups-functions.php
bp-groups-loader.php
bp-groups-notifications.php
bp-groups-screens.php
bp-groups-template.php
bp-groups-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]

Not sure how we want to handle the following:

add_meta_box(
	$screen['slug'],
	$screen['name'],
	create_function( '', 'do_action( "bp_groups_admin_meta_box_content_' . $this->slug . '", ' . $group_id . ' );' ),
	get_current_screen()->id,
	$screen['metabox_context'],
	$screen['metabox_priority']
);

[tw2113]

In 9450:

Adds hooks documentation to bp-groups-activity.

See #5943.

[tw2113]

In 9451:

Adds hooks documentation to bp-groups-actions.php.

See #5943.

[tw2113]

In 9452:

Adds and fixes hooks documentation for bp-groups-filters.php.

See #5943.

[tw2113]

In 9453:

Adds hooks documentation to bp-groups-widgets.php.

See #5943.

[tw2113]

In 9454:

Adds hooks documentation to bp-groups-loader.php.

See #5943.

[tw2113]

We have a small case of duplicate hook names with no direct way to differentiate between the two. The hook is "loop_end" in bp-groups-template.php and is used for both the Members and the Invites methods.

Thoughts on how to handle this? Pass in a string indicating which is being associated at that moment? Graceful renaming of one or both of them?

[tw2113]

While we're in this file, we have the same situation with loop_start for both Members and Invites.

[boonebgorges]

Replying to tw2113:

We have a small case of duplicate action hook names with no direct way to differentiate between the two. The hook is "loop_end" in bp-groups-template.php and is used for both the Members and the Invites methods.

Thoughts on how to handle this? Pass in a string indicating which is being associated at that moment? Graceful renaming of one or both of them?

We can't rename them. It would be fine to pass an additional parameter - $this would make the most sense, as the loop type can be inferred from the template object. Let's do this as part of a separate ticket, please, as it's not directly related to documentation.

[tw2113]

In 9487:

Adds hooks documentation to bp-groups-admin.php.

See #5943

[tw2113]

In 9488:

Adds hooks documentation for bp-groups-forums.php.

See #5943.

[tw2113]

In 9489:

Adds hooks documentation to bp-groups-notifications.php.

See #5943.

[tw2113]

In 9490:

Adds hooks documentation for bp-groups-functions.php.

See #5943.

[tw2113]

In 9491:

Adds hooks documentation to class-bp-groups-member.php.

See #5943.

[tw2113]

In 9492:

Adds hooks documentation to class-bp-groups-member-suggestions.php.

See #5943.

[tw2113]

In 9493:

Adds hooks documentation to class-bp-groups-group.php.

See #5943.

[tw2113]

In 9494:

Adds hoks documentation to class-bp-group-member-query.php.

See #5943.

[tw2113]

In 9495:

Adds hooks documentation to class-bp-grou-extension.php.

See #5943

[tw2113]

In 9496:

Fix typo in @param for phpdoc.

See #5943.

[tw2113]

In 9511:

Adds hooks documentation for bp-groups-screens.php.

See #5943.

[tw2113]

In 9512:

Adds hooks documentation to bp-groups-template.php.

See #5943.

[tw2113]

In 9541:

Updates filter docs for changes made in #9535.

See #5943.

[tw2113]

I think most of this was done for 2.2, but I'm going to mark it as 2.3 officially.

Could someone mark it as fixed, please? :)

[tw2113]

In 9848:

Fixes documentation changes for some filters.

Props ecehren.

See #5940, #5941, #5943.

[tw2113]

In 10020:

Adds hooks documentation to new hooks for BuddyPress 2.4.0.

See #5943.