bbp_format_buddypress_notifications doesn't return $action when $action !== 'bbp_new_reply'

[Faison]

The function bbp_format_buddypress_notifications() is hooked into the filter bp_notifications_get_notifications_for_user. If $action === 'bbp_new_reply', the function will return a proper value. But if $action !== 'bbp_new_reply', it doesn't return anything.

This causes an issue if you have a custom notification action you're trying to format the notification description for:

• If you hook in before bbp_format_buddypress_notifications() runs, bbp_format_buddypress_notifications() will end up killing your value.
• If you hook in after bbp_format_buddypress_notifications(), $action will be null because bbp_format_buddypress_notifications() doesn't return anything.

The solution is just to add return $action at the end of the function. I'd include a patch, but I'm having trouble finding the proper documentation to do that.

You can view the function here: ​https://bbpress.trac.wordpress.org/browser/trunk/src/includes/extend/buddypress/notifications.php#L41

Thanks,
Faison

[netweb]

Thanks for the ticket, do want to create the patch? If so here are some bits to help get started :)

To get started and learn about how to create a patch that is in the format we use here (and the entire WordPress Trac ecosystem) here are a couple of docs to get you on your way:

• ​WordPress - Working With Patches
• ​Peter Westwood's Windows WordPress Toolbox
• ​Mark Jaquith's Unix WordPress Toolbox

The bbPress SVN repo is ​http://bbpress.svn.wordpress.org/trunk

[Faison]

Hi netweb,

Thanks for the links! I don't know why, but I just couldn't find that SVN repo url.

Anyways, I attached a patch that does exactly what I stated above: adds return $action; to the bottom of the function.

Thanks,
Faison

[johnjamesjacoby]

In 5512:

Slightly refactor bbp_format_buddypress_notifications():

• Return original $action if not bbp_new_reply.
• Reduce indentation to accommodate new $action check.

This fixes a bug where checking for new reply notifications could cause future notification filter checks to fail.

Props Faison. Fixes #2665.

[colabsadmin]

Why wait until 2.6 to add this fix? It took me over and hour to figure out why my custom notification wasn't displaying correctly.

[likebtn]

When bbPress 2.6 is going to be released?