reply_post_type ); } /** * Return array of labels used by the reply post type * * @since 2.5.0 bbPress (r5129) * * @return array */ function bbp_get_reply_post_type_labels() { // Filter & return return (array) apply_filters( 'bbp_get_reply_post_type_labels', array( 'name' => esc_attr__( 'Replies', 'bbpress' ), 'menu_name' => esc_attr__( 'Replies', 'bbpress' ), 'singular_name' => esc_attr_x( 'Reply', 'noun', 'bbpress' ), 'all_items' => esc_attr__( 'All Replies', 'bbpress' ), 'add_new' => esc_attr__( 'Add New', 'bbpress' ), 'add_new_item' => esc_attr__( 'Create New Reply', 'bbpress' ), 'edit' => esc_attr__( 'Edit', 'bbpress' ), 'edit_item' => esc_attr__( 'Edit Reply', 'bbpress' ), 'new_item' => esc_attr__( 'New Reply', 'bbpress' ), 'view' => esc_attr__( 'View Reply', 'bbpress' ), 'view_item' => esc_attr__( 'View Reply', 'bbpress' ), 'view_items' => esc_attr__( 'View Replies', 'bbpress' ), 'search_items' => esc_attr__( 'Search Replies', 'bbpress' ), 'not_found' => esc_attr__( 'No replies found', 'bbpress' ), 'not_found_in_trash' => esc_attr__( 'No replies found in Trash', 'bbpress' ), 'filter_items_list' => esc_attr__( 'Filter replies list', 'bbpress' ), 'items_list' => esc_attr__( 'Replies list', 'bbpress' ), 'items_list_navigation' => esc_attr__( 'Replies list navigation', 'bbpress' ), 'parent_item_colon' => esc_attr__( 'Parent Topic:', 'bbpress' ), 'archives' => esc_attr__( 'Forum Replies', 'bbpress' ), 'attributes' => esc_attr__( 'Reply Attributes', 'bbpress' ), 'insert_into_item' => esc_attr__( 'Insert into reply', 'bbpress' ), 'uploaded_to_this_item' => esc_attr__( 'Uploaded to this reply', 'bbpress' ), 'featured_image' => esc_attr__( 'Reply Image', 'bbpress' ), 'set_featured_image' => esc_attr__( 'Set reply image', 'bbpress' ), 'remove_featured_image' => esc_attr__( 'Remove reply image', 'bbpress' ), 'use_featured_image' => esc_attr__( 'Use as reply image', 'bbpress' ), 'item_published' => esc_attr__( 'Reply published.', 'bbpress' ), 'item_published_privately' => esc_attr__( 'Reply published privately.', 'bbpress' ), 'item_reverted_to_draft' => esc_attr__( 'Reply reverted to draft.', 'bbpress' ), 'item_scheduled' => esc_attr__( 'Reply scheduled.', 'bbpress' ), 'item_updated' => esc_attr__( 'Reply updated.', 'bbpress' ) ) ); } /** * Return array of reply post type rewrite settings * * @since 2.5.0 bbPress (r5129) * * @return array */ function bbp_get_reply_post_type_rewrite() { // Filter & return return (array) apply_filters( 'bbp_get_reply_post_type_rewrite', array( 'slug' => bbp_get_reply_slug(), 'with_front' => false ) ); } /** * Return array of features the reply post type supports * * @since 2.5.0 bbPress (r5129) * * @return array */ function bbp_get_reply_post_type_supports() { // Filter & return return (array) apply_filters( 'bbp_get_reply_post_type_supports', array( 'title', 'editor', 'revisions' ) ); } /** Reply Loop Functions ******************************************************/ /** * The main reply loop. WordPress makes this easy for us * * @since 2.0.0 bbPress (r2553) * * @param array $args All the arguments supported by {@link WP_Query} * @return object Multidimensional array of reply information */ function bbp_has_replies( $args = array() ) { /** Defaults **************************************************************/ // Other defaults $default_reply_search = bbp_sanitize_search_request( 'rs' ); $default_post_parent = ( bbp_is_single_topic() ) ? bbp_get_topic_id() : 'any'; $default_post_type = ( bbp_is_single_topic() && bbp_show_lead_topic() ) ? bbp_get_reply_post_type() : array( bbp_get_topic_post_type(), bbp_get_reply_post_type() ); $default_thread_replies = (bool) ( bbp_is_single_topic() && bbp_thread_replies() ); // Default query args $default = array( 'post_type' => $default_post_type, // Only replies 'post_parent' => $default_post_parent, // Of this topic 'posts_per_page' => bbp_get_replies_per_page(), // This many 'paged' => bbp_get_paged(), // On this page 'orderby' => 'date', // Sorted by date 'order' => 'ASC', // Oldest to newest 'hierarchical' => $default_thread_replies, // Hierarchical replies 'ignore_sticky_posts' => true, // Stickies not supported 'update_post_term_cache' => false, // No terms to cache // Conditionally prime the cache for all related posts 'update_post_family_cache' => true ); // Only add 's' arg if searching for replies // See https://bbpress.trac.wordpress.org/ticket/2607 if ( ! empty( $default_reply_search ) ) { $default['s'] = $default_reply_search; } // What are the default allowed statuses (based on user caps) if ( bbp_get_view_all( 'edit_others_replies' ) ) { // Default view=all statuses $post_statuses = array_keys( bbp_get_topic_statuses() ); // Add support for private status if ( current_user_can( 'read_private_replies' ) ) { $post_statuses[] = bbp_get_private_status_id(); } // Join post statuses together $default['post_status'] = $post_statuses; // Lean on the 'perm' query var value of 'readable' to provide statuses } else { $default['perm'] = 'readable'; } /** Setup *****************************************************************/ // Parse arguments against default values $r = bbp_parse_args( $args, $default, 'has_replies' ); // Set posts_per_page value if replies are threaded $replies_per_page = (int) $r['posts_per_page']; if ( true === $r['hierarchical'] ) { $r['posts_per_page'] = -1; } // Get bbPress $bbp = bbpress(); // Call the query $bbp->reply_query = new WP_Query( $r ); // Maybe prime the post author caches if ( ! empty( $r['update_post_family_cache'] ) ) { bbp_update_post_family_caches( $bbp->reply_query->posts ); } // Add pagination values to query object $bbp->reply_query->posts_per_page = (int) $replies_per_page; $bbp->reply_query->paged = (int) $r['paged']; // Never home, regardless of what parse_query says $bbp->reply_query->is_home = false; // Reset is_single if single topic if ( bbp_is_single_topic() ) { $bbp->reply_query->is_single = true; } // Only add reply to if query returned results if ( ! empty( $bbp->reply_query->found_posts ) ) { // Get reply to for each reply foreach ( $bbp->reply_query->posts as &$post ) { // Check for reply post type if ( bbp_get_reply_post_type() === $post->post_type ) { $reply_to = bbp_get_reply_to( $post->ID ); // Make sure it's a reply to a reply if ( empty( $reply_to ) || ( bbp_get_reply_topic_id( $post->ID ) === $reply_to ) ) { $reply_to = 0; } // Add reply_to to the post object so we can walk it later $post->reply_to = $reply_to; } } } // Only add pagination if query returned results if ( ! empty( $bbp->reply_query->found_posts ) && ! empty( $bbp->reply_query->posts_per_page ) ) { // Figure out total pages if ( true === $r['hierarchical'] ) { $walker = new BBP_Walker_Reply(); $total_pages = ceil( $walker->get_number_of_root_elements( $bbp->reply_query->posts ) / $bbp->reply_query->posts_per_page ); } else { // Total for pagination boundaries $total_pages = ( $bbp->reply_query->posts_per_page === $bbp->reply_query->found_posts ) ? 1 : ceil( $bbp->reply_query->found_posts / $bbp->reply_query->posts_per_page ); // Pagination settings with filter $bbp_replies_pagination = apply_filters( 'bbp_replies_pagination', array( 'base' => bbp_get_replies_pagination_base( bbp_get_topic_id() ), 'total' => $total_pages, 'current' => $bbp->reply_query->paged ) ); // Add pagination to query object $bbp->reply_query->pagination_links = bbp_paginate_links( $bbp_replies_pagination ); } } // Filter & return return apply_filters( 'bbp_has_replies', $bbp->reply_query->have_posts(), $bbp->reply_query ); } /** * Whether there are more replies available in the loop * * @since 2.0.0 bbPress (r2553) * * @return object Replies information */ function bbp_replies() { // Put into variable to check against next $have_posts = bbpress()->reply_query->have_posts(); // Reset the post data when finished if ( empty( $have_posts ) ) { wp_reset_postdata(); } return $have_posts; } /** * Loads up the current reply in the loop * * @since 2.0.0 bbPress (r2553) * * @return object Reply information */ function bbp_the_reply() { return bbpress()->reply_query->the_post(); } /** * Output reply id * * @since 2.0.0 bbPress (r2553) * * @param $reply_id Optional. Used to check emptiness */ function bbp_reply_id( $reply_id = 0 ) { echo bbp_get_reply_id( $reply_id ); } /** * Return the id of the reply in a replies loop * * @since 2.0.0 bbPress (r2553) * * @param $reply_id Optional. Used to check emptiness * @return int The reply id */ function bbp_get_reply_id( $reply_id = 0 ) { $bbp = bbpress(); $wp_query = bbp_get_wp_query(); // Easy empty checking if ( ! empty( $reply_id ) && is_numeric( $reply_id ) ) { $bbp_reply_id = $reply_id; // Currently inside a replies loop } elseif ( ! empty( $bbp->reply_query->in_the_loop ) && isset( $bbp->reply_query->post->ID ) ) { $bbp_reply_id = $bbp->reply_query->post->ID; // Currently inside a search loop } elseif ( ! empty( $bbp->search_query->in_the_loop ) && isset( $bbp->search_query->post->ID ) && bbp_is_reply( $bbp->search_query->post->ID ) ) { $bbp_reply_id = $bbp->search_query->post->ID; // Currently viewing a forum } elseif ( ( bbp_is_single_reply() || bbp_is_reply_edit() ) && ! empty( $bbp->current_reply_id ) ) { $bbp_reply_id = $bbp->current_reply_id; // Currently viewing a reply } elseif ( ( bbp_is_single_reply() || bbp_is_reply_edit() ) && isset( $wp_query->post->ID ) ) { $bbp_reply_id = $wp_query->post->ID; // Fallback } else { $bbp_reply_id = 0; } // Filter & return return (int) apply_filters( 'bbp_get_reply_id', $bbp_reply_id, $reply_id ); } /** * Gets a reply * * @since 2.0.0 bbPress (r2787) * * @param int|object $reply reply id or reply object * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT * @param string $filter Optional Sanitation filter. See {@link sanitize_post()} * @return mixed Null if error or reply (in specified form) if success */ function bbp_get_reply( $reply, $output = OBJECT, $filter = 'raw' ) { // Maybe get ID from empty or int if ( empty( $reply ) || is_numeric( $reply ) ) { $reply = bbp_get_reply_id( $reply ); } // Bail if no post object $reply = get_post( $reply, OBJECT, $filter ); if ( empty( $reply ) ) { return $reply; } // Bail if not correct post type if ( $reply->post_type !== bbp_get_reply_post_type() ) { return null; } // Default return value is OBJECT $retval = $reply; // Array A if ( $output === ARRAY_A ) { $retval = get_object_vars( $reply ); // Array N } elseif ( $output === ARRAY_N ) { $retval = array_values( get_object_vars( $reply ) ); } // Filter & return return apply_filters( 'bbp_get_reply', $retval, $reply, $output, $filter ); } /** * Output the link to the reply in the reply loop * * @since 2.0.0 bbPress (r2553) * * @param int $reply_id Optional. Reply id */ function bbp_reply_permalink( $reply_id = 0 ) { echo esc_url( bbp_get_reply_permalink( $reply_id ) ); } /** * Return the link to the reply * * @since 2.0.0 bbPress (r2553) * * @param int $reply_id Optional. Reply id * * @return string Permanent link to reply */ function bbp_get_reply_permalink( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); // Filter & return return apply_filters( 'bbp_get_reply_permalink', get_permalink( $reply_id ), $reply_id ); } /** * Output the paginated url to the reply in the reply loop * * @since 2.0.0 bbPress (r2679) * * @param int $reply_id Optional. Reply id */ function bbp_reply_url( $reply_id = 0 ) { echo esc_url( bbp_get_reply_url( $reply_id ) ); } /** * Return the paginated url to the reply in the reply loop * * @since 2.0.0 bbPress (r2679) * * @param int $reply_id Optional. Reply id * @param string $redirect_to Optional. Pass a redirect value for use with * shortcodes and other fun things. * @return string Link to reply relative to paginated topic */ function bbp_get_reply_url( $reply_id = 0, $redirect_to = '' ) { // Set needed variables $reply_id = bbp_get_reply_id( $reply_id ); $topic_id = 0; // Juggle reply & topic IDs for unpretty URL formatting if ( bbp_is_reply( $reply_id ) ) { $topic_id = bbp_get_reply_topic_id( $reply_id ); $topic = bbp_get_topic( $topic_id ); } elseif ( bbp_is_topic( $reply_id ) ) { $topic_id = bbp_get_topic_id( $reply_id ); $topic = bbp_get_topic( $topic_id ); $reply_id = $topic_id; } // Hierarchical reply page if ( bbp_thread_replies() ) { $reply_page = 1; // Standard reply page } else { $reply_page = ceil( (int) bbp_get_reply_position( $reply_id, $topic_id ) / (int) bbp_get_replies_per_page() ); } // Get links & URLS $reply_hash = '#post-' . $reply_id; $topic_link = bbp_get_topic_permalink( $topic_id, $redirect_to ); $topic_url = remove_query_arg( 'view', $topic_link ); // Get vars needed to support pending topics with unpretty links $has_slug = ! empty( $topic ) ? $topic->post_name : ''; $pretty = bbp_use_pretty_urls(); $published = bbp_is_topic_public( $topic_id ); // Don't include pagination if on first page if ( 1 >= $reply_page ) { // Pretty permalinks if ( ! empty( $has_slug ) && ! empty( $pretty ) && ! empty( $published ) ) { $url = user_trailingslashit( $topic_url ) . $reply_hash; // Unpretty links } else { $url = $topic_url . $reply_hash; } // Include pagination } else { // Pretty permalinks if ( ! empty( $has_slug ) && ! empty( $pretty ) && ! empty( $published ) ) { $url = trailingslashit( $topic_url ) . trailingslashit( bbp_get_paged_slug() ) . $reply_page; $url = user_trailingslashit( $url ) . $reply_hash; // Unpretty links } else { $url = add_query_arg( 'paged', $reply_page, $topic_url ) . $reply_hash; } } // Add topic view query arg back to end if it is set if ( bbp_get_view_all() ) { $url = bbp_add_view_all( $url ); } // Filter & return return apply_filters( 'bbp_get_reply_url', $url, $reply_id, $redirect_to ); } /** * Output the title of the reply * * @since 2.0.0 bbPress (r2553) * * @param int $reply_id Optional. Reply id */ function bbp_reply_title( $reply_id = 0 ) { echo bbp_get_reply_title( $reply_id ); } /** * Return the title of the reply * * @since 2.0.0 bbPress (r2553) * * @param int $reply_id Optional. Reply id * @return string Title of reply */ function bbp_get_reply_title( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $title = get_the_title( $reply_id ); // Filter & return return apply_filters( 'bbp_get_reply_title', $title, $reply_id ); } /** * Get empty reply title fallback. * * @since 2.5.0 bbPress (r5177) * * @param string $post_title Required. Reply Title * @param int $post_id Required. Reply ID * @return string Title of reply */ function bbp_get_reply_title_fallback( $post_title = '', $post_id = 0 ) { // Bail if title not empty, or post is not a reply if ( ! empty( $post_title ) || ! bbp_is_reply( $post_id ) ) { return $post_title; } // Get reply topic title. $topic_title = bbp_get_reply_topic_title( $post_id ); // Get empty reply title fallback. $reply_title = sprintf( esc_html__( 'Reply To: %s', 'bbpress' ), $topic_title ); // Filter & return return apply_filters( 'bbp_get_reply_title_fallback', $reply_title, $post_id, $topic_title ); } /** * Output the content of the reply * * @since 2.0.0 bbPress (r2553) * * @param int $reply_id Optional. reply id */ function bbp_reply_content( $reply_id = 0 ) { echo bbp_get_reply_content( $reply_id ); } /** * Return the content of the reply * * @since 2.0.0 bbPress (r2780) * * @param int $reply_id Optional. reply id * @return string Content of the reply */ function bbp_get_reply_content( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); // Check if password is required if ( post_password_required( $reply_id ) ) { return get_the_password_form(); } $content = get_post_field( 'post_content', $reply_id ); // Filter & return return apply_filters( 'bbp_get_reply_content', $content, $reply_id ); } /** * Output the excerpt of the reply * * @since 2.0.0 bbPress (r2751) * * @param int $reply_id Optional. Reply id * @param int $length Optional. Length of the excerpt. Defaults to 100 letters */ function bbp_reply_excerpt( $reply_id = 0, $length = 100 ) { echo bbp_get_reply_excerpt( $reply_id, $length ); } /** * Return the excerpt of the reply * * @since 2.0.0 bbPress (r2751) * * @param int $reply_id Optional. Reply id * @param int $length Optional. Length of the excerpt. Defaults to 100 * letters * @return string Reply Excerpt */ function bbp_get_reply_excerpt( $reply_id = 0, $length = 100 ) { $reply_id = bbp_get_reply_id( $reply_id ); $length = (int) $length; $excerpt = get_post_field( 'post_excerpt', $reply_id ); if ( empty( $excerpt ) ) { $excerpt = bbp_get_reply_content( $reply_id ); } $excerpt = trim ( strip_tags( $excerpt ) ); // Multibyte support if ( function_exists( 'mb_strlen' ) ) { $excerpt_length = mb_strlen( $excerpt ); } else { $excerpt_length = strlen( $excerpt ); } if ( ! empty( $length ) && ( $excerpt_length > $length ) ) { $excerpt = mb_substr( $excerpt, 0, $length - 1 ); $excerpt .= '…'; } // Filter & return return apply_filters( 'bbp_get_reply_excerpt', $excerpt, $reply_id, $length ); } /** * Output the post date and time of a reply * * @since 2.2.0 bbPress (r4155) * * @param int $reply_id Optional. Reply id. * @param bool $humanize Optional. Humanize output using time_since * @param bool $gmt Optional. Use GMT */ function bbp_reply_post_date( $reply_id = 0, $humanize = false, $gmt = false ) { echo bbp_get_reply_post_date( $reply_id, $humanize, $gmt ); } /** * Return the post date and time of a reply * * @since 2.2.0 bbPress (r4155) * * @param int $reply_id Optional. Reply id. * @param bool $humanize Optional. Humanize output using time_since * @param bool $gmt Optional. Use GMT * @return string */ function bbp_get_reply_post_date( $reply_id = 0, $humanize = false, $gmt = false ) { $reply_id = bbp_get_reply_id( $reply_id ); // 4 days, 4 hours ago if ( ! empty( $humanize ) ) { $gmt_s = ! empty( $gmt ) ? 'G' : 'U'; $date = get_post_time( $gmt_s, $gmt, $reply_id ); $time = false; // For filter below $result = bbp_get_time_since( $date ); // August 4, 2012 at 2:37 pm } else { $date = get_post_time( get_option( 'date_format' ), $gmt, $reply_id, true ); $time = get_post_time( get_option( 'time_format' ), $gmt, $reply_id, true ); $result = sprintf( _x( '%1$s at %2$s', 'date at time', 'bbpress' ), $date, $time ); } // Filter & return return apply_filters( 'bbp_get_reply_post_date', $result, $reply_id, $humanize, $gmt, $date, $time ); } /** * Append revisions to the reply content * * @since 2.0.0 bbPress (r2782) * * @param string $content Optional. Content to which we need to append the revisions to * @param int $reply_id Optional. Reply id * @return string Content with the revisions appended */ function bbp_reply_content_append_revisions( $content = '', $reply_id = 0 ) { // Bail if in admin or feed if ( is_admin() || is_feed() ) { return $content; } // Validate the ID $reply_id = bbp_get_reply_id( $reply_id ); // Filter & return return apply_filters( 'bbp_reply_append_revisions', $content . bbp_get_reply_revision_log( $reply_id ), $content, $reply_id ); } /** * Output the revision log of the reply * * @since 2.0.0 bbPress (r2782) * * @param int $reply_id Optional. Reply id */ function bbp_reply_revision_log( $reply_id = 0 ) { echo bbp_get_reply_revision_log( $reply_id ); } /** * Return the formatted revision log of the reply * * @since 2.0.0 bbPress (r2782) * * @param int $reply_id Optional. Reply id * @return string Revision log of the reply */ function bbp_get_reply_revision_log( $reply_id = 0 ) { // Create necessary variables $reply_id = bbp_get_reply_id( $reply_id ); // Show the topic reply log if this is a topic in a reply loop if ( bbp_is_topic( $reply_id ) ) { return bbp_get_topic_revision_log( $reply_id ); } // Get the reply revision log (out of post meta $revision_log = bbp_get_reply_raw_revision_log( $reply_id ); // Check reply and revision log exist if ( empty( $reply_id ) || empty( $revision_log ) || ! is_array( $revision_log ) ) { return false; } // Get the actual revisions $revisions = bbp_get_reply_revisions( $reply_id ); if ( empty( $revisions ) ) { return false; } $r = "\n\n" . '
' . "\n\n"; // Filter & return return apply_filters( 'bbp_get_reply_revision_log', $r, $reply_id ); } /** * Return the raw revision log of the reply * * @since 2.0.0 bbPress (r2782) * * @param int $reply_id Optional. Reply id * @return string Raw revision log of the reply */ function bbp_get_reply_raw_revision_log( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $revision_log = get_post_meta( $reply_id, '_bbp_revision_log', true ); $revision_log = ! empty( $revision_log ) ? $revision_log : array(); // Filter & return return apply_filters( 'bbp_get_reply_raw_revision_log', $revision_log, $reply_id ); } /** * Return the revisions of the reply * * @since 2.0.0 bbPress (r2782) * * @param int $reply_id Optional. Reply id * @return string reply revisions */ function bbp_get_reply_revisions( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $revisions = wp_get_post_revisions( $reply_id, array( 'order' => 'ASC' ) ); // Filter & return return apply_filters( 'bbp_get_reply_revisions', $revisions, $reply_id ); } /** * Return the revision count of the reply * * @since 2.0.0 bbPress (r2782) * * @param int $reply_id Optional. Reply id * @param boolean $integer Optional. Whether or not to format the result * @return string reply revision count */ function bbp_get_reply_revision_count( $reply_id = 0, $integer = false ) { $reply_id = bbp_get_reply_id( $reply_id ); $count = count( bbp_get_reply_revisions( $reply_id ) ); $filter = ( true === $integer ) ? 'bbp_get_reply_revision_count_int' : 'bbp_get_reply_revision_count'; return apply_filters( $filter, $count, $reply_id ); } /** * Output the status of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id */ function bbp_reply_status( $reply_id = 0 ) { echo bbp_get_reply_status( $reply_id ); } /** * Return the status of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id * @return string Status of reply */ function bbp_get_reply_status( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); // Filter & return return apply_filters( 'bbp_get_reply_status', get_post_status( $reply_id ), $reply_id ); } /** * Is the reply publicly viewable? * * See bbp_get_public_reply_statuses() for public statuses. * * @since 2.6.0 bbPress (r6391) * * @param int $reply_id Optional. Reply id * @return bool True if public, false if not. */ function bbp_is_reply_public( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $status = bbp_get_reply_status( $reply_id ); $public = bbp_get_public_reply_statuses(); $is_public = in_array( $status, $public, true ); // Filter & return return (bool) apply_filters( 'bbp_is_reply_public', $is_public, $reply_id ); } /** * Is the reply not spam or deleted? * * @since 2.0.0 bbPress (r3496) * @since 2.6.0 bbPress (r6922) Returns false if topic is also not published * * @param int $reply_id Optional. Topic id * @return bool True if published, false if not. */ function bbp_is_reply_published( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $topic_id = bbp_get_reply_topic_id( $reply_id ); $status = bbp_get_public_status_id(); $topic_status = bbp_is_topic_published( $topic_id ); $reply_status = ( bbp_get_reply_status( $reply_id ) === $status ); $retval = ( $reply_status && $topic_status ); // Filter & return return (bool) apply_filters( 'bbp_is_reply_published', (bool) $retval, $reply_id ); } /** * Is the reply marked as spam? * * @since 2.0.0 bbPress (r2740) * * @param int $reply_id Optional. Reply id * @return bool True if spam, false if not. */ function bbp_is_reply_spam( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $status = bbp_get_spam_status_id(); $reply_status = bbp_get_reply_status( $reply_id ) === $status; // Filter & return return (bool) apply_filters( 'bbp_is_reply_spam', (bool) $reply_status, $reply_id ); } /** * Is the reply trashed? * * @since 2.0.0 bbPress (r2884) * * @param int $reply_id Optional. Topic id * @return bool True if spam, false if not. */ function bbp_is_reply_trash( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $status = bbp_get_trash_status_id(); $reply_status = bbp_get_reply_status( $reply_id ) === $status; // Filter & return return (bool) apply_filters( 'bbp_is_reply_trash', (bool) $reply_status, $reply_id ); } /** * Is the reply pending? * * @since 2.6.0 bbPress (r5507) * * @param int $reply_id Optional. Topic id * @return bool True if pending, false if not. */ function bbp_is_reply_pending( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $status = bbp_get_pending_status_id(); $reply_status = bbp_get_reply_status( $reply_id ) === $status; // Filter & return return (bool) apply_filters( 'bbp_is_reply_pending', (bool) $reply_status, $reply_id ); } /** * Is the reply private? * * @since 2.6.0 bbPress (r5507) * * @param int $reply_id Optional. Topic id * @return bool True if private, false if not. */ function bbp_is_reply_private( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $status = bbp_get_private_status_id(); $reply_status = bbp_get_reply_status( $reply_id ) === $status; // Filter & return return (bool) apply_filters( 'bbp_is_reply_private', (bool) $reply_status, $reply_id ); } /** * Is the reply by an anonymous user? * * @since 2.0.0 bbPress (r2753) * * @param int $reply_id Optional. Reply id * @return bool True if the post is by an anonymous user, false if not. */ function bbp_is_reply_anonymous( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $retval = false; if ( ! bbp_get_reply_author_id( $reply_id ) ) { $retval = true; } elseif ( get_post_meta( $reply_id, '_bbp_anonymous_name', true ) ) { $retval = true; } elseif ( get_post_meta( $reply_id, '_bbp_anonymous_email', true ) ) { $retval = true; } // Filter & return return (bool) apply_filters( 'bbp_is_reply_anonymous', $retval, $reply_id ); } /** * Deprecated. Use bbp_reply_author_display_name() instead. * * Output the author of the reply * * @since 2.0.0 bbPress (r2667) * * @deprecated 2.5.0 bbPress (r5119) * * @param int $reply_id Optional. Reply id */ function bbp_reply_author( $reply_id = 0 ) { echo bbp_get_reply_author( $reply_id ); } /** * Deprecated. Use bbp_get_reply_author_display_name() instead. * * Return the author of the reply * * @since 2.0.0 bbPress (r2667) * * @deprecated 2.5.0 bbPress (r5119) * * @param int $reply_id Optional. Reply id * @return string Author of reply */ function bbp_get_reply_author( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); if ( ! bbp_is_reply_anonymous( $reply_id ) ) { $author = get_the_author_meta( 'display_name', bbp_get_reply_author_id( $reply_id ) ); } else { $author = get_post_meta( $reply_id, '_bbp_anonymous_name', true ); } // Filter & return return apply_filters( 'bbp_get_reply_author', $author, $reply_id ); } /** * Output the author ID of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id */ function bbp_reply_author_id( $reply_id = 0 ) { echo bbp_get_reply_author_id( $reply_id ); } /** * Return the author ID of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id * @return string Author id of reply */ function bbp_get_reply_author_id( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); $author_id = get_post_field( 'post_author', $reply_id ); // Filter & return return (int) apply_filters( 'bbp_get_reply_author_id', $author_id, $reply_id ); } /** * Output the author display_name of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id */ function bbp_reply_author_display_name( $reply_id = 0 ) { echo bbp_get_reply_author_display_name( $reply_id ); } /** * Return the author display_name of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id * @return string The display name of the author of the reply */ function bbp_get_reply_author_display_name( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); // User is not a guest if ( ! bbp_is_reply_anonymous( $reply_id ) ) { // Get the author ID $author_id = bbp_get_reply_author_id( $reply_id ); // Try to get a display name $author_name = get_the_author_meta( 'display_name', $author_id ); // Fall back to user login if ( empty( $author_name ) ) { $author_name = get_the_author_meta( 'user_login', $author_id ); } // User does not have an account } else { $author_name = get_post_meta( $reply_id, '_bbp_anonymous_name', true ); } // Fallback if nothing could be found if ( empty( $author_name ) ) { $author_name = bbp_get_fallback_display_name( $reply_id ); } // Encode possible UTF8 display names if ( seems_utf8( $author_name ) === false ) { $author_name = utf8_encode( $author_name ); } // Filter & return return apply_filters( 'bbp_get_reply_author_display_name', $author_name, $reply_id ); } /** * Output the author avatar of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id * @param int $size Optional. Size of the avatar. Defaults to 40 */ function bbp_reply_author_avatar( $reply_id = 0, $size = 40 ) { echo bbp_get_reply_author_avatar( $reply_id, $size ); } /** * Return the author avatar of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id * @param int $size Optional. Size of the avatar. Defaults to 40 * @return string Avatar of author of the reply */ function bbp_get_reply_author_avatar( $reply_id = 0, $size = 40 ) { $reply_id = bbp_get_reply_id( $reply_id ); if ( ! empty( $reply_id ) ) { // Check for anonymous user if ( ! bbp_is_reply_anonymous( $reply_id ) ) { $author_avatar = get_avatar( bbp_get_reply_author_id( $reply_id ), $size ); } else { $author_avatar = get_avatar( get_post_meta( $reply_id, '_bbp_anonymous_email', true ), $size ); } } else { $author_avatar = ''; } // Filter & return return apply_filters( 'bbp_get_reply_author_avatar', $author_avatar, $reply_id, $size ); } /** * Output the author link of the reply * * @since 2.0.0 bbPress (r2717) * * @param array $args Optional. If it is an integer, it is used as reply id. */ function bbp_reply_author_link( $args = array() ) { echo bbp_get_reply_author_link( $args ); } /** * Return the author link of the reply * * @since 2.0.0 bbPress (r2717) * * @param array $args Optional. If an integer, it is used as reply id. * @return string Author link of reply */ function bbp_get_reply_author_link( $args = array() ) { // Parse arguments against default values $r = bbp_parse_args( $args, array( 'post_id' => 0, 'link_title' => '', 'type' => 'both', 'size' => 80, 'sep' => '', 'show_role' => false ), 'get_reply_author_link' ); // Default return value $author_link = ''; // Used as reply_id $reply_id = is_numeric( $args ) ? bbp_get_reply_id( $args ) : bbp_get_reply_id( $r['post_id'] ); // Reply ID is good if ( ! empty( $reply_id ) ) { // Get some useful reply information $author_url = bbp_get_reply_author_url( $reply_id ); $anonymous = bbp_is_reply_anonymous( $reply_id ); // Tweak link title if empty if ( empty( $r['link_title'] ) ) { $author = bbp_get_reply_author_display_name( $reply_id ); $title = empty( $anonymous ) ? esc_attr__( "View %s's profile", 'bbpress' ) : esc_attr__( "Visit %s's website", 'bbpress' ); $link_title = sprintf( $title, $author ); // Use what was passed if not } else { $link_title = $r['link_title']; } // Setup title and author_links array $author_links = array(); $link_title = ! empty( $link_title ) ? ' title="' . esc_attr( $link_title ) . '"' : ''; // Get avatar (unescaped, because HTML) if ( ( 'avatar' === $r['type'] ) || ( 'both' === $r['type'] ) ) { $author_links['avatar'] = bbp_get_reply_author_avatar( $reply_id, $r['size'] ); } // Get display name (escaped, because never HTML) if ( ( 'name' === $r['type'] ) || ( 'both' === $r['type'] ) ) { $author_links['name'] = esc_html( bbp_get_reply_author_display_name( $reply_id ) ); } // Empty array $links = array(); $sprint = '%2$s'; // 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_reply_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( bbp_get_reply_author_id( $reply_id ) ) ) { $author_link = sprintf( '%4$s', esc_url( $author_url ), $link_title, ' class="bbp-author-link"', $author_link ); } // Role is not linked if ( true === $r['show_role'] ) { $author_link .= bbp_get_reply_author_role( array( 'reply_id' => $reply_id ) ); } } // Filter & return return apply_filters( 'bbp_get_reply_author_link', $author_link, $r, $args ); } /** * Output the author url of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id */ function bbp_reply_author_url( $reply_id = 0 ) { echo esc_url( bbp_get_reply_author_url( $reply_id ) ); } /** * Return the author url of the reply * * @since 2.0.0 bbPress (r2667) * * @param int $reply_id Optional. Reply id * @return string Author URL of the reply */ function bbp_get_reply_author_url( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); // Check for anonymous user or non-existant user if ( ! bbp_is_reply_anonymous( $reply_id ) && bbp_user_has_profile( bbp_get_reply_author_id( $reply_id ) ) ) { $author_url = bbp_get_user_profile_url( bbp_get_reply_author_id( $reply_id ) ); } else { $author_url = get_post_meta( $reply_id, '_bbp_anonymous_website', true ); if ( empty( $author_url ) ) { $author_url = ''; } } // Filter & return return apply_filters( 'bbp_get_reply_author_url', $author_url, $reply_id ); } /** * Output the reply author email address * * @since 2.0.0 bbPress (r3445) * * @param int $reply_id Optional. Reply id */ function bbp_reply_author_email( $reply_id = 0 ) { echo bbp_get_reply_author_email( $reply_id ); } /** * Return the reply author email address * * @since 2.0.0 bbPress (r3445) * * @param int $reply_id Optional. Reply id * @return string Reply author email address */ function bbp_get_reply_author_email( $reply_id = 0 ) { $reply_id = bbp_get_reply_id( $reply_id ); // Not anonymous if ( ! bbp_is_reply_anonymous( $reply_id ) ) { // Use reply author email address $user_id = bbp_get_reply_author_id( $reply_id ); $user = get_userdata( $user_id ); $author_email = ! empty( $user->user_email ) ? $user->user_email : ''; // Anonymous } else { // Get email from post meta $author_email = get_post_meta( $reply_id, '_bbp_anonymous_email', true ); // Sanity check for missing email address if ( empty( $author_email ) ) { $author_email = ''; } } // Filter & return return apply_filters( 'bbp_get_reply_author_email', $author_email, $reply_id ); } /** * Output the reply author role * * @since 2.1.0 bbPress (r3860) * * @param array $args Optional. */ function bbp_reply_author_role( $args = array() ) { echo bbp_get_reply_author_role( $args ); } /** * Return the reply author role * * @since 2.1.0 bbPress (r3860) * * @param array $args Optional. * @return string Reply author role */ function bbp_get_reply_author_role( $args = array() ) { // Parse arguments against default values $r = bbp_parse_args( $args, array( 'reply_id' => 0, 'class' => false, 'before' => ' ' ), 'get_reply_author_role' ); $reply_id = bbp_get_reply_id( $r['reply_id'] ); $role = bbp_get_user_display_role( bbp_get_reply_author_id( $reply_id ) ); // Backwards compatibilty with old 'class' argument if ( ! empty( $r['class'] ) ) { $author_role = sprintf( '%1$s