BBP_Default
Loads Forums Default Theme functionality
Description
This is not a real theme by WordPress standards, and is instead used as the fallback for any WordPress theme that does not have Forums templates in it.
To make your custom theme Forums compatible and customize the templates, you can copy these files into your theme without needing to merge anything together; Forums should safely handle the rest.
See also
- BBP_Theme_Compat(): for more.
Source
File: bp-forums/templates/default/bbpress-functions.php
class BBP_Default extends BBP_Theme_Compat { /** Functions *************************************************************/ /** * The main Forums (Default) Loader * * @since bbPress (r3732) * * @uses BBP_Default::setup_globals() * @uses BBP_Default::setup_actions() */ public function __construct( $properties = array() ) { parent::__construct( bbp_parse_args( $properties, array( 'id' => 'default', 'name' => __( 'Forums Default', 'buddyboss' ), 'version' => bbp_get_version(), 'dir' => trailingslashit( bbpress()->themes_dir . 'default' ), 'url' => trailingslashit( bbpress()->themes_url . 'default' ), ), 'default_theme' ) ); $this->setup_actions(); } /** * Setup the theme hooks * * @since bbPress (r3732) * @access private * * @uses add_filter() To add various filters * @uses add_action() To add various actions */ private function setup_actions() { /** Scripts ***********************************************************/ add_action( 'bbp_enqueue_scripts', array( $this, 'enqueue_scripts' ) ); // Enqueue theme JS add_filter( 'bbp_enqueue_scripts', array( $this, 'localize_topic_script' ) ); // Enqueue theme script localization add_action( 'bbp_ajax_favorite', array( $this, 'ajax_favorite' ) ); // Handles the topic ajax favorite/unfavorite add_action( 'bbp_ajax_subscription', array( $this, 'ajax_subscription' ) ); // Handles the topic ajax subscribe/unsubscribe add_action( 'bbp_ajax_forum_subscription', array( $this, 'ajax_forum_subscription' ) ); // Handles the forum ajax subscribe/unsubscribe /** Template Wrappers *************************************************/ add_action( 'bbp_before_main_content', array( $this, 'before_main_content' ) ); // Top wrapper HTML add_action( 'bbp_after_main_content', array( $this, 'after_main_content' ) ); // Bottom wrapper HTML /** Override **********************************************************/ do_action_ref_array( 'bbp_theme_compat_actions', array( &$this ) ); } /** * Inserts HTML at the top of the main content area to be compatible with * the Twenty Twelve theme. * * @since bbPress (r3732) */ public function before_main_content() { ?> <div id="bbp-container"> <div id="bbp-content" role="main"> <?php } /** * Inserts HTML at the bottom of the main content area to be compatible with * the Twenty Twelve theme. * * @since bbPress (r3732) */ public function after_main_content() { ?> </div><!-- #bbp-content --> </div><!-- #bbp-container --> <?php } /** * Enqueue the required Javascript files * * @since bbPress (r3732) * * @uses bbp_is_single_forum() To check if it's the forum page * @uses bbp_is_single_topic() To check if it's the topic page * @uses bbp_thread_replies() To check if threaded replies are enabled * @uses bbp_is_single_user_edit() To check if it's the profile edit page * @uses wp_enqueue_script() To enqueue the scripts */ public function enqueue_scripts() { // Setup scripts array $scripts = array(); // Tag Input if ( bbp_allow_topic_tags() && current_user_can( 'assign_topic_tags' ) ) { wp_enqueue_script( 'bp-tagify' ); } // Always pull in jQuery for TinyMCE shortcode usage if ( bbp_use_wp_editor() ) { $scripts['bbpress-editor'] = array( 'file' => 'js/editor.js', 'dependencies' => array( 'jquery' ) ); wp_enqueue_script( 'bp-medium-editor' ); wp_enqueue_style( 'bp-medium-editor' ); wp_enqueue_style( 'bp-medium-editor-beagle' ); } // Forum-specific scripts if ( bbp_is_single_forum() ) { $scripts['bbpress-forum'] = array( 'file' => 'js/forum.js', 'dependencies' => array( 'jquery' ) ); } // Topic-specific scripts if ( bbp_is_single_topic() ) { // Topic favorite/unsubscribe $scripts['bbpress-topic'] = array( 'file' => 'js/topic.js', 'dependencies' => array( 'jquery' ) ); // Hierarchical replies if ( bbp_thread_replies() ) { $scripts['bbpress-reply'] = array( 'file' => 'js/reply.js', 'dependencies' => array( 'jquery' ) ); } } // User Profile edit if ( bbp_is_single_user_edit() ) { $scripts['bbpress-user'] = array( 'file' => 'js/user.js', 'dependencies' => array( 'user-query' ) ); } $scripts['bbpress-common'] = array( 'file' => 'js/common.js', 'dependencies' => array( 'jquery' ) ); // Filter the scripts $scripts = apply_filters( 'bbp_default_scripts', $scripts ); // Enqueue the scripts foreach ( $scripts as $handle => $attributes ) { bbp_enqueue_script( $handle, $attributes['file'], $attributes['dependencies'], $this->version, 'screen' ); } } /** * Load localizations for topic script * * These localizations require information that may not be loaded even by init. * * @since bbPress (r3732) * * @uses bbp_is_single_forum() To check if it's the forum page * @uses bbp_is_single_topic() To check if it's the topic page * @uses is_user_logged_in() To check if user is logged in * @uses bbp_get_current_user_id() To get the current user id * @uses bbp_get_forum_id() To get the forum id * @uses bbp_get_topic_id() To get the topic id * @uses bbp_get_favorites_permalink() To get the favorites permalink * @uses bbp_is_user_favorite() To check if the topic is in user's favorites * @uses bbp_is_subscriptions_active() To check if the subscriptions are active * @uses bbp_is_user_subscribed() To check if the user is subscribed to topic * @uses bbp_get_topic_permalink() To get the topic permalink * @uses wp_localize_script() To localize the script */ public function localize_topic_script() { // Single forum if ( bbp_is_single_forum() ) { wp_localize_script( 'bbpress-forum', 'bbpForumJS', array( 'bbp_ajaxurl' => bbp_get_ajax_url(), 'generic_ajax_error' => __( 'Something went wrong. Refresh your browser and try again.', 'buddyboss' ), 'is_user_logged_in' => is_user_logged_in(), 'subs_nonce' => wp_create_nonce( 'toggle-subscription_' . get_the_ID() ) ) ); // Single topic } elseif ( bbp_is_single_topic() ) { wp_localize_script( 'bbpress-topic', 'bbpTopicJS', array( 'bbp_ajaxurl' => bbp_get_ajax_url(), 'generic_ajax_error' => __( 'Something went wrong. Refresh your browser and try again.', 'buddyboss' ), 'is_user_logged_in' => is_user_logged_in(), 'fav_nonce' => wp_create_nonce( 'toggle-favorite_' . get_the_ID() ), 'subs_nonce' => wp_create_nonce( 'toggle-subscription_' . get_the_ID() ) ) ); } } /** * AJAX handler to Subscribe/Unsubscribe a user from a forum * * @since bbPress (r5155) * * @uses bbp_is_subscriptions_active() To check if the subscriptions are active * @uses bbp_is_user_logged_in() To check if user is logged in * @uses bbp_get_current_user_id() To get the current user id * @uses current_user_can() To check if the current user can edit the user * @uses bbp_get_forum() To get the forum * @uses wp_verify_nonce() To verify the nonce * @uses bbp_is_user_subscribed() To check if the forum is in user's subscriptions * @uses bbp_remove_user_subscriptions() To remove the forum from user's subscriptions * @uses bbp_add_user_subscriptions() To add the forum from user's subscriptions * @uses bbp_ajax_response() To return JSON */ public function ajax_forum_subscription() { // Bail if subscriptions are not active if ( ! bbp_is_subscriptions_active() ) { bbp_ajax_response( false, __( 'Subscriptions are no longer active.', 'buddyboss' ), 300 ); } // Bail if user is not logged in if ( ! is_user_logged_in() ) { bbp_ajax_response( false, __( 'Please login to subscribe to this forum.', 'buddyboss' ), 301 ); } // Get user and forum data $user_id = bbp_get_current_user_id(); $id = intval( $_POST['id'] ); // Bail if user cannot add favorites for this user if ( ! current_user_can( 'edit_user', $user_id ) ) { bbp_ajax_response( false, __( 'You do not have permission to do this.', 'buddyboss' ), 302 ); } // Get the forum $forum = bbp_get_forum( $id ); // Bail if forum cannot be found if ( empty( $forum ) ) { bbp_ajax_response( false, __( 'The forum could not be found.', 'buddyboss' ), 303 ); } // Bail if user did not take this action if ( ! isset( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'toggle-subscription_' . $forum->ID ) ) { bbp_ajax_response( false, __( 'Are you sure you meant to do that?', 'buddyboss' ), 304 ); } // Take action $status = bbp_is_user_subscribed( $user_id, $forum->ID ) ? bbp_remove_user_subscription( $user_id, $forum->ID ) : bbp_add_user_subscription( $user_id, $forum->ID ); // Bail if action failed if ( empty( $status ) ) { bbp_ajax_response( false, __( 'The request was unsuccessful. Please try again.', 'buddyboss' ), 305 ); } // Put subscription attributes in convenient array $attrs = array( 'forum_id' => $forum->ID, 'user_id' => $user_id ); // Action succeeded bbp_ajax_response( true, bbp_get_forum_subscription_link( $attrs, $user_id, false ), 200 ); } /** * AJAX handler to add or remove a topic from a user's favorites * * @since bbPress (r3732) * * @uses bbp_is_favorites_active() To check if favorites are active * @uses bbp_is_user_logged_in() To check if user is logged in * @uses bbp_get_current_user_id() To get the current user id * @uses current_user_can() To check if the current user can edit the user * @uses bbp_get_topic() To get the topic * @uses wp_verify_nonce() To verify the nonce & check the referer * @uses bbp_is_user_favorite() To check if the topic is user's favorite * @uses bbp_remove_user_favorite() To remove the topic from user's favorites * @uses bbp_add_user_favorite() To add the topic from user's favorites * @uses bbp_ajax_response() To return JSON */ public function ajax_favorite() { // Bail if favorites are not active if ( ! bbp_is_favorites_active() ) { bbp_ajax_response( false, __( 'Saving discussions is no longer active.', 'buddyboss' ), 300 ); } // Bail if user is not logged in if ( ! is_user_logged_in() ) { bbp_ajax_response( false, __( 'Please login to make this discussion a favorite.', 'buddyboss' ), 301 ); } // Get user and topic data $user_id = bbp_get_current_user_id(); $id = !empty( $_POST['id'] ) ? intval( $_POST['id'] ) : 0; // Bail if user cannot add favorites for this user if ( ! current_user_can( 'edit_user', $user_id ) ) { bbp_ajax_response( false, __( 'You do not have permission to do this.', 'buddyboss' ), 302 ); } // Get the topic $topic = bbp_get_topic( $id ); // Bail if topic cannot be found if ( empty( $topic ) ) { bbp_ajax_response( false, __( 'The discussion could not be found.', 'buddyboss' ), 303 ); } // Bail if user did not take this action if ( ! isset( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'toggle-favorite_' . $topic->ID ) ) { bbp_ajax_response( false, __( 'Are you sure you meant to do that?', 'buddyboss' ), 304 ); } // Take action $status = bbp_is_user_favorite( $user_id, $topic->ID ) ? bbp_remove_user_favorite( $user_id, $topic->ID ) : bbp_add_user_favorite( $user_id, $topic->ID ); // Bail if action failed if ( empty( $status ) ) { bbp_ajax_response( false, __( 'The request was unsuccessful. Please try again.', 'buddyboss' ), 305 ); } // Put subscription attributes in convenient array $attrs = array( 'topic_id' => $topic->ID, 'user_id' => $user_id ); // Action succeeded bbp_ajax_response( true, bbp_get_user_favorites_link( $attrs, $user_id, false ), 200 ); } /** * AJAX handler to Subscribe/Unsubscribe a user from a topic * * @since bbPress (r3732) * * @uses bbp_is_subscriptions_active() To check if the subscriptions are active * @uses bbp_is_user_logged_in() To check if user is logged in * @uses bbp_get_current_user_id() To get the current user id * @uses current_user_can() To check if the current user can edit the user * @uses bbp_get_topic() To get the topic * @uses wp_verify_nonce() To verify the nonce * @uses bbp_is_user_subscribed() To check if the topic is in user's subscriptions * @uses bbp_remove_user_subscriptions() To remove the topic from user's subscriptions * @uses bbp_add_user_subscriptions() To add the topic from user's subscriptions * @uses bbp_ajax_response() To return JSON */ public function ajax_subscription() { // Bail if subscriptions are not active if ( ! bbp_is_subscriptions_active() ) { bbp_ajax_response( false, __( 'Subscriptions are no longer active.', 'buddyboss' ), 300 ); } // Bail if user is not logged in if ( ! is_user_logged_in() ) { bbp_ajax_response( false, __( 'Please login to subscribe to this discussion.', 'buddyboss' ), 301 ); } // Get user and topic data $user_id = bbp_get_current_user_id(); $id = intval( $_POST['id'] ); // Bail if user cannot add favorites for this user if ( ! current_user_can( 'edit_user', $user_id ) ) { bbp_ajax_response( false, __( 'You do not have permission to do this.', 'buddyboss' ), 302 ); } // Get the topic $topic = bbp_get_topic( $id ); // Bail if topic cannot be found if ( empty( $topic ) ) { bbp_ajax_response( false, __( 'The discussion could not be found.', 'buddyboss' ), 303 ); } // Bail if user did not take this action if ( ! isset( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'toggle-subscription_' . $topic->ID ) ) { bbp_ajax_response( false, __( 'Are you sure you meant to do that?', 'buddyboss' ), 304 ); } // Take action $status = bbp_is_user_subscribed( $user_id, $topic->ID ) ? bbp_remove_user_subscription( $user_id, $topic->ID ) : bbp_add_user_subscription( $user_id, $topic->ID ); // Bail if action failed if ( empty( $status ) ) { bbp_ajax_response( false, __( 'The request was unsuccessful. Please try again.', 'buddyboss' ), 305 ); } // Put subscription attributes in convenient array $attrs = array( 'topic_id' => $topic->ID, 'user_id' => $user_id ); // Action succeeded bbp_ajax_response( true, bbp_get_user_subscribe_link( $attrs, $user_id, false ), 200 ); } }
Changelog
Version | Description |
---|---|
bbPress (r3732) | Introduced. |
Methods
- __construct — The main Forums (Default) Loader
- after_main_content — Inserts HTML at the bottom of the main content area to be compatible with the Twenty Twelve theme.
- ajax_favorite — AJAX handler to add or remove a topic from a user's favorites
- ajax_forum_subscription — AJAX handler to Subscribe/Unsubscribe a user from a forum
- ajax_subscription — AJAX handler to Subscribe/Unsubscribe a user from a topic
- before_main_content — Inserts HTML at the top of the main content area to be compatible with the Twenty Twelve theme.
- enqueue_scripts — Enqueue the required Javascript files
- localize_topic_script — Load localizations for topic script
- media_localize_script — Localize scripts for Media component for forums
- mentions_script — Enqueue @mentions JS.
- setup_actions — Setup the theme hooks
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.