Changeset 9833 for trunk/src/bp-activity/bp-activity-notifications.php
- Timestamp:
- 05/03/2015 06:51:25 PM (10 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-activity/bp-activity-notifications.php
r9819 r9833 37 37 * @uses do_action() To call the 'bp_activity_sent_mention_email' hook 38 38 * 39 * @param int $activity_id The ID of the activity update.39 * @param int $activity_id The ID of the activity update. 40 40 * @param int $receiver_user_id The ID of the user who is receiving the update. 41 41 */ … … 114 114 * @since BuddyPress (1.2.0) 115 115 * 116 * @param string $subject Email notification subject text.116 * @param string $subject Email notification subject text. 117 117 * @param string $poster_name Name of the person who made the @mention. 118 118 */ … … 124 124 * @since BuddyPress (1.2.0) 125 125 * 126 * @param string $message Email notification message text.127 * @param string $poster_name Name of the person who made the @mention.128 * @param string $content Content of the @mention.129 * @param string $message_link URL permalink for the activity message.126 * @param string $message Email notification message text. 127 * @param string $poster_name Name of the person who made the @mention. 128 * @param string $content Content of the @mention. 129 * @param string $message_link URL permalink for the activity message. 130 130 * @param string $settings_link URL permalink for the user's notification settings area. 131 131 */ … … 140 140 * @since BuddyPress (1.5.0) 141 141 * 142 * @param BP_Activity_Activity $activity Activity Item object.143 * @param string $subject Email notification subject text.144 * @param string $message Email notification message text.145 * @param string $content Content of the @mention.142 * @param BP_Activity_Activity $activity Activity Item object. 143 * @param string $subject Email notification subject text. 144 * @param string $message Email notification message text. 145 * @param string $content Content of the @mention. 146 146 * @param int $receiver_user_id The ID of the user who is receiving the update. 147 147 */ … … 174 174 * @uses do_action() To call the 'bp_activity_sent_reply_to_reply_email' hook 175 175 * 176 * @param int $comment_id The comment id. 177 * @param int $commenter_id The ID of the user who posted the comment. 178 * @param array $params {@link bp_activity_new_comment()} 176 * @param int $comment_id The comment id. 177 * @param int $commenter_id The ID of the user who posted the comment. 178 * @param array $params {@link bp_activity_new_comment()} 179 * 180 * @return bool 179 181 */ 180 182 function bp_activity_new_comment_notification( $comment_id = 0, $commenter_id = 0, $params = array() ) { … … 230 232 * @since BuddyPress (1.2.0) 231 233 * 232 * @param string $subject Email notification subject text.234 * @param string $subject Email notification subject text. 233 235 * @param string $poster_name Name of the person who made the comment. 234 236 */ … … 240 242 * @since BuddyPress (1.2.0) 241 243 * 242 * @param string $message Email notification message text.243 * @param string $poster_name Name of the person who made the comment.244 * @param string $content Content of the comment.245 * @param string $thread_link URL permalink for the activity thread.244 * @param string $message Email notification message text. 245 * @param string $poster_name Name of the person who made the comment. 246 * @param string $content Content of the comment. 247 * @param string $thread_link URL permalink for the activity thread. 246 248 * @param string $settings_link URL permalink for the user's notification settings area. 247 249 */ … … 255 257 * @since BuddyPress (1.5.0) 256 258 * 257 * @param int $user_id ID of the original activity item author.258 * @param string $subject Email notification subject text.259 * @param string $message Email notification message text.260 * @param int $comment_id ID for the newly received comment.259 * @param int $user_id ID of the original activity item author. 260 * @param string $subject Email notification subject text. 261 * @param string $message Email notification message text. 262 * @param int $comment_id ID for the newly received comment. 261 263 * @param int $commenter_id ID of the user who made the comment. 262 * @param array $params Arguments used with the original activity comment.264 * @param array $params Arguments used with the original activity comment. 263 265 */ 264 266 do_action( 'bp_activity_sent_reply_to_update_email', $original_activity->user_id, $subject, $message, $comment_id, $commenter_id, $params ); … … 318 320 * @since BuddyPress (1.2.0) 319 321 * 320 * @param string $subject Email notification subject text.322 * @param string $subject Email notification subject text. 321 323 * @param string $poster_name Name of the person who made the comment reply. 322 324 */ … … 328 330 * @since BuddyPress (1.2.0) 329 331 * 330 * @param string $message Email notification message text.331 * @param string $poster_name Name of the person who made the comment reply.332 * @param string $content Content of the comment reply.332 * @param string $message Email notification message text. 333 * @param string $poster_name Name of the person who made the comment reply. 334 * @param string $content Content of the comment reply. 333 335 * @param string $settings_link URL permalink for the user's notification settings area. 334 * @param string $thread_link URL permalink for the activity thread.336 * @param string $thread_link URL permalink for the activity thread. 335 337 */ 336 338 $message = apply_filters( 'bp_activity_new_comment_notification_comment_author_message', $message, $poster_name, $content, $settings_link, $thread_link ); … … 343 345 * @since BuddyPress (1.5.0) 344 346 * 345 * @param int $user_id ID of the parent activity item author.346 * @param string $subject Email notification subject text.347 * @param string $message Email notification message text.348 * @param int $comment_id ID for the newly received comment.347 * @param int $user_id ID of the parent activity item author. 348 * @param string $subject Email notification subject text. 349 * @param string $message Email notification message text. 350 * @param int $comment_id ID for the newly received comment. 349 351 * @param int $commenter_id ID of the user who made the comment. 350 * @param array $params Arguments used with the original activity comment.352 * @param array $params Arguments used with the original activity comment. 351 353 */ 352 354 do_action( 'bp_activity_sent_reply_to_reply_email', $parent_comment->user_id, $subject, $message, $comment_id, $commenter_id, $params ); … … 358 360 * 359 361 * @since BuddyPress (1.9.0) 360 * @param int $comment_id 362 * 363 * @param int $comment_id 361 364 * @param array $params 362 365 */ … … 380 383 * @uses do_action() To call 'activity_format_notifications' hook. 381 384 * 382 * @param string $action The type of activity item. Just 'new_at_mention' for now. 383 * @param int $item_id The activity ID. 384 * @param int $secondary_item_id In the case of at-mentions, this is the mentioner's ID. 385 * @param int $total_items The total number of notifications to format. 386 * @param string $format 'string' to get a BuddyBar-compatible notification, 'array' otherwise. 385 * @param string $action The type of activity item. Just 'new_at_mention' for now. 386 * @param int $item_id The activity ID. 387 * @param int $secondary_item_id In the case of at-mentions, this is the mentioner's ID. 388 * @param int $total_items The total number of notifications to format. 389 * @param string $format 'string' to get a BuddyBar-compatible notification, 'array' otherwise. 390 * 387 391 * @return string $return Formatted @mention notification. 388 392 */ … … 418 422 * @since BuddyPress (1.5.0) 419 423 * 420 * @param string $string HTML anchor tag for the mention.424 * @param string $string HTML anchor tag for the mention. 421 425 * @param string $at_mention_link The permalink for the mention. 422 * @param int $total_items How many items being notified about.423 * @param int $activity_id ID of the activity item being formatted.424 * @param int $poster_user_id ID of the user posting the mention.426 * @param int $total_items How many items being notified about. 427 * @param int $activity_id ID of the activity item being formatted. 428 * @param int $poster_user_id ID of the user posting the mention. 425 429 */ 426 430 $return = apply_filters( 'bp_activity_' . $amount . '_at_mentions_notification', '<a href="' . esc_url( $at_mention_link ) . '" title="' . esc_attr( $at_mention_title ) . '">' . esc_html( $text ) . '</a>', $at_mention_link, (int) $total_items, $activity_id, $poster_user_id ); … … 436 440 * @since BuddyPress (1.5.0) 437 441 * 438 * @param array $array Array holding the content and permalink for the mention notification.442 * @param array $array Array holding the content and permalink for the mention notification. 439 443 * @param string $at_mention_link The permalink for the mention. 440 * @param int $total_items How many items being notified about.441 * @param int $activity_id ID of the activity item being formatted.442 * @param int $poster_user_id ID of the user posting the mention.444 * @param int $total_items How many items being notified about. 445 * @param int $activity_id ID of the activity item being formatted. 446 * @param int $poster_user_id ID of the user posting the mention. 443 447 */ 444 448 $return = apply_filters( 'bp_activity_' . $amount . '_at_mentions_notification', array( … … 453 457 * @since BuddyPress (1.2.0) 454 458 * 455 * @param string $action The type of activity item.456 * @param int $item_id The activity ID.459 * @param string $action The type of activity item. 460 * @param int $item_id The activity ID. 457 461 * @param int $secondary_item_id @mention mentioner ID. 458 * @param int $total_items Total amount of items to format.462 * @param int $total_items Total amount of items to format. 459 463 */ 460 464 do_action( 'activity_format_notifications', $action, $item_id, $secondary_item_id, $total_items ); … … 473 477 * @since BuddyPress (1.9.0) 474 478 * 475 * @param obj $activity479 * @param object $activity 476 480 * @param string $subject (not used) 477 481 * @param string $message (not used) 478 482 * @param string $content (not used) 479 * @param int $receiver_user_id483 * @param int $receiver_user_id 480 484 */ 481 485 function bp_activity_at_mention_add_notification( $activity, $subject, $message, $content, $receiver_user_id ) { … … 519 523 * 520 524 * @since BuddyPress (2.0.0) 525 * 526 * @param object BP_Activity_Activity 521 527 */ 522 528 function bp_activity_remove_screen_notifications_single_activity_permalink( $activity ) {
Note: See TracChangeset
for help on using the changeset viewer.