Skip to:
Content

BuddyPress.org

Opened 5 years ago

Closed 5 years ago

Last modified 3 years ago

#5942 closed enhancement (fixed)

BP Friends Hooks Documentation

Reported by: tw2113 Owned by: boonebgorges
Milestone: 2.2 Priority: normal
Severity: normal Version:
Component: Core Keywords:
Cc:

Description

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

Attachments (8)

bp-friends-activity-5942.diff (1.6 KB) - added by tw2113 5 years ago.
bp-friends-widgets-5942.diff (524 bytes) - added by tw2113 5 years ago.
bp-friends-screens-5942.diff (1.8 KB) - added by tw2113 5 years ago.
bp-friends-notifications-5942.diff (6.9 KB) - added by tw2113 5 years ago.
bp-friends-template-5942.diff (6.0 KB) - added by tw2113 5 years ago.
bp-friends-functions-5942.diff (9.1 KB) - added by tw2113 5 years ago.
bp-friends-functions-tests-5942.diff (1.9 KB) - added by tw2113 5 years ago.
bp-friends-classes-5942.diff (1.1 KB) - added by tw2113 5 years ago.

Download all attachments as: .zip

Change History (26)

#1 @DJPaul
5 years ago

  • Milestone changed from Awaiting Review to Future Release
  • Type changed from enhancement to task

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

#2 @tw2113
5 years ago

What I have so far for the Friends component.

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

#3 @boonebgorges
5 years ago

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.

#4 @tw2113
5 years ago

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

#5 @tw2113
5 years ago

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

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

This ticket was mentioned in Slack in #buddypress by mamaduka. View the logs.


5 years ago

#7 @tw2113
5 years ago

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.

#8 @tw2113
5 years ago

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

#9 @tw2113
5 years ago

Hopefully these two tests suffice :)

#10 @boonebgorges
5 years ago

In 9173:

Generate friend initiation hook dynamically.

This makes it easier to document per WP standards.

Props tw2113.
See #5942.

#11 @boonebgorges
5 years ago

In 9174:

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

Props tw2113.
See #5942.

#12 @boonebgorges
5 years ago

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'.

#13 @boonebgorges
5 years ago

In 9175:

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

Props tw2113.
See #5942.

#14 @boonebgorges
5 years ago

In 9176:

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

Props tw2113.
See #5942.

#15 @tw2113
5 years ago

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.

#16 @boonebgorges
5 years ago

  • Owner set to boonebgorges
  • Resolution set to fixed
  • Status changed from new to closed

In 9206:

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

Props tw2113.
Fixes #5942.

#17 @boonebgorges
5 years ago

  • Milestone changed from Future Release to 2.2

#18 @DJPaul
3 years ago

  • Type changed from task to enhancement
Note: See TracTickets for help on using tickets.