mirror of
https://gh.wpcy.net/https://github.com/buddypress/buddypress.git
synced 2026-05-31 05:04:29 +08:00
e786d4cd3e
git-svn-id: https://buddypress.svn.wordpress.org/branches/1.9@7733 cdf35c40-ae34-48e0-9cc9-0c9da1808c22
268 lines
8 KiB
PHP
268 lines
8 KiB
PHP
<?php
|
|
|
|
/**
|
|
* BuddyPress Member Notifications
|
|
*
|
|
* Backwards compatibility functions and filters used for member notifications.
|
|
* Use bp-notifications instead.
|
|
*
|
|
* @package BuddyPress
|
|
* @subpackage MembersNotifications
|
|
*/
|
|
|
|
// Exit if accessed directly
|
|
if ( !defined( 'ABSPATH' ) ) exit;
|
|
|
|
/**
|
|
* Add a notification for a specific user, from a specific component
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_add_notification() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @param string $item_id
|
|
* @param int $user_id
|
|
* @param string $component_name
|
|
* @param string $component_action
|
|
* @param string $secondary_item_id
|
|
* @param string $date_notified
|
|
* @param int $is_new
|
|
* @return boolean True on success, false on fail
|
|
*/
|
|
function bp_core_add_notification( $item_id, $user_id, $component_name, $component_action, $secondary_item_id = 0, $date_notified = false, $is_new = 1 ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_add_notification()' );
|
|
|
|
// Notifications must always have a time
|
|
if ( false === $date_notified ) {
|
|
$date_notified = bp_core_current_time();
|
|
}
|
|
|
|
// Add the notification
|
|
return bp_notifications_add_notification( array(
|
|
'item_id' => $item_id,
|
|
'user_id' => $user_id,
|
|
'component_name' => $component_name,
|
|
'component_action' => $component_action,
|
|
'secondary_item_id' => $secondary_item_id,
|
|
'date_notified' => $date_notified,
|
|
'is_new' => $is_new
|
|
) );
|
|
}
|
|
|
|
/**
|
|
* Delete a specific notification by its ID
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_delete_notification() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @param int $id
|
|
* @return boolean True on success, false on fail
|
|
*/
|
|
function bp_core_delete_notification( $id ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notification()' );
|
|
|
|
return BP_Notifications_Notification::delete_by_id( $id );
|
|
}
|
|
|
|
/**
|
|
* Get a specific notification by its ID
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_get_notification() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @param int $id
|
|
* @return BP_Core_Notification
|
|
*/
|
|
function bp_core_get_notification( $id ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_get_notification()' );
|
|
|
|
return bp_notifications_get_notification( $id );
|
|
}
|
|
|
|
/**
|
|
* Get notifications for a specific user
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_get_notifications_for_user() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @global BuddyPress $bp
|
|
* @param int $user_id
|
|
* @param string $format
|
|
* @return boolean Object or array on success, false on fail
|
|
*/
|
|
function bp_core_get_notifications_for_user( $user_id, $format = 'string' ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_get_notifications_for_user()' );
|
|
|
|
$renderable = bp_notifications_get_notifications_for_user( $user_id, $format );
|
|
|
|
return apply_filters( 'bp_core_get_notifications_for_user', $renderable, $user_id, $format );
|
|
}
|
|
|
|
/** Delete ********************************************************************/
|
|
|
|
/**
|
|
* Delete notifications for a user by type
|
|
*
|
|
* Used when clearing out notifications for a specific component when the user
|
|
* has visited that component.
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_delete_notifications_by_type() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @param int $user_id
|
|
* @param string $component_name
|
|
* @param string $component_action
|
|
* @return boolean True on success, false on fail
|
|
*/
|
|
function bp_core_delete_notifications_by_type( $user_id, $component_name, $component_action ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_by_type()' );
|
|
|
|
return bp_notifications_delete_notifications_by_type( $user_id, $component_name, $component_action );
|
|
}
|
|
|
|
/**
|
|
* Delete notifications for an item ID
|
|
*
|
|
* Used when clearing out notifications for a specific component when the user
|
|
* has visited that component.
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_delete_notifications_by_item_id() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @param int $user_id
|
|
* @param string $component_name
|
|
* @param string $component_action
|
|
* @return boolean True on success, false on fail
|
|
*/
|
|
function bp_core_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_by_item_id()' );
|
|
|
|
return bp_notifications_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id );
|
|
}
|
|
|
|
/**
|
|
* Delete all notifications for by type
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_delete_all_notifications_by_type() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @param int $user_id
|
|
* @param string $component_name
|
|
* @param string $component_action
|
|
* @return boolean True on success, false on fail
|
|
*/
|
|
function bp_core_delete_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_all_notifications_by_type()' );
|
|
|
|
bp_notifications_delete_all_notifications_by_type( $item_id, $component_name, $component_action, $secondary_item_id );
|
|
}
|
|
|
|
/**
|
|
* Delete all notifications for a user
|
|
*
|
|
* Used when clearing out all notifications for a user, whene deleted or spammed
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_delete_notifications_from_user() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @param int $user_id
|
|
* @param string $component_name
|
|
* @param string $component_action
|
|
* @return boolean True on success, false on fail
|
|
*/
|
|
function bp_core_delete_notifications_from_user( $user_id, $component_name, $component_action ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_from_user()' );
|
|
|
|
return bp_notifications_delete_notifications_from_user( $user_id, $component_name, $component_action );
|
|
}
|
|
|
|
/** Helpers *******************************************************************/
|
|
|
|
/**
|
|
* Check if a user has access to a specific notification
|
|
*
|
|
* Used before deleting a notification for a user
|
|
*
|
|
* @deprecated Deprecated since BuddyPress 1.9.0. Use
|
|
* bp_notifications_check_notification_access() instead.
|
|
*
|
|
* @since BuddyPress (1.0)
|
|
* @param int $user_id
|
|
* @param int $notification_id
|
|
* @return boolean True on success, false on fail
|
|
*/
|
|
function bp_core_check_notification_access( $user_id, $notification_id ) {
|
|
|
|
// Bail if notifications is not active
|
|
if ( ! bp_is_active( 'notifications' ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Trigger the deprecated function notice
|
|
_deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_check_notification_access()' );
|
|
|
|
return bp_notifications_check_notification_access( $user_id, $notification_id );
|
|
}
|
