File "template.php"
Full Path: /home/jlklyejr/public_html/wp-content/test/test/test/wp-content/plugins/bbpress/includes/users/template.php
File size: 64.26 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* bbPress User Template Tags
*
* @package bbPress
* @subpackage TemplateTags
*/
// Exit if accessed directly
defined( 'ABSPATH' ) || exit;
/** User Loop *****************************************************************/
/**
* Extension of WP_User_Query to allow easy looping
*
* @since 2.6.0 bbPress (r6330)
*/
class BBP_User_Query extends WP_User_Query {
/**
* The amount of users for the current query.
*
* @since 2.6.0 bbPress (r6330)
* @access public
* @var int
*/
public $user_count = 0;
/**
* Index of the current item in the loop.
*
* @since 2.6.0 bbPress (r6330)
* @access public
* @var int
*/
public $current_user = -1;
/**
* Whether the loop has started and the caller is in the loop.
*
* @since 2.6.0 bbPress (r6330)
* @access public
* @var bool
*/
public $in_the_loop = false;
/**
* The current user.
*
* @since 2.6.0 bbPress (r6330)
* @access public
* @var WP_User
*/
public $user;
/**
* PHP5 constructor.
*
* @since 2.6.0 bbPress (r6330)
* @access public
*
* @param null|string|array $query Optional. The query variables.
*/
public function __construct( $query = null ) {
if ( ! empty( $query ) ) {
parent::__construct( $query );
$this->user_count = count( $this->results );
}
}
/**
* Set up the next user and iterate current user index.
*
* @since 2.6.0 bbPress (r6330)
* @access public
*
* @return WP_User Next user.
*/
public function next_user() {
$this->current_user++;
$this->user = $this->results[ $this->current_user ];
return $this->user;
}
/**
* Sets up the current user.
*
* Retrieves the next user, sets up the user, sets the 'in the loop'
* property to true.
*
* @since 2.6.0 bbPress (r6330)
* @access public
*
* @global WP_User $user
*/
public function the_user() {
$this->in_the_loop = true;
// loop has just started
if ( $this->current_user === -1 ) {
/**
* Fires once the loop is started.
*
* @since 2.6.0 bbPress (r6330)
*
* @param WP_Query &$this The WP_Query instance (passed by reference).
*/
do_action_ref_array( 'loop_start', array( &$this ) );
}
$this->next_user();
}
/**
* Determines whether there are more users available in the loop.
*
* Calls the {@see 'loop_end'} action when the loop is complete.
*
* @since 2.6.0 bbPress (r6330)
* @access public
*
* @return bool True if users are available, false if end of loop.
*/
public function have_users() {
if ( ( $this->current_user + 1 ) < $this->user_count ) {
return true;
} elseif ( ( ( $this->current_user + 1 ) === $this->user_count ) && ( $this->user_count > 0 ) ) {
/**
* Fires once the loop has ended.
*
* @since 2.6.0 bbPress (r6330)
*
* @param WP_Query &$this The WP_Query instance (passed by reference).
*/
do_action_ref_array( 'loop_end', array( &$this ) );
// Do some cleaning up after the loop
$this->rewind_users();
}
$this->in_the_loop = false;
return false;
}
/**
* Rewind the users and reset user index.
*
* @since 2.6.0 bbPress (r6330)
* @access public
*/
public function rewind_users() {
$this->current_user = -1;
if ( $this->user_count > 0 ) {
$this->user = $this->results[ 0 ];
}
}
}
/**
* The main user loop.
*
* @since 2.6.0 bbPress (r6330)
*
* @param array $args All the arguments supported by {@link WP_User_Query}
* @return object Multidimensional array of user information
*/
function bbp_has_users( $args = array() ) {
// Parse arguments with default user query for most circumstances
$r = bbp_parse_args( $args, array(
'include' => array(),
'orderby' => 'login',
'order' => 'ASC',
'count_total' => false,
'fields' => 'all',
), 'has_users' );
// Run the query
$bbp = bbpress();
$bbp->user_query = new BBP_User_Query( $r );
// Filter & return
return apply_filters( 'bbp_has_users', $bbp->user_query->have_users(), $bbp->user_query );
}
/**
* Whether there are more users available in the loop
*
* @since 2.6.0 bbPress (r2464)
*
* @return object User information
*/
function bbp_users() {
return bbpress()->user_query->have_users();
}
/**
* Loads up the current user in the loop
*
* @since 2.6.0 bbPress (r2464)
*
* @return object User information
*/
function bbp_the_user() {
return bbpress()->user_query->the_user();
}
/** Users *********************************************************************/
/**
* Output a validated user id
*
* @since 2.0.0 bbPress (r2729)
*
* @param int $user_id Optional. User id
* @param bool $displayed_user_fallback Fallback on displayed user?
* @param bool $current_user_fallback Fallback on current user?
*/
function bbp_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
echo bbp_get_user_id( $user_id, $displayed_user_fallback, $current_user_fallback );
}
/**
* Return a validated user id
*
* @since 2.0.0 bbPress (r2729)
*
* @param int $user_id Optional. User id
* @param bool $displayed_user_fallback Fallback on displayed user?
* @param bool $current_user_fallback Fallback on current user?
* @return int Validated user id
*/
function bbp_get_user_id( $user_id = 0, $displayed_user_fallback = true, $current_user_fallback = false ) {
$bbp = bbpress();
// Easy empty checking
if ( ! empty( $user_id ) && is_numeric( $user_id ) ) {
$bbp_user_id = $user_id;
// Currently inside a user loop
} elseif ( ! empty( $bbp->user_query->in_the_loop ) && isset( $bbp->user_query->user->ID ) ) {
$bbp_user_id = $bbp->user_query->user->ID;
// Currently viewing or editing a user
} elseif ( ( true === $displayed_user_fallback ) && ! empty( $bbp->displayed_user->ID ) ) {
$bbp_user_id = $bbp->displayed_user->ID;
// Maybe fallback on the current_user ID
} elseif ( ( true === $current_user_fallback ) && ! empty( $bbp->current_user->ID ) ) {
$bbp_user_id = $bbp->current_user->ID;
// Failsafe
} else {
$bbp_user_id = 0;
}
// Filter & return
return (int) apply_filters( 'bbp_get_user_id', (int) $bbp_user_id, $displayed_user_fallback, $current_user_fallback );
}
/**
* Output ID of current user
*
* @since 2.0.0 bbPress (r2574)
*/
function bbp_current_user_id() {
echo bbp_get_current_user_id();
}
/**
* Return ID of current user
*
* @since 2.0.0 bbPress (r2574)
*
* @return int Current user id
*/
function bbp_get_current_user_id() {
// Filter & return
return (int) apply_filters( 'bbp_get_current_user_id', bbp_get_user_id( 0, false, true ) );
}
/**
* Output ID of displayed user
*
* @since 2.0.0 bbPress (r2688)
*/
function bbp_displayed_user_id() {
echo bbp_get_displayed_user_id();
}
/**
* Return ID of displayed user
*
* @since 2.0.0 bbPress (r2688)
*
* @return int Displayed user id
*/
function bbp_get_displayed_user_id() {
// Filter & return
return apply_filters( 'bbp_get_displayed_user_id', bbp_get_user_id( 0, true, false ) );
}
/**
* Output a sanitized user field value
*
* This function relies on the $filter parameter to decide how to sanitize
* the field value that it finds. Since it uses the WP_User object's magic
* __get() method, it can also be used to get user_meta values.
*
* @since 2.0.0 bbPress (r2688)
*
* @param string $field Field to get
* @param string $filter How to filter the field value (null|raw|db|display|edit)
*/
function bbp_displayed_user_field( $field = '', $filter = 'display' ) {
echo bbp_get_displayed_user_field( $field, $filter );
}
/**
* Return a sanitized user field value
*
* This function relies on the $filter parameter to decide how to sanitize
* the field value that it finds. Since it uses the WP_User object's magic
* __get() method, it can also be used to get user_meta values.
*
* @since 2.0.0 bbPress (r2688)
*
* @param string $field Field to get
* @param string $filter How to filter the field value (null|raw|db|display|edit)
* @see WP_User::__get() for more on how the value is retrieved
* @see sanitize_user_field() for more on how the value is sanitized
* @return string|bool Value of the field if it exists, else false
*/
function bbp_get_displayed_user_field( $field = '', $filter = 'display' ) {
// Get the displayed user
$user = bbpress()->displayed_user;
// Juggle the user filter property because we don't want to muck up how
// other code might interact with this object.
$old_filter = $user->filter;
$user->filter = $filter;
// Get the field value from the WP_User object. We don't need to perform
// an isset() because the WP_User::__get() does it for us.
$value = $user->$field;
// Put back the user filter property that was previously juggled above.
$user->filter = $old_filter;
// Filter & return
return apply_filters( 'bbp_get_displayed_user_field', $value, $field, $filter );
}
/**
* Output name of current user
*
* @since 2.0.0 bbPress (r2574)
*/
function bbp_current_user_name() {
echo esc_attr( bbp_get_current_user_name() );
}
/**
* Return name of current user
*
* @since 2.0.0 bbPress (r2574)
*
* @return string
*/
function bbp_get_current_user_name() {
// Default current user name
$default = bbp_get_fallback_display_name();
// Check the $user_identity global
$current_user_name = is_user_logged_in()
? bbp_get_global_object( 'user_identity', false, $default )
: $default;
// Filter & return
return apply_filters( 'bbp_get_current_user_name', $current_user_name );
}
/**
* Output avatar of current user
*
* @since 2.0.0 bbPress (r2574)
*
* @param int $size Size of the avatar. Defaults to 40
*/
function bbp_current_user_avatar( $size = 40 ) {
echo bbp_get_current_user_avatar( $size );
}
/**
* Return avatar of current user
*
* @since 2.0.0 bbPress (r2574)
*
* @param int $size Size of the avatar. Defaults to 40
* @return string Current user avatar
*/
function bbp_get_current_user_avatar( $size = 40 ) {
$user = bbp_get_current_user_id();
if ( empty( $user ) ) {
$user = bbp_get_current_anonymous_user_data( 'email' );
}
$avatar = get_avatar( $user, $size );
// Filter & return
return apply_filters( 'bbp_get_current_user_avatar', $avatar, $size );
}
/**
* Output link to the profile page of a user
*
* @since 2.0.0 bbPress (r2688)
*
* @param int $user_id Optional. User id
*/
function bbp_user_profile_link( $user_id = 0 ) {
echo bbp_get_user_profile_link( $user_id );
}
/**
* Return link to the profile page of a user
*
* @since 2.0.0 bbPress (r2688)
*
* @param int $user_id Optional. User id
* @return string User profile link
*/
function bbp_get_user_profile_link( $user_id = 0 ) {
// Validate user id
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
$user = get_userdata( $user_id );
$user_link = '<a href="' . esc_url( bbp_get_user_profile_url( $user_id ) ) . '">' . esc_html( $user->display_name ) . '</a>';
// Filter & return
return apply_filters( 'bbp_get_user_profile_link', $user_link, $user_id );
}
/**
* Output a users nicename to the screen
*
* @since 2.3.0 bbPress (r4671)
*
* @param int $user_id User ID whose nicename to get
* @param array $args before|after|user_id|force
*/
function bbp_user_nicename( $user_id = 0, $args = array() ) {
echo bbp_get_user_nicename( $user_id, $args );
}
/**
* Return a users nicename to the screen
*
* @since 2.3.0 bbPress (r4671)
*
* @param int $user_id User ID whose nicename to get
* @param array $args before|after|user_id|force
* @return string User nicename, maybe wrapped in before/after strings
*/
function bbp_get_user_nicename( $user_id = 0, $args = array() ) {
// Bail if no user ID passed
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Parse default arguments
$r = bbp_parse_args( $args, array(
'user_id' => $user_id,
'before' => '',
'after' => '',
'force' => ''
), 'get_user_nicename' );
// Force the nicename (likely from a previous user query)
if ( ! empty( $r['force'] ) ) {
$nicename = (string) $r['force'];
// Maybe fallback to getting the nicename from user data
} elseif ( ! empty( $r['user_id'] ) ) {
$user = get_userdata( $r['user_id'] );
$nicename = ! empty( $user )
? $user->user_nicename
: '';
// Maybe fallback to empty string so filter still applies
} else {
$nicename = '';
}
// Maybe wrap the nicename
$retval = ! empty( $nicename )
? $r['before'] . esc_html( $nicename ) . $r['after']
: '';
// Filter & return
return (string) apply_filters( 'bbp_get_user_nicename', $retval, $user_id, $r, $args );
}
/**
* Output URL to the profile page of a user
*
* @since 2.0.0 bbPress (r2688)
*
* @param int $user_id Optional. User id
* @param string $user_nicename Optional. User nicename
*/
function bbp_user_profile_url( $user_id = 0, $user_nicename = '' ) {
echo esc_url( bbp_get_user_profile_url( $user_id, $user_nicename ) );
}
/**
* Return URL to the profile page of a user
*
* @since 2.0.0 bbPress (r2688)
*
* @param int $user_id Optional. User id
* @param string $user_nicename Optional. User nicename
* @return string User profile url
*/
function bbp_get_user_profile_url( $user_id = 0, $user_nicename = '' ) {
// Use displayed user ID if there is one, and one isn't requested
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Bail if intercepted
$intercept = bbp_maybe_intercept( 'bbp_pre_get_user_profile_url', func_get_args() );
if ( bbp_is_intercepted( $intercept ) ) {
return $intercept;
}
// Pretty permalinks
if ( bbp_use_pretty_urls() ) {
// Get username if not passed
if ( empty( $user_nicename ) ) {
$user_nicename = bbp_get_user_nicename( $user_id );
}
// Run through home_url()
$url = trailingslashit( bbp_get_root_url() . bbp_get_user_slug() ) . $user_nicename;
$url = user_trailingslashit( $url );
$url = home_url( $url );
// Unpretty permalinks
} else {
$url = add_query_arg( array(
bbp_get_user_rewrite_id() => $user_id
), home_url( '/' ) );
}
// Filter & return
return apply_filters( 'bbp_get_user_profile_url', $url, $user_id, $user_nicename );
}
/**
* Output link to the profile edit page of a user
*
* @since 2.0.0 bbPress (r2688)
*
* @param int $user_id Optional. User id
*/
function bbp_user_profile_edit_link( $user_id = 0 ) {
echo bbp_get_user_profile_edit_link( $user_id );
}
/**
* Return link to the profile edit page of a user
*
* @since 2.0.0 bbPress (r2688)
*
* @param int $user_id Optional. User id
* @return string User profile edit link
*/
function bbp_get_user_profile_edit_link( $user_id = 0 ) {
// Validate user id
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
$user = get_userdata( $user_id );
$edit_link = '<a href="' . esc_url( bbp_get_user_profile_edit_url( $user_id ) ) . '">' . esc_html( $user->display_name ) . '</a>';
// Filter & return
return apply_filters( 'bbp_get_user_profile_edit_link', $edit_link, $user_id );
}
/**
* Output URL to the profile edit page of a user
*
* @since 2.0.0 bbPress (r2688)
*
* @param int $user_id Optional. User id
* @param string $user_nicename Optional. User nicename
*/
function bbp_user_profile_edit_url( $user_id = 0, $user_nicename = '' ) {
echo esc_url( bbp_get_user_profile_edit_url( $user_id, $user_nicename ) );
}
/**
* Return URL to the profile edit page of a user
*
* @since 2.0.0 bbPress (r2688)
*
* @param int $user_id Optional. User id
* @param string $user_nicename Optional. User nicename
* @return string
*/
function bbp_get_user_profile_edit_url( $user_id = 0, $user_nicename = '' ) {
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Bail if intercepted
$intercept = bbp_maybe_intercept( 'bbp_pre_get_user_profile_edit_url', func_get_args() );
if ( bbp_is_intercepted( $intercept ) ) {
return $intercept;
}
// Get user profile URL
$profile_url = bbp_get_user_profile_url( $user_id, $user_nicename );
// Pretty permalinks
if ( bbp_use_pretty_urls() ) {
$url = trailingslashit( $profile_url ) . bbp_get_edit_slug();
$url = user_trailingslashit( $url );
// Unpretty permalinks
} else {
$url = add_query_arg( array(
bbp_get_edit_rewrite_id() => '1'
), $profile_url );
}
// Filter & return
return apply_filters( 'bbp_get_user_edit_profile_url', $url, $user_id, $user_nicename );
}
/**
* Output a user's main role for display
*
* @since 2.1.0 bbPress (r3860)
*
* @param int $user_id
*/
function bbp_user_display_role( $user_id = 0 ) {
echo esc_attr( bbp_get_user_display_role( $user_id ) );
}
/**
* Return a user's main role for display
*
* @since 2.1.0 bbPress (r3860)
*
* @param int $user_id
* @return string
*/
function bbp_get_user_display_role( $user_id = 0 ) {
// Validate user id
$user_id = bbp_get_user_id( $user_id );
// User is not registered
if ( empty( $user_id ) ) {
$role = esc_html__( 'Guest', 'bbpress' );
// User is not active
} elseif ( bbp_is_user_inactive( $user_id ) ) {
$role = esc_html__( 'Inactive', 'bbpress' );
// User have a role
} else {
$role_id = bbp_get_user_role( $user_id );
$role = bbp_get_dynamic_role_name( $role_id );
}
// No role found so default to generic "Member"
if ( empty( $role ) ) {
$role = esc_html__( 'Member', 'bbpress' );
}
// Filter & return
return apply_filters( 'bbp_get_user_display_role', $role, $user_id );
}
/**
* Output the link to the admin section
*
* @since 2.0.0 bbPress (r2827)
*
* @param array $args Optional. See {@link bbp_get_admin_link()}
*/
function bbp_admin_link( $args = array() ) {
echo bbp_get_admin_link( $args );
}
/**
* Return the link to the admin section
*
* @since 2.0.0 bbPress (r2827)
*
* @param array $args Optional. This function supports these arguments:
* - text: The text
* - before: Before the lnk
* - after: After the link
* @return The link
*/
function bbp_get_admin_link( $args = array() ) {
// Bail if user cannot globally moderate
if ( ! current_user_can( 'moderate' ) ) {
return;
}
if ( ! empty( $args ) && is_string( $args ) && ( false === strpos( $args, '=' ) ) ) {
$args = array( 'text' => $args );
}
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'text' => esc_html__( 'Admin', 'bbpress' ),
'before' => '',
'after' => ''
), 'get_admin_link' );
$retval = $r['before'] . '<a href="' . esc_url( admin_url() ) . '">' . $r['text'] . '</a>' . $r['after'];
// Filter & return
return apply_filters( 'bbp_get_admin_link', $retval, $r, $args );
}
/** User IP *******************************************************************/
/**
* Output the author IP address of a post
*
* @since 2.0.0 bbPress (r3120)
*
* @param array $args Optional. If it is an integer, it is used as post id.
*/
function bbp_author_ip( $args = array() ) {
echo bbp_get_author_ip( $args );
}
/**
* Return the author IP address of a post
*
* @since 2.0.0 bbPress (r3120)
*
* @param array $args Optional. If an integer, it is used as reply id.
* @return string Author link of reply
*/
function bbp_get_author_ip( $args = array() ) {
// Used as post id
$post_id = is_numeric( $args ) ? (int) $args : 0;
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'post_id' => $post_id,
'before' => '<span class="bbp-author-ip">(',
'after' => ')</span>'
), 'get_author_ip' );
// Get the author IP meta value
$author_ip = get_post_meta( $r['post_id'], '_bbp_author_ip', true );
$author_ip = ! empty( $author_ip )
? $r['before'] . esc_html( $author_ip ) . $r['after']
: '';
// Filter & return
return apply_filters( 'bbp_get_author_ip', $author_ip, $r, $args );
}
/** Anonymous Fields **********************************************************/
/**
* Get the default name that's displayed when a user cannot be identified.
*
* This might happen if a user was deleted but their content was retained, or
* if something went wrong during saving anonymous user data to the database.
*
* @since 2.6.0 bbPress (r6561)
*
* @param int $object_id For additional context only, usually a post ID
*
* @return string
*/
function bbp_get_fallback_display_name( $object_id = 0 ) {
$name = esc_html__( 'Anonymous', 'bbpress' );
// Filter & return
return apply_filters( 'bbp_get_anonymous_name', $name, $object_id );
}
/**
* Output the author display-name of a topic or reply.
*
* Convenience function to ensure proper template functions are called
* and correct filters are executed. Used primarily to display topic
* and reply author information in the anonymous form template-part.
*
* @since 2.5.0 bbPress (r5119)
*
* @param int $post_id
*/
function bbp_author_display_name( $post_id = 0 ) {
echo esc_attr( bbp_get_author_display_name( $post_id ) );
}
/**
* Return the author display-name of a topic or reply.
*
* Convenience function to ensure proper template functions are called
* and correct filters are executed. Used primarily to display topic
* and reply author information in the anonymous form template-part.
*
* @since 2.5.0 bbPress (r5119)
*
* @param int $post_id
*
* @return string The name of the author
*/
function bbp_get_author_display_name( $post_id = 0 ) {
// Define local variable(s)
$retval = '';
// Topic edit
if ( bbp_is_topic_edit() ) {
$retval = bbp_get_topic_author_display_name( $post_id );
// Reply edit
} elseif ( bbp_is_reply_edit() ) {
$retval = bbp_get_reply_author_display_name( $post_id );
// Not an edit, so rely on current user cookie data
} else {
$retval = bbp_get_current_anonymous_user_data( 'name' );
}
// Filter & return
return apply_filters( 'bbp_get_author_display_name', $retval, $post_id );
}
/**
* Output the author email of a topic or reply.
*
* Convenience function to ensure proper template functions are called
* and correct filters are executed. Used primarily to display topic
* and reply author information in the anonymous user form template-part.
*
* @since 2.5.0 bbPress (r5119)
*
* @param int $post_id
*/
function bbp_author_email( $post_id = 0 ) {
echo esc_attr( bbp_get_author_email( $post_id ) );
}
/**
* Return the author email of a topic or reply.
*
* Convenience function to ensure proper template functions are called
* and correct filters are executed. Used primarily to display topic
* and reply author information in the anonymous user form template-part.
*
* @since 2.5.0 bbPress (r5119)
*
* @param int $post_id
*
* @return string The email of the author
*/
function bbp_get_author_email( $post_id = 0 ) {
// Define local variable(s)
$retval = '';
// Topic edit
if ( bbp_is_topic_edit() ) {
$retval = bbp_get_topic_author_email( $post_id );
// Reply edit
} elseif ( bbp_is_reply_edit() ) {
$retval = bbp_get_reply_author_email( $post_id );
// Not an edit, so rely on current user cookie data
} else {
$retval = bbp_get_current_anonymous_user_data( 'email' );
}
// Filter & return
return apply_filters( 'bbp_get_author_email', $retval, $post_id );
}
/**
* Output the author url of a topic or reply.
*
* Convenience function to ensure proper template functions are called
* and correct filters are executed. Used primarily to display topic
* and reply author information in the anonymous user form template-part.
*
* @since 2.5.0 bbPress (r5119)
*
* @param int $post_id
*/
function bbp_author_url( $post_id = 0 ) {
echo esc_attr( bbp_get_author_url( $post_id ) );
}
/**
* Return the author url of a topic or reply.
*
* Convenience function to ensure proper template functions are called
* and correct filters are executed. Used primarily to display topic
* and reply author information in the anonymous user form template-part.
*
* @since 2.5.0 bbPress (r5119)
*
* @param int $post_id
*
* @return string The url of the author
*/
function bbp_get_author_url( $post_id = 0 ) {
// Define local variable(s)
$retval = '';
// Topic edit
if ( bbp_is_topic_edit() ) {
$retval = bbp_get_topic_author_url( $post_id );
// Reply edit
} elseif ( bbp_is_reply_edit() ) {
$retval = bbp_get_reply_author_url( $post_id );
// Not an edit, so rely on current user cookie data
} else {
$retval = bbp_get_current_anonymous_user_data( 'url' );
}
// Filter & return
return apply_filters( 'bbp_get_author_url', $retval, $post_id );
}
/** Favorites *****************************************************************/
/**
* Output the link to the user's favorites page (profile page)
*
* @since 2.0.0 bbPress (r2652)
* @since 2.6.0 bbPress (r6308) Add pagination if in the loop
*
* @param int $user_id Optional. User id
*/
function bbp_favorites_permalink( $user_id = 0 ) {
echo esc_url( bbp_get_favorites_permalink( $user_id ) );
}
/**
* Return the link to the user's favorites page (profile page)
*
* @since 2.0.0 bbPress (r2652)
* @since 2.6.0 bbPress (r6308) Add pagination if in the loop
*
* @param int $user_id Optional. User id
* @return string Permanent link to user profile page
*/
function bbp_get_favorites_permalink( $user_id = 0 ) {
// Use displayed user ID if there is one, and one isn't requested
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Bail if intercepted
$intercept = bbp_maybe_intercept( 'bbp_pre_get_favorites_permalink', func_get_args() );
if ( bbp_is_intercepted( $intercept ) ) {
return $intercept;
}
// Get user profile URL & page
$profile_url = bbp_get_user_profile_url( $user_id );
$page = (int) bbpress()->topic_query->paged;
$paged = (bool) bbpress()->topic_query->in_the_loop;
// Pretty permalinks
if ( bbp_use_pretty_urls() ) {
// Base URL
$url = trailingslashit( $profile_url ) . bbp_get_user_favorites_slug();
// Add page
if ( ( true === $paged ) && ( $page > 1 ) ) {
$url = trailingslashit( $url ) . bbp_get_paged_slug() . '/' . $page;
}
// Ensure correct trailing slash
$url = user_trailingslashit( $url );
// Unpretty permalinks
} else {
// Base arguments
$args = array(
bbp_get_user_favorites_rewrite_id() => bbp_get_user_favorites_slug(),
);
// Add page
if ( ( true === $paged ) && ( $page > 1 ) ) {
$args['page'] = $page;
}
// Add arguments
$url = add_query_arg( $args, $profile_url );
}
// Filter & return
return apply_filters( 'bbp_get_favorites_permalink', $url, $user_id );
}
/**
* Output the link to make a topic favorite/remove a topic from favorites
*
* @since 2.0.0 bbPress (r2652)
* @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
*
* @param array $args See {@link bbp_get_user_favorites_link()}
* @param int $user_id Optional. User id
* @param bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">.
*/
function bbp_user_favorites_link( $args = array(), $user_id = 0, $wrap = true ) {
echo bbp_get_user_favorites_link( $args, $user_id, $wrap );
}
/**
* User favorites link
*
* Return the link to make a topic favorite/remove a topic from
* favorites
*
* @since 2.0.0 bbPress (r2652)
* @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
*
* @param array $args This function supports these arguments:
* - subscribe: Favorite text
* - unsubscribe: Unfavorite text
* - user_id: User id
* - topic_id: Topic id
* - before: Before the link
* - after: After the link
* @param int $user_id Optional. User id
* @param int $topic_id Optional. Topic id
* @param bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">. See ajax_favorite()
* @return string User favorites link
*/
function bbp_get_user_favorites_link( $args = array(), $user_id = 0, $wrap = true ) {
// Bail if favorites are inactive
if ( ! bbp_is_favorites_active() ) {
return false;
}
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'favorite' => esc_html__( 'Favorite', 'bbpress' ),
'favorited' => esc_html__( 'Unfavorite', 'bbpress' ),
'user_id' => 0,
'object_id' => 0,
'object_type' => 'post',
'before' => '',
'after' => '',
'redirect_to' => '',
// Deprecated. Use object_id.
'forum_id' => 0,
'topic_id' => 0
), 'get_user_favorites_link' );
// Validate user and object ID's
$user_id = bbp_get_user_id( $r['user_id'], true, true );
$object_type = sanitize_key( $r['object_type'] );
// Back-compat for deprecated arguments
if ( ! empty( $r['topic_id'] ) ) {
$object_id = absint( $r['topic_id'] );
} elseif ( ! empty( $r['forum_id'] ) ) {
$object_id = absint( $r['forum_id'] );
} else {
$object_id = absint( $r['object_id'] );
}
// Bail if empty
if ( empty( $user_id ) || empty( $object_id ) || empty( $object_type ) ) {
return false;
}
// No link if you can't edit yourself
if ( ! current_user_can( 'edit_user', $user_id ) ) {
return false;
}
// Decide which link to show
$is_fav = bbp_is_user_favorite( $user_id, $object_id );
if ( ! empty( $is_fav ) ) {
$text = $r['favorited'];
$q_args = array(
'action' => 'bbp_favorite_remove',
'object_id' => $object_id
);
} else {
$text = $r['favorite'];
$q_args = array(
'action' => 'bbp_favorite_add',
'object_id' => $object_id
);
}
// Custom redirect
if ( ! empty( $r['redirect_to'] ) ) {
$q_args['redirect_to'] = urlencode( $r['redirect_to'] );
}
// URL
$url = esc_url( wp_nonce_url( add_query_arg( $q_args ), 'toggle-favorite_' . $object_id ) );
$sub = $is_fav ? ' class="is-favorite"' : '';
$html = sprintf( '%s<span id="favorite-%d" %s><a href="%s" class="favorite-toggle" data-bbp-object-id="%d" data-bbp-object-type="%s" data-bbp-nonce="%s">%s</a></span>%s', $r['before'], $object_id, $sub, $url, $object_id, $object_type, wp_create_nonce( 'toggle-favorite_' . $object_id ), $text, $r['after'] );
// Initial output is wrapped in a span, ajax output is hooked to this
if ( ! empty( $wrap ) ) {
$html = '<span id="favorite-toggle">' . $html . '</span>';
}
// Filter & return
return apply_filters( 'bbp_get_user_favorites_link', $html, $r, $user_id, $object_id );
}
/** Subscriptions *************************************************************/
/**
* Output the link to the user's subscriptions page (profile page)
*
* @since 2.0.0 bbPress (r2688)
* @since 2.6.0 bbPress (r6308) Add pagination if in the loop
*
* @param int $user_id Optional. User id
*/
function bbp_subscriptions_permalink( $user_id = 0 ) {
echo esc_url( bbp_get_subscriptions_permalink( $user_id ) );
}
/**
* Return the link to the user's subscriptions page (profile page)
*
* @since 2.0.0 bbPress (r2688)
* @since 2.6.0 bbPress (r6308) Add pagination if in the loop
*
* @param int $user_id Optional. User id
* @return string Permanent link to user subscriptions page
*/
function bbp_get_subscriptions_permalink( $user_id = 0 ) {
// Use displayed user ID if there is one, and one isn't requested
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Bail if intercepted
$intercept = bbp_maybe_intercept( 'bbp_pre_get_subscriptions_permalink', func_get_args() );
if ( bbp_is_intercepted( $intercept ) ) {
return $intercept;
}
// Get user profile URL
$profile_url = bbp_get_user_profile_url( $user_id );
$page = 0;
$paged = false;
// Get pagination data
if ( bbpress()->topic_query->in_the_loop ) {
$page = (int) bbpress()->topic_query->paged;
$paged = (bool) bbpress()->topic_query->in_the_loop;
} elseif ( bbpress()->forum_query->in_the_loop ) {
$page = (int) bbpress()->forum_query->paged;
$paged = (bool) bbpress()->forum_query->in_the_loop;
}
// Pretty permalinks
if ( bbp_use_pretty_urls() ) {
// Base URL
$url = trailingslashit( $profile_url ) . bbp_get_user_subscriptions_slug();
// Add page
if ( ( true === $paged ) && ( $page > 1 ) ) {
$url = trailingslashit( $url ) . bbp_get_paged_slug() . '/' . $page;
}
// Ensure correct trailing slash
$url = user_trailingslashit( $url );
// Unpretty permalinks
} else {
// Base arguments
$args = array(
bbp_get_user_subscriptions_rewrite_id() => bbp_get_user_subscriptions_slug(),
);
// Add page
if ( ( true === $paged ) && ( $page > 1 ) ) {
$args['page'] = $page;
}
// Add arguments
$url = add_query_arg( $args, $profile_url );
}
// Filter & return
return apply_filters( 'bbp_get_subscriptions_permalink', $url, $user_id );
}
/**
* Output the link to subscribe/unsubscribe from a topic
*
* @since 2.0.0 bbPress (r2668)
* @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
*
* @param array $args See {@link bbp_get_user_subscribe_link()}
* @param int $user_id Optional. User id
* @param bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
*/
function bbp_user_subscribe_link( $args = array(), $user_id = 0, $wrap = true ) {
echo bbp_get_user_subscribe_link( $args, $user_id, $wrap );
}
/**
* Return the link to subscribe/unsubscribe from a forum or topic
*
* @since 2.0.0 bbPress (r2668)
* @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
*
* @param array $args This function supports these arguments:
* - subscribe: Subscribe text
* - unsubscribe: Unsubscribe text
* - user_id: User id
* - topic_id: Topic id
* - forum_id: Forum id
* - before: Before the link
* - after: After the link
* @param int $user_id Optional. User id
* @param bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
* @return string Permanent link to topic
*/
function bbp_get_user_subscribe_link( $args = array(), $user_id = 0, $wrap = true ) {
// Bail if subscriptions are inactive
if ( ! bbp_is_subscriptions_active() ) {
return;
}
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'subscribe' => esc_html__( 'Subscribe', 'bbpress' ),
'unsubscribe' => esc_html__( 'Unsubscribe', 'bbpress' ),
'user_id' => 0,
'object_id' => 0,
'object_type' => 'post',
'before' => '',
'after' => '',
'redirect_to' => '',
// Deprecated. Use object_id.
'forum_id' => 0,
'topic_id' => 0
), 'get_user_subscribe_link' );
// Validate user
$user_id = bbp_get_user_id( $r['user_id'], true, true );
$object_type = sanitize_key( $r['object_type'] );
// Back-compat for deprecated arguments
if ( ! empty( $r['topic_id'] ) ) {
$object_id = absint( $r['topic_id'] );
} elseif ( ! empty( $r['forum_id'] ) ) {
$object_id = absint( $r['forum_id'] );
} else {
$object_id = absint( $r['object_id'] );
}
// Bail if anything is missing
if ( empty( $user_id ) || empty( $object_id ) || empty( $object_type ) ) {
return false;
}
// No link if you can't edit yourself
if ( ! current_user_can( 'edit_user', $user_id ) ) {
return false;
}
// Decide which link to show
$is_subscribed = bbp_is_user_subscribed( $user_id, $object_id );
if ( ! empty( $is_subscribed ) ) {
$text = $r['unsubscribe'];
$q_args = array(
'action' => 'bbp_unsubscribe',
'object_id' => $object_id,
'object_type' => $object_type
);
} else {
$text = $r['subscribe'];
$q_args = array(
'action' => 'bbp_subscribe',
'object_id' => $object_id,
'object_type' => $object_type
);
}
// Custom redirect
if ( ! empty( $r['redirect_to'] ) ) {
$q_args['redirect_to'] = urlencode( $r['redirect_to'] );
}
// URL
$url = esc_url( wp_nonce_url( add_query_arg( $q_args ), 'toggle-subscription_' . $object_id ) );
$sub = $is_subscribed ? ' class="is-subscribed"' : '';
$html = sprintf( '%s<span id="subscribe-%d" %s><a href="%s" class="subscription-toggle" data-bbp-object-id="%d" data-bbp-object-type="%d" data-bbp-nonce="%s">%s</a></span>%s', $r['before'], $object_id, $sub, $url, $object_id, $object_type, wp_create_nonce( 'toggle-subscription_' . $object_id ), $text, $r['after'] );
// Initial output is wrapped in a span, ajax output is hooked to this
if ( ! empty( $wrap ) ) {
$html = '<span id="subscription-toggle">' . $html . '</span>';
}
// Filter & return
return apply_filters( 'bbp_get_user_subscribe_link', $html, $r, $user_id, $object_id );
}
/** Edit User *****************************************************************/
/**
* Display profile edit success notice on user edit page
*
* @since 2.0.0 bbPress (r2688)
*/
function bbp_notice_edit_user_success() {
// Bail if no updated argument
if ( empty( $_GET['updated'] ) ) {
return;
}
// Bail if not on users own profile
if ( ! bbp_is_single_user_edit() ) {
return;
} ?>
<div class="bbp-template-notice">
<ul>
<li><?php esc_html_e( 'User updated.', 'bbpress' ); ?></li>
</ul>
</div>
<?php
}
/**
* Display pending email change notice on user edit page
*
* @since 2.6.0 bbPress (r5660)
*/
function bbp_notice_edit_user_pending_email() {
// Bail if not on users own profile
if ( ! bbp_is_user_home_edit() ) {
return;
}
// Check for pending email address change
$user_id = bbp_get_displayed_user_id();
$key = '_new_email';
$new_email = get_user_meta( $user_id, $key, true );
// Bail if no pending email address change
if ( empty( $new_email['newemail'] ) ) {
return;
}
// Build the nonced URL to dismiss the pending change
$user_url = bbp_get_user_profile_edit_url( $user_id );
$nonce = "dismiss-{$user_id}{$key}";
$args = array(
'action' => 'bbp-update-user-email',
'dismiss' => "{$user_id}{$key}"
);
// Build the variables to pass into printf()
$dismiss_url = wp_nonce_url( add_query_arg( $args, $user_url ), $nonce );
$dismiss_link = '<a href="' . esc_url( $dismiss_url ) . '">' . esc_html_x( 'Cancel', 'Dismiss pending user email address change', 'bbpress' ) . '</a>';
$coded_email = '<code>' . esc_html( $new_email['newemail'] ) . '</code>'; ?>
<div class="bbp-template-notice info">
<ul>
<li><?php printf( esc_html__( 'There is a pending email address change to %1$s. %2$s', 'bbpress' ), $coded_email, $dismiss_link ); ?></li>
</ul>
</div>
<?php
}
/**
* Super admin privileges notice
*
* @since 2.0.0 bbPress (r2688)
*/
function bbp_notice_edit_user_is_super_admin() {
if ( is_multisite() && ( bbp_is_single_user() || bbp_is_single_user_edit() ) && current_user_can( 'manage_network_options' ) && is_super_admin( bbp_get_displayed_user_id() ) ) : ?>
<div class="bbp-template-notice important">
<ul>
<li><?php bbp_is_user_home() || bbp_is_user_home_edit() ? esc_html_e( 'You have super admin privileges.', 'bbpress' ) : esc_html_e( 'This user has super admin privileges.', 'bbpress' ); ?></li>
</ul>
</div>
<?php endif;
}
/**
* Drop down for selecting the user's display name
*
* @since 2.0.0 bbPress (r2688)
*/
function bbp_edit_user_display_name() {
$bbp = bbpress();
$public_display = array();
$public_display['display_username'] = $bbp->displayed_user->user_login;
if ( ! empty( $bbp->displayed_user->nickname ) ) {
$public_display['display_nickname'] = $bbp->displayed_user->nickname;
}
if ( ! empty( $bbp->displayed_user->first_name ) ) {
$public_display['display_firstname'] = $bbp->displayed_user->first_name;
}
if ( ! empty( $bbp->displayed_user->last_name ) ) {
$public_display['display_lastname'] = $bbp->displayed_user->last_name;
}
if ( ! empty( $bbp->displayed_user->first_name ) && ! empty( $bbp->displayed_user->last_name ) ) {
$public_display['display_firstlast'] = $bbp->displayed_user->first_name . ' ' . $bbp->displayed_user->last_name;
$public_display['display_lastfirst'] = $bbp->displayed_user->last_name . ' ' . $bbp->displayed_user->first_name;
}
// Only add this if it isn't duplicated elsewhere
if ( ! in_array( $bbp->displayed_user->display_name, $public_display, true ) ) {
$public_display = array( 'display_displayname' => $bbp->displayed_user->display_name ) + $public_display;
}
$public_display = array_map( 'trim', $public_display );
$public_display = array_unique( $public_display ); ?>
<select name="display_name" id="display_name">
<?php foreach ( $public_display as $id => $item ) : ?>
<option id="<?php echo $id; ?>" value="<?php echo esc_attr( $item ); ?>"<?php selected( $bbp->displayed_user->display_name, $item ); ?>><?php echo $item; ?></option>
<?php endforeach; ?>
</select>
<?php
}
/**
* Output blog role selector (for user edit)
*
* @since 2.0.0 bbPress (r2688)
*/
function bbp_edit_user_blog_role() {
// Bail if no user is being edited
if ( ! bbp_is_single_user_edit() ) {
return;
}
// Get users current blog role
$user_role = bbp_get_user_blog_role( bbp_get_displayed_user_id() );
// Get the blog roles
$blog_roles = bbp_get_blog_roles(); ?>
<select name="role" id="role">
<option value=""><?php esc_html_e( '— No role for this site —', 'bbpress' ); ?></option>
<?php foreach ( $blog_roles as $role => $details ) : ?>
<option <?php selected( $user_role, $role ); ?> value="<?php echo esc_attr( $role ); ?>"><?php echo bbp_translate_user_role( $details['name'] ); ?></option>
<?php endforeach; ?>
</select>
<?php
}
/**
* Output forum role selector (for user edit)
*
* @since 2.2.0 bbPress (r4284)
*/
function bbp_edit_user_forums_role() {
// Bail if no user is being edited
if ( ! bbp_is_single_user_edit() ) {
return;
}
// Get the user's current forum role
$user_role = bbp_get_user_role( bbp_get_displayed_user_id() );
// Get the folum roles
$dynamic_roles = bbp_get_dynamic_roles();
// Only keymasters can set other keymasters
if ( ! bbp_is_user_keymaster() ) {
unset( $dynamic_roles[ bbp_get_keymaster_role() ] );
} ?>
<select name="bbp-forums-role" id="bbp-forums-role">
<option value=""><?php esc_html_e( '— No role for these forums —', 'bbpress' ); ?></option>
<?php foreach ( $dynamic_roles as $role => $details ) : ?>
<option <?php selected( $user_role, $role ); ?> value="<?php echo esc_attr( $role ); ?>"><?php echo bbp_translate_user_role( $details['name'] ); ?></option>
<?php endforeach; ?>
</select>
<?php
}
/**
* Return user contact methods select box
*
* @since 2.0.0 bbPress (r2688)
* @return string User contact methods
*/
function bbp_edit_user_contact_methods() {
// Get the core WordPress contact methods
$contact_methods = wp_get_user_contact_methods( bbpress()->displayed_user );
// Filter & return
return (array) apply_filters( 'bbp_edit_user_contact_methods', $contact_methods );
}
/**
* Output the language chooser (for user edit)
*
* @since 2.6.0 bbPress (r6488)
*
* @param array $args See wp_dropdown_languages()
* @return string
*/
function bbp_edit_user_language( $args = array() ) {
// Bail if no user is being edited
if ( ! bbp_is_single_user_edit() ) {
return;
}
// Output the dropdown
bbp_user_languages_dropdown( $args );
}
/** Topics Created ************************************************************/
/**
* Output the link to the user's topics
*
* @since 2.2.0 bbPress (r4225)
*
* @param int $user_id Optional. User id
*/
function bbp_user_topics_created_url( $user_id = 0 ) {
echo esc_url( bbp_get_user_topics_created_url( $user_id ) );
}
/**
* Return the link to the user's topics
*
* @since 2.2.0 bbPress (r4225)
*
* @param int $user_id Optional. User id
* @return string Permanent link to user profile page
*/
function bbp_get_user_topics_created_url( $user_id = 0 ) {
// Use displayed user ID if there is one, and one isn't requested
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Bail if intercepted
$intercept = bbp_maybe_intercept( 'bbp_pre_get_user_topics_created_url', func_get_args() );
if ( bbp_is_intercepted( $intercept ) ) {
return $intercept;
}
// Get user profile URL
$profile_url = bbp_get_user_profile_url( $user_id );
// Pretty permalinks
if ( bbp_use_pretty_urls() ) {
$url = trailingslashit( $profile_url ) . bbp_get_topic_archive_slug();
$url = user_trailingslashit( $url );
// Unpretty permalinks
} else {
$url = add_query_arg( array(
bbp_get_user_topics_rewrite_id() => '1',
), $profile_url );
}
// Filter & return
return apply_filters( 'bbp_get_user_topics_created_url', $url, $user_id );
}
/** Replies Created ************************************************************/
/**
* Output the link to the user's replies
*
* @since 2.2.0 bbPress (r4225)
*
* @param int $user_id Optional. User id
*/
function bbp_user_replies_created_url( $user_id = 0 ) {
echo esc_url( bbp_get_user_replies_created_url( $user_id ) );
}
/**
* Return the link to the user's replies
*
* @since 2.2.0 bbPress (r4225)
*
* @param int $user_id Optional. User id
* @return string Permanent link to user profile page
*/
function bbp_get_user_replies_created_url( $user_id = 0 ) {
// Use displayed user ID if there is one, and one isn't requested
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Bail if intercepted
$intercept = bbp_maybe_intercept( 'bbp_pre_get_user_replies_created_url', func_get_args() );
if ( bbp_is_intercepted( $intercept ) ) {
return $intercept;
}
// Get user profile URL
$profile_url = bbp_get_user_profile_url( $user_id );
// Pretty permalinks
if ( bbp_use_pretty_urls() ) {
$url = trailingslashit( $profile_url ) . bbp_get_reply_archive_slug();
$url = user_trailingslashit( $url );
// Unpretty permalinks
} else {
$url = add_query_arg( array(
bbp_get_user_replies_rewrite_id() => '1',
), $profile_url );
}
// Filter & return
return apply_filters( 'bbp_get_user_replies_created_url', $url, $user_id );
}
/** Engagements ***************************************************************/
/**
* Output the link to the user's engagements
*
* @since 2.6.0 bbPress (r6320)
*
* @param int $user_id Optional. User id
*/
function bbp_user_engagements_url( $user_id = 0 ) {
echo esc_url( bbp_get_user_engagements_url( $user_id ) );
}
/**
* Return the link to the user's engagements
*
* @since 2.6.0 bbPress (r6320)
*
* @param int $user_id Optional. User id
* @return string Permanent link to user profile page
*/
function bbp_get_user_engagements_url( $user_id = 0 ) {
// Use displayed user ID if there is one, and one isn't requested
$user_id = bbp_get_user_id( $user_id );
if ( empty( $user_id ) ) {
return false;
}
// Bail if intercepted
$intercept = bbp_maybe_intercept( 'bbp_pre_get_user_engagements_url', func_get_args() );
if ( bbp_is_intercepted( $intercept ) ) {
return $intercept;
}
// Get user profile URL
$profile_url = bbp_get_user_profile_url( $user_id );
// Pretty permalinks
if ( bbp_use_pretty_urls() ) {
$url = trailingslashit( $profile_url ) . bbp_get_user_engagements_slug();
$url = user_trailingslashit( $url );
// Unpretty permalinks
} else {
$url = add_query_arg( array(
bbp_get_user_engagements_rewrite_id() => '1',
), $profile_url );
}
// Filter & return
return apply_filters( 'bbp_get_user_engagements_url', $url, $user_id );
}
/** Language ******************************************************************/
/**
* Output the select element used to save a user's language
*
* @since 2.6.0 bbPress (r6488)
*
* @param array $args See wp_dropdown_languages()
*/
function bbp_user_languages_dropdown( $args = array() ) {
echo bbp_get_user_languages_dropdown( $args );
}
/**
* Return the select element used to save a user's language.
*
* @since 2.6.0 bbPress (r6488)
*
* @param array $args See wp_dropdown_languages()
* @return string
*/
function bbp_get_user_languages_dropdown( $args = array() ) {
// Get user language
$user_id = ! empty( $args['user_id'] )
? bbp_get_user_id( $args['user_id'], false, false )
: bbp_get_displayed_user_id();
// Get user locale
$user_locale = ! empty( $user_id )
? get_userdata( $user_id )->locale
: 'site-default';
// Get all languages
$languages = get_available_languages();
// No locale for English
if ( 'en_US' === $user_locale ) {
$user_locale = '';
// Fallback to site-default if there is a mismatch
} elseif ( '' === $user_locale || ! in_array( $user_locale, $languages, true ) ) {
$user_locale = 'site-default';
}
// Don't pass user ID in
unset( $args['user_id'] );
// Parse arguments
$r = bbp_parse_args( $args, array(
'name' => 'locale',
'id' => 'locale',
'selected' => $user_locale,
'languages' => $languages,
'echo' => false,
'show_available_translations' => false,
'show_option_site_default' => true
), 'user_languages_dropdown' );
// Get the markup for the languages drop-down
$retval = wp_dropdown_languages( $r );
// Filter & return
return apply_filters( 'bbp_get_user_languages_dropdown', $retval, $r, $args );
}
/** Login *********************************************************************/
/**
* Handle the login and registration template notices
*
* @since 2.0.0 bbPress (r2970)
*/
function bbp_login_notices() {
// loggedout was passed
if ( ! empty( $_GET['loggedout'] ) && ( true === $_GET['loggedout'] ) ) {
bbp_add_error( 'loggedout', esc_html__( 'You are now logged out.', 'bbpress' ), 'message' );
// registration is disabled
} elseif ( ! empty( $_GET['registration'] ) && ( 'disabled' === $_GET['registration'] ) ) {
bbp_add_error( 'registerdisabled', esc_html__( 'New user registration is currently not allowed.', 'bbpress' ) );
// Prompt user to check their email
} elseif ( ! empty( $_GET['checkemail'] ) && in_array( $_GET['checkemail'], array( 'confirm', 'newpass', 'registered' ), true ) ) {
switch ( $_GET['checkemail'] ) {
// Email needs confirmation
case 'confirm' :
bbp_add_error( 'confirm', esc_html__( 'Check your e-mail for the confirmation link.', 'bbpress' ), 'message' );
break;
// User requested a new password
case 'newpass' :
bbp_add_error( 'newpass', esc_html__( 'Check your e-mail for your new password.', 'bbpress' ), 'message' );
break;
// User is newly registered
case 'registered' :
bbp_add_error( 'registered', esc_html__( 'Registration complete. Please check your e-mail.', 'bbpress' ), 'message' );
break;
}
}
}
/**
* Redirect a user back to their profile if they are already logged in.
*
* This should be used before {@link get_header()} is called in template files
* where the user should never have access to the contents of that file.
*
* @since 2.0.0 bbPress (r2815)
*
* @param string $url The URL to redirect to
*/
function bbp_logged_in_redirect( $url = '' ) {
// Bail if user is not logged in
if ( ! is_user_logged_in() ) {
return;
}
// Setup the profile page to redirect to
$redirect_to = ! empty( $url ) ? $url : bbp_get_user_profile_url( bbp_get_current_user_id() );
// Do a safe redirect
bbp_redirect( $redirect_to );
}
/**
* Output the required hidden fields when logging in
*
* @since 2.0.0 bbPress (r2815)
*/
function bbp_user_login_fields() {
?>
<input type="hidden" name="user-cookie" value="1" />
<?php
// Allow custom login redirection
$redirect_to = apply_filters( 'bbp_user_login_redirect_to', '' );
bbp_redirect_to_field( $redirect_to );
// Prevent intention hi-jacking of log-in form
wp_nonce_field( 'bbp-user-login' );
}
/** Register ******************************************************************/
/**
* Output the required hidden fields when registering
*
* @since 2.0.0 bbPress (r2815)
*/
function bbp_user_register_fields() {
?>
<input type="hidden" name="action" value="register" />
<input type="hidden" name="user-cookie" value="1" />
<?php
// Allow custom registration redirection
$redirect_to = apply_filters( 'bbp_user_register_redirect_to', '' );
bbp_redirect_to_field( add_query_arg( array( 'checkemail' => 'registered' ), $redirect_to ) );
// Prevent intention hi-jacking of sign-up form
wp_nonce_field( 'bbp-user-register' );
}
/** Lost Password *************************************************************/
/**
* Output the required hidden fields when user lost password
*
* @since 2.0.0 bbPress (r2815)
*/
function bbp_user_lost_pass_fields() {
?>
<input type="hidden" name="user-cookie" value="1" />
<?php
// Allow custom lost pass redirection
$redirect_to = apply_filters( 'bbp_user_lost_pass_redirect_to', get_permalink() );
bbp_redirect_to_field( add_query_arg( array( 'checkemail' => 'confirm' ), $redirect_to ) );
// Prevent intention hi-jacking of lost pass form
wp_nonce_field( 'bbp-user-lost-pass' );
}
/** Author Avatar *************************************************************/
/**
* Output the author link of a post
*
* @since 2.0.0 bbPress (r2875)
*
* @param array $args Optional. If it is an integer, it is used as post id.
*/
function bbp_author_link( $args = array() ) {
echo bbp_get_author_link( $args );
}
/**
* Return the author link of the post
*
* @since 2.0.0 bbPress (r2875)
*
* @param array $args Optional. If an integer, it is used as reply id.
* @return string Author link of reply
*/
function bbp_get_author_link( $args = array() ) {
$post_id = is_numeric( $args ) ? (int) $args : 0;
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'post_id' => $post_id,
'link_title' => '',
'type' => 'both',
'size' => 80,
'sep' => ''
), 'get_author_link' );
// Confirmed topic
if ( bbp_is_topic( $r['post_id'] ) ) {
return bbp_get_topic_author_link( $r );
// Confirmed reply
} elseif ( bbp_is_reply( $r['post_id'] ) ) {
return bbp_get_reply_author_link( $r );
}
// Default return value
$author_link = '';
// Neither a reply nor a topic, so could be a revision
if ( ! empty( $r['post_id'] ) ) {
// Get some useful reply information
$user_id = get_post_field( 'post_author', $r['post_id'] );
$author_url = bbp_get_user_profile_url( $user_id );
$anonymous = bbp_is_reply_anonymous( $r['post_id'] );
// Generate title with the display name of the author
if ( empty( $r['link_title'] ) ) {
$author = get_the_author_meta( 'display_name', $user_id );
$title = empty( $anonymous )
? esc_attr__( "View %s's profile", 'bbpress' )
: esc_attr__( "Visit %s's website", 'bbpress' );
$r['link_title'] = sprintf( $title, $author );
}
// Setup title and author_links array
$author_links = array();
$link_title = ! empty( $r['link_title'] )
? ' title="' . esc_attr( $r['link_title'] ) . '"'
: '';
// Get avatar (unescaped, because HTML)
if ( ( 'avatar' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
$author_links['avatar'] = get_avatar( $user_id, $r['size'] );
}
// Get display name (escaped, because never HTML)
if ( ( 'name' === $r['type'] ) || ( 'both' === $r['type'] ) ) {
$author_links['name'] = esc_html( get_the_author_meta( 'display_name', $user_id ) );
}
// Empty array
$links = array();
$sprint = '<span %1$s>%2$s</span>';
// Wrap each link
foreach ( $author_links as $link => $link_text ) {
$link_class = ' class="bbp-author-' . esc_attr( $link ) . '"';
$links[] = sprintf( $sprint, $link_class, $link_text );
}
// Juggle
$author_links = $links;
unset( $links );
// Filter sections
$sections = apply_filters( 'bbp_get_author_links', $author_links, $r, $args );
// Assemble sections into author link
$author_link = implode( $r['sep'], $sections );
// Only wrap in link if profile exists
if ( empty( $anonymous ) && bbp_user_has_profile( $user_id ) ) {
$author_link = sprintf( '<a href="%1$s"%2$s%3$s>%4$s</a>', esc_url( $author_url ), $link_title, ' class="bbp-author-link"', $author_link );
}
}
// Filter & return
return apply_filters( 'bbp_get_author_link', $author_link, $r, $args );
}
/** Capabilities **************************************************************/
/**
* Check if the user can access a specific forum
*
* @since 2.0.0 bbPress (r3127)
*
* @return bool
*/
function bbp_user_can_view_forum( $args = array() ) {
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'user_id' => bbp_get_current_user_id(),
'forum_id' => bbp_get_forum_id(),
'check_ancestors' => false
), 'user_can_view_forum' );
// Validate parsed values
$user_id = bbp_get_user_id( $r['user_id'], false, false );
$forum_id = bbp_get_forum_id( $r['forum_id'] );
$retval = false;
// User is a keymaster
if ( ! empty( $user_id ) && bbp_is_user_keymaster( $user_id ) ) {
$retval = true;
// Forum is public, and user can read forums or is not logged in
} elseif ( bbp_is_forum_public( $forum_id, $r['check_ancestors'] ) ) {
$retval = true;
// Forum is private, and user can see it
} elseif ( bbp_is_forum_private( $forum_id, $r['check_ancestors'] ) && user_can( $user_id, 'read_forum', $forum_id ) ) {
$retval = true;
// Forum is hidden, and user can see it
} elseif ( bbp_is_forum_hidden( $forum_id, $r['check_ancestors'] ) && user_can( $user_id, 'read_forum', $forum_id ) ) {
$retval = true;
}
// Filter & return
return apply_filters( 'bbp_user_can_view_forum', $retval, $forum_id, $user_id );
}
/**
* Check if the current user can publish topics
*
* @since 2.0.0 bbPress (r3127)
*
* @return bool
*/
function bbp_current_user_can_publish_topics() {
// Users need to earn access
$retval = false;
// Always allow keymasters
if ( bbp_is_user_keymaster() ) {
$retval = true;
// Do not allow anonymous if not enabled
} elseif ( ! is_user_logged_in() && bbp_allow_anonymous() ) {
$retval = true;
// User is logged in
} elseif ( current_user_can( 'publish_topics' ) ) {
$retval = true;
}
// Filter & return
return (bool) apply_filters( 'bbp_current_user_can_publish_topics', $retval );
}
/**
* Check if the current user can publish forums
*
* @since 2.1.0 bbPress (r3549)
*
* @return bool
*/
function bbp_current_user_can_publish_forums() {
// Users need to earn access
$retval = false;
// Always allow keymasters
if ( bbp_is_user_keymaster() ) {
$retval = true;
// User is logged in
} elseif ( current_user_can( 'publish_forums' ) ) {
$retval = true;
}
// Filter & return
return (bool) apply_filters( 'bbp_current_user_can_publish_forums', $retval );
}
/**
* Check if the current user can publish replies
*
* @since 2.0.0 bbPress (r3127)
*
* @return bool
*/
function bbp_current_user_can_publish_replies() {
// Users need to earn access
$retval = false;
// Always allow keymasters
if ( bbp_is_user_keymaster() ) {
$retval = true;
// Do not allow anonymous if not enabled
} elseif ( ! is_user_logged_in() && bbp_allow_anonymous() ) {
$retval = true;
// User is logged in
} elseif ( current_user_can( 'publish_replies' ) ) {
$retval = true;
}
// Filter & return
return (bool) apply_filters( 'bbp_current_user_can_publish_replies', $retval );
}
/** Forms *********************************************************************/
/**
* The following functions should be turned into mapped meta capabilities in a
* future version. They exist only to remove complex logistical capability
* checks from within template parts.
*/
/**
* Get the forums the current user has the ability to see and post to
*
* @since 2.0.0 bbPress (r3127)
*
* @param array $args
*
* @return array
*/
function bbp_get_forums_for_current_user( $args = array() ) {
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'post_type' => bbp_get_forum_post_type(),
'post_status' => bbp_get_public_status_id(),
'post__not_in' => bbp_exclude_forum_ids( 'array' ),
'numberposts' => -1
), 'get_forums_for_current_user' );
// Get the forums
$forums = get_posts( $r );
// No availabe forums
if ( empty( $forums ) ) {
$forums = false;
}
// Filter & return
return apply_filters( 'bbp_get_forums_for_current_user', $forums, $r, $args );
}
/**
* Performs a series of checks to ensure the current user can create forums.
*
* @since 2.1.0 bbPress (r3549)
*
* @return bool
*/
function bbp_current_user_can_access_create_forum_form() {
// Users need to earn access
$retval = false;
// Always allow keymasters
if ( bbp_is_user_keymaster() ) {
$retval = true;
// Looking at a single forum & forum is open
} elseif ( ( is_page() || is_single() ) && bbp_is_forum_open() ) {
$retval = bbp_current_user_can_publish_forums();
// User can edit this forum
} else {
$retval = current_user_can( 'edit_forum', bbp_get_forum_id() );
}
// Filter & return
return (bool) apply_filters( 'bbp_current_user_can_access_create_forum_form', (bool) $retval );
}
/**
* Performs a series of checks to ensure the current user can create topics.
*
* @since 2.0.0 bbPress (r3127)
*
* @return bool
*/
function bbp_current_user_can_access_create_topic_form() {
// Users need to earn access
$retval = false;
// Always allow keymasters
if ( bbp_is_user_keymaster() ) {
$retval = true;
// Looking at a single forum & forum is open
} elseif ( ( bbp_is_single_forum() || is_page() || is_single() ) && bbp_is_forum_open() ) {
$retval = bbp_current_user_can_publish_topics();
// User can edit this topic
} else {
$retval = current_user_can( 'edit_topic', bbp_get_topic_id() );
}
// Filter & return
return (bool) apply_filters( 'bbp_current_user_can_access_create_topic_form', (bool) $retval );
}
/**
* Performs a series of checks to ensure the current user can create replies.
*
* @since 2.0.0 bbPress (r3127)
*
* @return bool
*/
function bbp_current_user_can_access_create_reply_form() {
// Users need to earn access
$retval = false;
// Always allow keymasters
if ( bbp_is_user_keymaster() ) {
$retval = true;
// Looking at a single topic, topic is open, and forum is open
} elseif ( ( bbp_is_single_topic() || is_page() || is_single() ) && bbp_is_topic_open() && bbp_is_forum_open() && bbp_is_topic_published() ) {
$retval = bbp_current_user_can_publish_replies();
// User can edit this reply
} elseif ( bbp_get_reply_id() ) {
$retval = current_user_can( 'edit_reply', bbp_get_reply_id() );
// User can edit this topic
} elseif ( bbp_get_topic_id() ) {
$retval = current_user_can( 'edit_topic', bbp_get_topic_id() );
}
// Filter & return
return (bool) apply_filters( 'bbp_current_user_can_access_create_reply_form', (bool) $retval );
}
/**
* Performs a series of checks to ensure the current user should see the
* anonymous user form fields.
*
* @since 2.5.0 bbPress (r5119)
*
* @return bool
*/
function bbp_current_user_can_access_anonymous_user_form() {
// Users need to earn access
$retval = false;
// User is not logged in, and anonymous posting is allowed
if ( bbp_is_anonymous() ) {
$retval = true;
// User is editing a topic, and topic is authored by anonymous user
} elseif ( bbp_is_topic_edit() && bbp_is_topic_anonymous() ) {
$retval = true;
// User is editing a reply, and reply is authored by anonymous user
} elseif ( bbp_is_reply_edit() && bbp_is_reply_anonymous() ) {
$retval = true;
}
// Filter & return
return (bool) apply_filters( 'bbp_current_user_can_access_anonymous_user_form', (bool) $retval );
}
/** Moderators ****************************************************************/
/**
* Output the moderators of a forum
*
* @since 2.6.0 bbPress
*
* @param int $forum_id Optional. Topic id
* @param array $args See {@link bbp_get_moderator_list()}
*/
function bbp_moderator_list( $forum_id = 0, $args = array() ) {
echo bbp_get_moderator_list( $forum_id, $args );
}
/**
* Return the moderators for an object
*
* @since 2.6.0 bbPress
*
* @param int $object_id Optional. Object id
* @param array $args This function supports these arguments:
* - before: Before the tag list
* - sep: Tag separator
* - after: After the tag list
*
* @return string Moderator list of the object
*/
function bbp_get_moderator_list( $object_id = 0, $args = array() ) {
// Parse arguments against default values
$r = bbp_parse_args( $args, array(
'before' => '<div class="bbp-moderators"><p>' . esc_html__( 'Moderators:', 'bbpress' ) . ' ',
'sep' => ', ',
'after' => '</p></div>',
'none' => ''
), 'get_moderator_list' );
// Get forum moderators
$user_ids = bbp_get_moderator_ids( $object_id );
if ( ! empty( $user_ids ) ) {
// In admin, use nicenames
if ( is_admin() ) {
$users = bbp_get_user_nicenames_from_ids( $user_ids );
// In theme, use display names & profile links
} else {
foreach ( $user_ids as $user_id ) {
$users[] = bbp_get_user_profile_link( $user_id );
}
}
$retval = $r['before'] . implode( $r['sep'], $users ) . $r['after'];
// No forum moderators
} else {
$retval = $r['none'];
}
// Filter & return
return apply_filters( 'bbp_get_moderator_list', $retval );
}