File: //home/dfwparty/dfwchat.net/wp-content/plugins/buddyboss-platform/bp-forums/users/functions.php
<?php
/**
* Forums User Functions
*
* @package BuddyBoss\Functions
*/
// Exit if accessed directly
defined( 'ABSPATH' ) || exit;
/**
* Is an anonymous topic/reply being made?
*
* @since bbPress (r2688)
*
* @return bool True if anonymous is allowed and user is not logged in, false if
* anonymous is not allowed or user is logged in
* @uses bbp_allow_anonymous() Is anonymous posting allowed?
* @uses apply_filters() Calls 'bbp_is_anonymous' with the return value
* @uses is_user_logged_in() Is the user logged in?
*/
function bbp_is_anonymous() {
if ( ! is_user_logged_in() && bbp_allow_anonymous() ) {
$is_anonymous = true;
} else {
$is_anonymous = false;
}
return apply_filters( 'bbp_is_anonymous', $is_anonymous );
}
/**
* Echoes the values for current poster (uses WP comment cookies)
*
* @since bbPress (r2734)
*
* @param string $key Which value to echo?
*
* @uses bbp_get_current_anonymous_user_data() To get the current anonymous user
* data
*/
function bbp_current_anonymous_user_data( $key = '' ) {
echo bbp_get_current_anonymous_user_data( $key );
}
/**
* Get the cookies for current poster (uses WP comment cookies).
*
* @since bbPress (r2734)
*
* @param string $key Optional. Which value to get? If not given, then
* an array is returned.
*
* @return string|array Cookie(s) for current poster
* @uses wp_get_current_commenter() To get the current poster data *
* @uses sanitize_comment_cookies() To sanitize the current poster data
*/
function bbp_get_current_anonymous_user_data( $key = '' ) {
$cookie_names = array(
'name' => 'comment_author',
'email' => 'comment_author_email',
'url' => 'comment_author_url',
// Here just for the sake of them, use the above ones
'comment_author' => 'comment_author',
'comment_author_email' => 'comment_author_email',
'comment_author_url' => 'comment_author_url',
);
sanitize_comment_cookies();
$bbp_current_poster = wp_get_current_commenter();
if ( ! empty( $key ) && in_array( $key, array_keys( $cookie_names ) ) ) {
return $bbp_current_poster[ $cookie_names[ $key ] ];
}
return $bbp_current_poster;
}
/**
* Set the cookies for current poster (uses WP comment cookies)
*
* @since bbPress (r2734)
*
* @param array $anonymous_data With keys 'bbp_anonymous_name',
* 'bbp_anonymous_email', 'bbp_anonymous_website'.
* Should be sanitized (see
* {@link bbp_filter_anonymous_post_data()} for
* sanitization)
*
* @uses apply_filters() Calls 'comment_cookie_lifetime' for cookie lifetime.
* Defaults to 30000000.
*/
function bbp_set_current_anonymous_user_data( $anonymous_data = array() ) {
if ( empty( $anonymous_data ) || ! is_array( $anonymous_data ) ) {
return;
}
$comment_cookie_lifetime = apply_filters( 'comment_cookie_lifetime', 30000000 );
setcookie( 'comment_author_' . COOKIEHASH, $anonymous_data['bbp_anonymous_name'], time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN );
setcookie( 'comment_author_email_' . COOKIEHASH, $anonymous_data['bbp_anonymous_email'], time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN );
setcookie( 'comment_author_url_' . COOKIEHASH, $anonymous_data['bbp_anonymous_website'], time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN );
}
/**
* Get the poster IP address
*
* @since bbPress (r3120)
*
* @return string
*/
function bbp_current_author_ip() {
$retval = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
return apply_filters( 'bbp_current_author_ip', $retval );
}
/**
* Get the poster user agent
*
* @since bbPress (r3446)
*
* @return string
*/
function bbp_current_author_ua() {
$retval = ! empty( $_SERVER['HTTP_USER_AGENT'] ) ? substr( $_SERVER['HTTP_USER_AGENT'], 0, 254 ) : '';
return apply_filters( 'bbp_current_author_ua', $retval );
}
/** Post Counts ***************************************************************/
/**
* Return the raw database count of topics by a user
*
* @since bbPress (r3633)
* @return int Raw DB count of topics
* @uses bbp_get_user_id()
* @uses get_posts_by_author_sql()
* @uses bbp_get_topic_post_type()
* @uses apply_filters()
*/
function bbp_get_user_topic_count_raw( $user_id = 0 ) {
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
$bbp_db = bbp_db();
$where = get_posts_by_author_sql( bbp_get_topic_post_type(), true, $user_id );
$count = (int) $bbp_db->get_var( "SELECT COUNT(*) FROM {$bbp_db->posts} {$where}" );
return (int) apply_filters( 'bbp_get_user_topic_count_raw', $count, $user_id );
}
/**
* Return the raw database count of replies by a user
*
* @since bbPress (r3633)
* @return int Raw DB count of replies
* @uses bbp_get_user_id()
* @uses get_posts_by_author_sql()
* @uses bbp_get_reply_post_type()
* @uses apply_filters()
*/
function bbp_get_user_reply_count_raw( $user_id = 0 ) {
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
$bbp_db = bbp_db();
$where = get_posts_by_author_sql( bbp_get_reply_post_type(), true, $user_id );
$count = (int) $bbp_db->get_var( "SELECT COUNT(*) FROM {$bbp_db->posts} {$where}" );
return (int) apply_filters( 'bbp_get_user_reply_count_raw', $count, $user_id );
}
/** Subscriptions *************************************************************/
/**
* Get the users who have subscribed to the forum
*
* @since bbPress (r5156)
*
* @param int $forum_id Optional. forum id
*
* @return array|bool Results if the forum has any subscribers, otherwise false
* @uses apply_filters() Calls 'bbp_get_forum_subscribers' with the subscribers
* @uses wpdb::get_col() To execute our query and get the column back
*/
function bbp_get_forum_subscribers( $forum_id = 0 ) {
$forum_id = bbp_get_forum_id( $forum_id );
if ( empty( $forum_id ) ) {
return;
}
$users = wp_cache_get( 'bbp_get_forum_subscribers_' . $forum_id, 'bbpress_users' );
if ( false === $users ) {
$get_subscriptions = bb_get_subscription_users(
array(
'item_id' => $forum_id,
'type' => 'forum',
'count' => false,
),
true
);
$users = array();
if ( ! empty( $get_subscriptions['subscriptions'] ) ) {
$users = array_filter( wp_parse_id_list( $get_subscriptions['subscriptions'] ) );
}
wp_cache_set( 'bbp_get_forum_subscribers_' . $forum_id, $users, 'bbpress_users' );
}
return apply_filters( 'bbp_get_forum_subscribers', $users, $forum_id );
}
/**
* Get the users who have subscribed to the topic
*
* @since bbPress (r2668)
*
* @param int $topic_id Optional. Topic id
*
* @return array|bool Results if the topic has any subscribers, otherwise false
* @uses apply_filters() Calls 'bbp_get_topic_subscribers' with the subscribers
* @uses wpdb::get_col() To execute our query and get the column back
*/
function bbp_get_topic_subscribers( $topic_id = 0 ) {
$topic_id = bbp_get_topic_id( $topic_id );
if ( empty( $topic_id ) ) {
return;
}
$users = wp_cache_get( 'bbp_get_topic_subscribers_' . $topic_id, 'bbpress_users' );
if ( false === $users ) {
$get_subscriptions = bb_get_subscription_users(
array(
'item_id' => $topic_id,
'type' => 'topic',
'count' => false,
),
true
);
$users = array();
if ( ! empty( $get_subscriptions['subscriptions'] ) ) {
$users = array_filter( wp_parse_id_list( $get_subscriptions['subscriptions'] ) );
}
wp_cache_set( 'bbp_get_topic_subscribers_' . $topic_id, $users, 'bbpress_users' );
}
return apply_filters( 'bbp_get_topic_subscribers', $users, $topic_id );
}
/**
* Get a user's subscribed topics
*
* @since bbPress (r2668)
*
* @param int $user_id Optional. User id
*
* @return array|bool Results if user has subscriptions, otherwise false
* @uses bbp_get_user_topic_subscriptions() To get the user's subscriptions
* @deprecated since Forums (r5156)
*
*/
function bbp_get_user_subscriptions( $user_id = 0 ) {
_deprecated_function( __FUNCTION__, 2.5, 'bbp_get_user_topic_subscriptions()' );
$query = bbp_get_user_topic_subscriptions( $user_id );
return apply_filters( 'bbp_get_user_subscriptions', $query, $user_id );
}
/**
* Get a user's subscribed topics
*
* @since bbPress (r2668)
*
* @param int $user_id Optional. User id
*
* @return array|bool Results if user has subscriptions, otherwise false
* @uses bbp_has_topics() To get the topics
* @uses apply_filters() Calls 'bbp_get_user_subscriptions' with the topic query
* and user id
* @uses bbp_get_user_subscribed_topic_ids() To get the user's subscriptions
*/
function bbp_get_user_topic_subscriptions( $user_id = 0 ) {
// Default to the displayed user
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// If user has subscriptions, load them
$subscriptions = bbp_get_user_subscribed_topic_ids( $user_id );
if ( ! empty( $subscriptions ) ) {
$query = bbp_has_topics( array( 'post__in' => $subscriptions ) );
} else {
$query = false;
}
return apply_filters( 'bbp_get_user_topic_subscriptions', $query, $user_id );
}
/**
* Get a user's subscribed forums
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id
*
* @return array|bool Results if user has subscriptions, otherwise false
* @uses bbp_has_forums() To get the forums
* @uses apply_filters() Calls 'bbp_get_user_forum_subscriptions' with the forum
* query and user id
* @uses bbp_get_user_subscribed_forum_ids() To get the user's subscriptions
*/
function bbp_get_user_forum_subscriptions( $user_id = 0 ) {
// Default to the displayed user
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// If user has subscriptions, load them
$subscriptions = bbp_get_user_subscribed_forum_ids( $user_id );
if ( ! empty( $subscriptions ) ) {
$query = bbp_has_forums( array( 'post__in' => $subscriptions ) );
} else {
$query = false;
}
return apply_filters( 'bbp_get_user_forum_subscriptions', $query, $user_id );
}
/**
* Get a user's subscribed forum ids
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id
*
* @return array|bool Results if user has subscriptions, otherwise false
* @uses get_user_option() To get the user's subscriptions
* @uses apply_filters() Calls 'bbp_get_user_subscribed_forum_ids' with
* the subscriptions and user id
* @uses bbp_get_user_id() To get the user id
*/
function bbp_get_user_subscribed_forum_ids( $user_id = 0 ) {
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
$get_subscriptions = bb_get_subscriptions(
array(
'user_id' => $user_id,
'type' => 'forum',
'fields' => 'item_id',
),
true
);
$subscriptions = array();
if ( ! empty( $get_subscriptions['subscriptions'] ) ) {
$subscriptions = array_filter( wp_parse_id_list( $get_subscriptions['subscriptions'] ) );
}
return (array) apply_filters( 'bbp_get_user_subscribed_forum_ids', $subscriptions, $user_id );
}
/**
* Get a user's subscribed topics' ids
*
* @since bbPress (r2668)
*
* @param int $user_id Optional. User id
*
* @return array|bool Results if user has subscriptions, otherwise false
* @uses get_user_option() To get the user's subscriptions
* @uses apply_filters() Calls 'bbp_get_user_subscribed_topic_ids' with
* the subscriptions and user id
* @uses bbp_get_user_id() To get the user id
*/
function bbp_get_user_subscribed_topic_ids( $user_id = 0 ) {
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
$get_subscriptions = bb_get_subscriptions(
array(
'user_id' => $user_id,
'type' => 'topic',
'fields' => 'item_id',
),
true
);
$subscriptions = array();
if ( ! empty( $get_subscriptions['subscriptions'] ) ) {
$subscriptions = array_filter( wp_parse_id_list( $get_subscriptions['subscriptions'] ) );
}
return (array) apply_filters( 'bbp_get_user_subscribed_topic_ids', $subscriptions, $user_id );
}
/**
* Check if a topic or forum is in user's subscription list or not
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id
* @param int $forum_id Optional. Topic id
*
* @return bool True if the forum or topic is in user's subscriptions, otherwise false
* @uses get_post() To get the post object
* @uses bbp_get_user_subscribed_forum_ids() To get the user's forum subscriptions
* @uses bbp_get_user_subscribed_topic_ids() To get the user's topic subscriptions
* @uses bbp_get_forum_post_type() To get the forum post type
* @uses bbp_get_topic_post_type() To get the topic post type
* @uses apply_filters() Calls 'bbp_is_user_subscribed' with the bool, user id,
* forum/topic id and subsriptions
*/
function bbp_is_user_subscribed( $user_id = 0, $object_id = 0 ) {
// Assume user is not subscribed
$retval = false;
// Setup ID's array
$subscribed_ids = array();
// User and object ID's are passed
if ( ! empty( $user_id ) && ! empty( $object_id ) ) {
// Get the post type
$post_type = get_post_type( $object_id );
// Post exists, so check the types
if ( ! empty( $post_type ) ) {
switch ( $post_type ) {
// Forum
case bbp_get_forum_post_type():
$subscribed_ids = bbp_get_user_subscribed_forum_ids( $user_id );
$retval = bbp_is_user_subscribed_to_forum( $user_id, $object_id, $subscribed_ids );
break;
// Topic (default)
case bbp_get_topic_post_type():
default:
$subscribed_ids = bbp_get_user_subscribed_topic_ids( $user_id );
$retval = bbp_is_user_subscribed_to_topic( $user_id, $object_id, $subscribed_ids );
break;
}
}
}
return (bool) apply_filters( 'bbp_is_user_subscribed', $retval, $user_id, $object_id, $subscribed_ids );
}
/**
* Check if a forum is in user's subscription list or not
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id
* @param int $forum_id Optional. Topic id
* @param array $subscribed_ids Optional. Array of forum ID's to check
*
* @return bool True if the forum is in user's subscriptions, otherwise false
* @uses bbp_get_user_id() To get the user id
* @uses bbp_get_user_subscribed_forum_ids() To get the user's subscriptions
* @uses bbp_get_forum() To get the forum
* @uses bbp_get_forum_id() To get the forum id
* @uses apply_filters() Calls 'bbp_is_user_subscribed' with the bool, user id,
* forum id and subsriptions
*/
function bbp_is_user_subscribed_to_forum( $user_id = 0, $forum_id = 0, $subscribed_ids = array() ) {
// Assume user is not subscribed.
$retval = false;
// Validate user.
$user_id = bbp_get_user_id( $user_id, true, true );
if ( ! empty( $user_id ) ) {
// Get subscription ID's if none passed.
if ( empty( $subscribed_ids ) ) {
$subscribed_ids = bbp_get_user_subscribed_forum_ids( $user_id );
}
// User has forum subscriptions.
if ( ! empty( $subscribed_ids ) ) {
// Checking a specific forum id.
if ( ! empty( $forum_id ) ) {
$forum = bbp_get_forum( $forum_id );
$forum_id = ! empty( $forum ) ? $forum->ID : 0;
// Using the global forum id.
} elseif ( bbp_get_forum_id() ) {
$forum_id = bbp_get_forum_id();
// Use the current post id.
} elseif ( ! bbp_get_forum_id() ) {
$forum_id = get_the_ID();
}
// Is forum_id in the user's favorites.
if ( ! empty( $forum_id ) ) {
$retval = in_array( $forum_id, $subscribed_ids, true );
}
}
}
return (bool) apply_filters( 'bbp_is_user_subscribed_to_forum', (bool) $retval, $user_id, $forum_id, $subscribed_ids );
}
/**
* Check if a topic is in user's subscription list or not
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id
* @param int $topic_id Optional. Topic id
* @param array $subscribed_ids Optional. Array of topic ID's to check
*
* @return bool True if the topic is in user's subscriptions, otherwise false
* @uses bbp_get_user_id() To get the user id
* @uses bbp_get_user_subscribed_topic_ids() To get the user's subscriptions
* @uses bbp_get_topic() To get the topic
* @uses bbp_get_topic_id() To get the topic id
* @uses apply_filters() Calls 'bbp_is_user_subscribed' with the bool, user id,
* topic id and subsriptions
*/
function bbp_is_user_subscribed_to_topic( $user_id = 0, $topic_id = 0, $subscribed_ids = array() ) {
// Assume user is not subscribed.
$retval = false;
// Validate user.
$user_id = bbp_get_user_id( $user_id, true, true );
if ( ! empty( $user_id ) ) {
// Get subscription ID's if none passed.
if ( empty( $subscribed_ids ) ) {
$subscribed_ids = bbp_get_user_subscribed_topic_ids( $user_id );
}
// User has topic subscriptions.
if ( ! empty( $subscribed_ids ) ) {
// Checking a specific topic id.
if ( ! empty( $topic_id ) ) {
$topic = bbp_get_topic( $topic_id );
$topic_id = ! empty( $topic ) ? $topic->ID : 0;
// Using the global topic id.
} elseif ( bbp_get_topic_id() ) {
$topic_id = bbp_get_topic_id();
// Use the current post id.
} elseif ( ! bbp_get_topic_id() ) {
$topic_id = get_the_ID();
}
// Is topic_id in the user's favorites.
if ( ! empty( $topic_id ) ) {
$retval = in_array( $topic_id, $subscribed_ids, true );
}
}
}
return (bool) apply_filters( 'bbp_is_user_subscribed_to_topic', (bool) $retval, $user_id, $topic_id, $subscribed_ids );
}
/**
* Add a topic to user's subscriptions
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id.
* @param int $object_id Optional. Topic id.
*
* @return bool Return true otherwise false.
* @uses get_post() To get the post object
* @uses bbp_get_user_subscribed_forum_ids() To get the user's forum subscriptions
* @uses bbp_get_user_subscribed_topic_ids() To get the user's topic subscriptions
* @uses bbp_get_forum_post_type() To get the forum post type
* @uses bbp_get_topic_post_type() To get the topic post type
* @uses update_user_option() To update the user's subscriptions
* @uses do_action() Calls 'bbp_add_user_subscription' with the user & topic id
*/
function bbp_add_user_subscription( $user_id = 0, $object_id = 0 ) {
if ( empty( $user_id ) || empty( $object_id ) ) {
return false;
}
// Get the post type.
$post_type = get_post_type( $object_id );
if ( empty( $post_type ) ) {
return false;
}
switch ( $post_type ) {
// Forum.
case bbp_get_forum_post_type():
$subscription_id = bbp_add_user_forum_subscription( $user_id, $object_id );
break;
// Topic.
case bbp_get_topic_post_type():
default:
$subscription_id = bbp_add_user_topic_subscription( $user_id, $object_id );
break;
}
do_action( 'bbp_add_user_subscription', $user_id, $object_id, $post_type );
return $subscription_id;
}
/**
* Add a forum to user's subscriptions
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id.
* @param int $forum_id Optional. forum id.
*
* @return bool Return true if subscribed otherwise false.
* @uses bbp_get_forum() To get the forum
* @uses update_user_option() To update the user's subscriptions
* @uses do_action() Calls 'bbp_add_user_subscription' with the user & forum id
* @uses bbp_get_user_subscribed_forum_ids() To get the user's subscriptions
*/
function bbp_add_user_forum_subscription( $user_id = 0, $forum_id = 0 ) {
if ( empty( $user_id ) || empty( $forum_id ) ) {
return false;
}
$forum = bbp_get_forum( $forum_id );
if ( empty( $forum ) ) {
return false;
}
$subscription_id = bb_create_subscription(
array(
'user_id' => $user_id,
'item_id' => $forum_id,
'type' => 'forum',
'secondary_item_id' => $forum->post_parent,
'error_type' => 'bool',
)
);
if ( $subscription_id ) {
wp_cache_delete( 'bbp_get_forum_subscribers_' . $forum_id, 'bbpress_users' );
}
do_action( 'bbp_add_user_forum_subscription', $user_id, $forum_id );
return is_int( $subscription_id );
}
/**
* Add a topic to user's subscriptions
*
* @since bbPress (r2668)
*
* @param int $user_id Optional. User id.
* @param int $topic_id Optional. Topic id.
*
* @return bool Return true if subscribed otherwise false.
* @uses bbp_get_topic() To get the topic
* @uses update_user_option() To update the user's subscriptions
* @uses do_action() Calls 'bbp_add_user_subscription' with the user & topic id
* @uses bbp_get_user_subscribed_topic_ids() To get the user's subscriptions
*/
function bbp_add_user_topic_subscription( $user_id = 0, $topic_id = 0 ) {
if ( empty( $user_id ) || empty( $topic_id ) ) {
return false;
}
$topic = bbp_get_topic( $topic_id );
if ( empty( $topic ) ) {
return false;
}
$subscription_id = bb_create_subscription(
array(
'user_id' => $user_id,
'item_id' => $topic_id,
'type' => 'topic',
'secondary_item_id' => $topic->post_parent,
'error_type' => 'bool',
)
);
if ( $subscription_id ) {
wp_cache_delete( 'bbp_get_topic_subscribers_' . $topic_id, 'bbpress_users' );
}
do_action( 'bbp_add_user_topic_subscription', $user_id, $topic_id );
return is_int( $subscription_id );
}
/**
* Remove a topic from user's subscriptions
*
* @since bbPress (r2668)
*
* @param int $user_id Optional. User id.
* @param int $object_id Optional. Topic id.
*
* @return bool True if the topic was removed from user's subscriptions,
* otherwise false
* @uses get_post() To get the post object
* @uses bbp_get_forum_post_type() To get the forum post type
* @uses bbp_get_topic_post_type() To get the topic post type
* @uses bbp_remove_user_forum_subscription() To remove the user's subscription
* @uses bbp_remove_user_topic_subscription() To remove the user's subscription
* @uses do_action() Calls 'bbp_remove_user_subscription' with the user id and
* topic id
*/
function bbp_remove_user_subscription( $user_id = 0, $object_id = 0 ) {
if ( empty( $user_id ) || empty( $object_id ) ) {
return false;
}
$post_type = get_post_type( $object_id );
if ( empty( $post_type ) ) {
return false;
}
switch ( $post_type ) {
// Forum.
case bbp_get_forum_post_type():
bbp_remove_user_forum_subscription( $user_id, $object_id );
break;
// Topic.
case bbp_get_topic_post_type():
default:
bbp_remove_user_topic_subscription( $user_id, $object_id );
break;
}
do_action( 'bbp_remove_user_subscription', $user_id, $object_id, $post_type );
return true;
}
/**
* Remove a forum from user's subscriptions
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id.
* @param int $forum_id Optional. forum id.
*
* @return bool True if the forum was removed from user's subscriptions,
* otherwise false
* @uses update_user_option() To update the user's subscriptions
* @uses delete_user_option() To delete the user's subscriptions meta
* @uses do_action() Calls 'bbp_remove_user_subscription' with the user id and
* forum id
* @uses bbp_get_user_subscribed_forum_ids() To get the user's subscriptions
*/
function bbp_remove_user_forum_subscription( $user_id, $forum_id ) {
if ( empty( $user_id ) || empty( $forum_id ) ) {
return false;
}
$forum = bbp_get_forum( $forum_id );
if ( empty( $forum ) ) {
return false;
}
// Check if subscription is existed or not?.
$subscriptions = bb_get_subscriptions(
array(
'type' => 'forum',
'user_id' => $user_id,
'item_id' => $forum_id,
'count' => false,
'cache' => false,
'status' => null,
),
true
);
if ( empty( $subscriptions['subscriptions'] ) ) {
return false;
}
// Get current one.
$subscription = current( $subscriptions['subscriptions'] );
// Delete the subscription.
bb_delete_subscription( $subscription->id );
wp_cache_delete( 'bbp_get_forum_subscribers_' . $forum_id, 'bbpress_users' );
do_action( 'bbp_remove_user_forum_subscription', $user_id, $forum_id );
return true;
}
/**
* Remove a topic from user's subscriptions
*
* @since bbPress (r5156)
*
* @param int $user_id Optional. User id.
* @param int $topic_id Optional. Topic id.
*
* @return bool True if the topic was removed from user's subscriptions,
* otherwise false
* @uses update_user_option() To update the user's subscriptions
* @uses delete_user_option() To delete the user's subscriptions meta
* @uses do_action() Calls 'bbp_remove_user_topic_subscription' with the user id and
* topic id
* @uses bbp_get_user_subscribed_topic_ids() To get the user's subscriptions
*/
function bbp_remove_user_topic_subscription( $user_id, $topic_id ) {
if ( empty( $user_id ) || empty( $topic_id ) ) {
return false;
}
$topic = bbp_get_topic( $topic_id );
if ( empty( $topic ) ) {
return false;
}
// Check if subscription is existed or not?.
$subscriptions = bb_get_subscriptions(
array(
'type' => 'topic',
'user_id' => $user_id,
'item_id' => $topic_id,
'count' => false,
'cache' => false,
'status' => null,
),
true
);
if ( empty( $subscriptions['subscriptions'] ) ) {
return false;
}
// Get current one.
$subscription = current( $subscriptions['subscriptions'] );
// Delete the subscription.
bb_delete_subscription( $subscription->id );
wp_cache_delete( 'bbp_get_topic_subscribers_' . $topic_id, 'bbpress_users' );
do_action( 'bbp_remove_user_topic_subscription', $user_id, $topic_id );
return true;
}
/**
* Handles the front end subscribing and unsubscribing forums
*
* @since bbPress (r5156)
*
* @param string $action The requested action to compare this function to.
*
* @uses bb_is_enabled_subscription() To check if the subscriptions are active
* @uses bbp_get_user_id() To get the user id
* @uses bbp_verify_nonce_request() To verify the nonce and check the request
* @uses current_user_can() To check if the current user can edit the user
* @uses bbPress:errors:add() To log the error messages
* @uses bbp_is_user_subscribed() To check if the forum is in user's
* subscriptions
* @uses bbp_remove_user_subscription() To remove the user subscription
* @uses bbp_add_user_subscription() To add the user subscription
* @uses do_action() Calls 'bbp_subscriptions_handler' with success, user id,
* forum id and action
* @uses bbp_is_subscription() To check if it's the subscription page
* @uses bbp_get_forum_permalink() To get the forum permalink
* @uses bbp_redirect() To redirect to the url
*/
function bbp_forum_subscriptions_handler( $action = '' ) {
if ( ! bb_is_enabled_subscription( 'forum' ) ) {
return false;
}
// Bail if no forum ID is passed
if ( empty( $_GET['forum_id'] ) ) {
return;
}
// Setup possible get actions
$possible_actions = array(
'bbp_subscribe',
'bbp_unsubscribe',
);
// Bail if actions aren't meant for this function
if ( ! in_array( $action, $possible_actions ) ) {
return;
}
// Get required data
$user_id = bbp_get_user_id( 0, true, true );
$forum_id = intval( $_GET['forum_id'] );
// Check for empty forum
if ( empty( $forum_id ) ) {
bbp_add_error( 'bbp_subscription_forum_id', __( '<strong>ERROR</strong>: No forum was found! Which forum are you subscribing/unsubscribing to?', 'buddyboss' ) );
// Check nonce
} elseif ( ! bbp_verify_nonce_request( 'toggle-subscription_' . $forum_id ) ) {
bbp_add_error( 'bbp_subscription_forum_id', __( '<strong>ERROR</strong>: Are you sure you wanted to do that?', 'buddyboss' ) );
// Check current user's ability to edit the user
} elseif ( ! current_user_can( 'edit_user', $user_id ) ) {
bbp_add_error( 'bbp_subscription_permissions', __( '<strong>ERROR</strong>: You don\'t have the permission to edit favorites of that user!', 'buddyboss' ) );
}
// Bail if we have errors
if ( bbp_has_errors() ) {
return;
}
/** No errors */
$is_subscription = bbp_is_user_subscribed( $user_id, $forum_id );
$success = false;
if ( true === $is_subscription && 'bbp_unsubscribe' === $action ) {
$success = bbp_remove_user_subscription( $user_id, $forum_id );
} elseif ( false === $is_subscription && 'bbp_subscribe' === $action ) {
$success = bbp_add_user_subscription( $user_id, $forum_id );
}
// Do additional subscriptions actions
do_action( 'bbp_subscriptions_handler', $success, $user_id, $forum_id, $action );
// Success!
if ( $success ) {
// Redirect back from whence we came
if ( bbp_is_subscriptions() ) {
$redirect = bbp_get_subscriptions_permalink( $user_id );
} elseif ( bbp_is_single_user() ) {
$redirect = bbp_get_user_profile_url();
} elseif ( is_singular( bbp_get_forum_post_type() ) ) {
$redirect = bbp_get_forum_permalink( $forum_id );
} elseif ( is_single() || is_page() ) {
$redirect = get_permalink();
} else {
$redirect = get_permalink( $forum_id );
}
bbp_redirect( $redirect );
// Fail! Handle errors
} elseif ( true === $is_subscription && 'bbp_unsubscribe' === $action ) {
bbp_add_error( 'bbp_unsubscribe', __( '<strong>ERROR</strong>: There was a problem unsubscribing from that forum!', 'buddyboss' ) );
} elseif ( false === $is_subscription && 'bbp_subscribe' === $action ) {
bbp_add_error( 'bbp_subscribe', __( '<strong>ERROR</strong>: There was a problem subscribing to that forum!', 'buddyboss' ) );
}
}
/**
* Handles the front end subscribing and unsubscribing topics
*
* @param string $action The requested action to compare this function to
*
* @uses bb_is_enabled_subscription() To check if the subscriptions are active
* @uses bbp_get_user_id() To get the user id
* @uses bbp_verify_nonce_request() To verify the nonce and check the request
* @uses current_user_can() To check if the current user can edit the user
* @uses bbPress:errors:add() To log the error messages
* @uses bbp_is_user_subscribed() To check if the topic is in user's
* subscriptions
* @uses bbp_remove_user_subscription() To remove the user subscription
* @uses bbp_add_user_subscription() To add the user subscription
* @uses do_action() Calls 'bbp_subscriptions_handler' with success, user id,
* topic id and action
* @uses bbp_is_subscription() To check if it's the subscription page
* @uses bbp_get_topic_permalink() To get the topic permalink
* @uses bbp_redirect() To redirect to the url
*/
function bbp_subscriptions_handler( $action = '' ) {
if ( ! bb_is_enabled_subscription( 'topic' ) ) {
return false;
}
// Bail if no topic ID is passed
if ( empty( $_GET['topic_id'] ) ) {
return;
}
// Setup possible get actions
$possible_actions = array(
'bbp_subscribe',
'bbp_unsubscribe',
);
// Bail if actions aren't meant for this function
if ( ! in_array( $action, $possible_actions ) ) {
return;
}
// Get required data
$user_id = bbp_get_user_id( 0, true, true );
$topic_id = intval( $_GET['topic_id'] );
// Check for empty topic
if ( empty( $topic_id ) ) {
bbp_add_error( 'bbp_subscription_topic_id', __( '<strong>ERROR</strong>: No discussion was found! Which discussion are you subscribing/unsubscribing to?', 'buddyboss' ) );
// Check nonce
} elseif ( ! bbp_verify_nonce_request( 'toggle-subscription_' . $topic_id ) ) {
bbp_add_error( 'bbp_subscription_topic_id', __( '<strong>ERROR</strong>: Are you sure you wanted to do that?', 'buddyboss' ) );
// Check current user's ability to edit the user
} elseif ( ! current_user_can( 'edit_user', $user_id ) ) {
bbp_add_error( 'bbp_subscription_permissions', __( '<strong>ERROR</strong>: You don\'t have the permission to edit favorites of that user!', 'buddyboss' ) );
}
// Bail if we have errors
if ( bbp_has_errors() ) {
return;
}
/** No errors */
$is_subscription = bbp_is_user_subscribed( $user_id, $topic_id );
$success = false;
if ( true === $is_subscription && 'bbp_unsubscribe' === $action ) {
$success = bbp_remove_user_subscription( $user_id, $topic_id );
} elseif ( false === $is_subscription && 'bbp_subscribe' === $action ) {
$success = bbp_add_user_subscription( $user_id, $topic_id );
}
// Do additional subscriptions actions
do_action( 'bbp_subscriptions_handler', $success, $user_id, $topic_id, $action );
// Success!
if ( $success ) {
// Redirect back from whence we came
if ( bbp_is_subscriptions() ) {
$redirect = bbp_get_subscriptions_permalink( $user_id );
} elseif ( bbp_is_single_user() ) {
$redirect = bbp_get_user_profile_url();
} elseif ( is_singular( bbp_get_topic_post_type() ) ) {
$redirect = bbp_get_topic_permalink( $topic_id );
} elseif ( is_single() || is_page() ) {
$redirect = get_permalink();
} else {
$redirect = get_permalink( $topic_id );
}
bbp_redirect( $redirect );
// Fail! Handle errors
} elseif ( true === $is_subscription && 'bbp_unsubscribe' === $action ) {
bbp_add_error( 'bbp_unsubscribe', __( '<strong>ERROR</strong>: There was a problem unsubscribing from that discussion!', 'buddyboss' ) );
} elseif ( false === $is_subscription && 'bbp_subscribe' === $action ) {
bbp_add_error( 'bbp_subscribe', __( '<strong>ERROR</strong>: There was a problem subscribing to that discussion!', 'buddyboss' ) );
}
}
/** User Queries **************************************************************/
/**
* Get the topics that a user created
*
* @since 2.0.0 bbPress (r2660)
* @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
*
* @param array $args Optional. Arguments to pass into bbp_has_topics()
*
* @return bool True if user has started topics, otherwise false
*/
function bbp_get_user_topics_started( $args = array() ) {
// Backwards compat for pre-2.6.0
if ( is_numeric( $args ) ) {
$args = array(
'author' => bbp_get_user_id( $args, false, false )
);
}
// Default arguments
$defaults = array(
'author' => bbp_get_displayed_user_id()
);
// Parse arguments
$r = bbp_parse_args( $args, $defaults, 'get_user_topics_started' );
// Get the topics
$query = bbp_has_topics( $r );
$user_id = $r['author'];
return apply_filters( 'bbp_get_user_topics_started', $query, $user_id, $r, $args );
}
/**
* Get the replies that a user created
*
* @since bbPress (r4225)
*
* @param int $user_id Optional. User id
*
* @return array|bool Results if the user has created topics, otherwise false
* @uses bbp_has_replies() To get the topics created by the user
* @uses bbp_get_user_id() To get the topic id
*/
function bbp_get_user_replies_created( $user_id = 0 ) {
// Validate user
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Try to get the topics
$query = bbp_has_replies(
array(
'post_type' => bbp_get_reply_post_type(),
'order' => 'DESC',
'author' => $user_id,
)
);
return apply_filters( 'bbp_get_user_replies_created', $query, $user_id );
}
/**
* Get the total number of users on the forums
*
* @since bbPress (r2769)
* @return int Total number of users
* @uses apply_filters() Calls 'bbp_get_total_users' with number of users
* @uses count_users() To execute our query and get the var back
*/
function bbp_get_total_users() {
$bbp_db = bbp_db();
$count = $bbp_db->get_var( "SELECT COUNT(ID) as c FROM {$bbp_db->users} WHERE user_status = '0'" );
// Filter & return.
return (int) apply_filters( 'bbp_get_total_users', (int) $count );
}
/** Premissions ***************************************************************/
/**
* Check if a user is blocked, or cannot spectate the forums.
*
* @since bbPress (r2996)
*
* @uses is_user_logged_in() To check if user is logged in
* @uses bbp_is_user_keymaster() To check if user is a keymaster
* @uses current_user_can() To check if the current user can spectate
* @uses is_bbpress() To check if in a Forums section of the site
* @uses bbp_set_404() To set a 404 status
*/
function bbp_forum_enforce_blocked() {
// Bail if not logged in or keymaster
if ( ! is_user_logged_in() || bbp_is_user_keymaster() ) {
return;
}
// Set 404 if in Forums and user cannot spectate
if ( is_bbpress() && ! current_user_can( 'spectate' ) ) {
bbp_set_404();
}
}
/** Sanitization **************************************************************/
/**
* Sanitize displayed user data, when viewing and editing any user.
*
* This somewhat monolithic function handles the escaping and sanitization of
* user data for a Forums profile. There are two reasons this all happers here:
*
* 1. Forums took a similar approach to WordPress, and funnels all user profile
* data through a central helper. This eventually calls sanitize_user_field()
* which applies a few context based filters, which some third party plugins
* might be relying on Forums to play nicely with.
*
* 2. Early versions of bbPress 2.x templates did not escape this data meaning
* a backwards compatible approach like this one was necessary to protect
* existing installations that may have custom template parts.
*
* @since bbPress (r5368)
*
* @param string $value
* @param string $field
* @param string $context
*
* @return string
*/
function bbp_sanitize_displayed_user_field( $value = '', $field = '', $context = 'display' ) {
// Bail if not editing or displaying (maybe we'll do more here later)
if ( ! in_array( $context, array( 'edit', 'display' ) ) ) {
return $value;
}
// By default, no filter set (consider making this an array later)
$filter = false;
// Big switch statement to decide which user field we're sanitizing and how
switch ( $field ) {
// Description is a paragraph
case 'description':
$filter = ( 'edit' === $context ) ? '' : 'wp_kses_data';
break;
// Email addresses are sanitized with a specific function
case 'user_email':
$filter = 'sanitize_email';
break;
// Name & login fields
case 'user_login':
case 'display_name':
case 'first_name':
case 'last_name':
case 'nick_name':
$filter = ( 'edit' === $context ) ? 'esc_attr' : 'esc_html';
break;
// wp-includes/default-filters.php escapes this for us via esc_url()
case 'user_url':
break;
}
// Run any applicable filters on the value
if ( ! empty( $filter ) ) {
$value = call_user_func( $filter, $value );
}
return $value;
}
/** Converter *****************************************************************/
/**
* Convert passwords from previous platfrom encryption to WordPress encryption.
*
* @since bbPress (r3813)
* @global wpdb $wpdb WordPress database abstraction object.
*/
function bbp_user_maybe_convert_pass() {
// Bail if no username
$username = ! empty( $_POST['log'] ) ? $_POST['log'] : '';
if ( empty( $username ) ) {
return;
}
$bbp_db = bbp_db();
// Bail if no user password to convert
$row = $bbp_db->get_row( $bbp_db->prepare( "SELECT * FROM {$bbp_db->users} INNER JOIN {$bbp_db->usermeta} ON user_id = ID WHERE meta_key = '_bbp_class' AND user_login = '%s' LIMIT 1", $username ) );
if ( empty( $row ) || is_wp_error( $row ) ) {
return;
}
// Setup admin (to include converter)
require_once bbpress()->includes_dir . 'admin/admin.php';
// Create the admin object
bbp_admin();
// Convert password.
// `bbp_new_converter()` is deprecated in BuddyBoss 3.1.0 — the converter
// machinery moved to the buddyboss-tools plugin. When Tools is active the
// deprecated wrapper in bp-core/deprecated/buddyboss/3.0.0.php delegates to
// `bb_tools_bbp_new_converter()`, which loads the vendor class on demand.
// When Tools is inactive the wrapper returns null and the is_a() check
// below short-circuits the password callback — the legacy `require_once`
// calls that used to load Platform's converter.php / converters/*.php are
// no longer needed (and would fatal because those files have been deleted).
$converter = bbp_new_converter( $row->meta_value );
// Try to call the conversion method.
if ( is_a( $converter, 'BBP_Converter_Base' ) && method_exists( $converter, 'callback_pass' ) ) {
$converter->callback_pass( $username, $_POST['pwd'] );
}
}