PluginProbe
bbPress / 2.6.17
bbPress v2.6.17
2.6.17 trunk 2.0 2.0-beta-1 2.0-beta-2b 2.0-beta-3 2.0-beta-3b 2.0-rc-2 2.0-rc-3 2.0-rc-4 2.0-rc-5 2.0.1 2.0.2 2.0.3 2.1 2.1-beta-1 2.1-rc1 2.1-rc2 2.1-rc3 2.1-rc4 2.1.1 2.1.2 2.1.3 2.2 2.2.1 All 72 releases
← All changes | bbpress.php +869 -658 2.0-beta-12.6.17 View file →
@@ -4,702 +4,703 @@
4 4 * The bbPress Plugin
5 5 *
6 6 * bbPress is forum software with a twist from the creators of WordPress.
7 7 *
8 + * $Id: bbpress.php 7528 2026-09-16 06:42:34Z johnjamesjacoby $
9 + *
8 10 * @package bbPress
9 11 * @subpackage Main
10 12 */
11 13
12 14 /**
13 - * Plugin Name: bbPress
14 - * Plugin URI: http://bbpress.org
15 - * Description: bbPress is forum software with a twist from the creators of WordPress.
16 - * Author: The bbPress Community
17 - * Author URI: http://bbpress.org
18 - * Version: 2.0-beta-1
15 + * Plugin Name: bbPress
16 + * Plugin URI: https://bbpress.org
17 + * Description: bbPress is forum software with a twist from the creators of WordPress.
18 + * Author: The bbPress Contributors
19 + * Author URI: https://bbpress.org
20 + * License: GNU General Public License v2 or later
21 + * License URI: https://www.gnu.org/licenses/gpl-2.0.html
22 + * Text Domain: bbpress
23 + * Domain Path: /languages/
24 + * Requires PHP: 5.6.20
25 + * Requires at least: 6.0
26 + * Tested up to: 7.1
27 + * Version: 2.6.17
19 28 */
20 29
21 -// Redirect if accessed directly
22 -if ( !defined( 'ABSPATH' ) ) exit;
30 +// Exit if accessed directly
31 +defined( 'ABSPATH' ) || exit;
23 32
33 +if ( ! class_exists( 'bbPress' ) ) :
24 34 /**
25 - * bbPress version
26 - *
27 - * Set the version early so other plugins have an inexpensive way to check if
28 - * bbPress is already loaded.
29 - *
30 - * Note: Checking for defined( 'BBP_VERSION' ) in your code does NOT
31 - * guarantee bbPress is initialized and listening.
32 - */
33 -define( 'BBP_VERSION', '2.0-beta-1' );
34 -
35 -if ( !class_exists( 'bbPress' ) ) :
36 -/**
37 35 * Main bbPress Class
38 36 *
39 - * Tap tap tap... Is this thing on?
37 + * "Word hard. Stay bumble."
40 38 *
41 - * @since bbPress (r2464)
42 - * @todo Use BP_Component class
39 + * @since 2.0.0 bbPress (r2464)
43 40 */
44 -class bbPress {
41 +final class bbPress {
45 42
46 - /** Post types ************************************************************/
43 + /** Magic *****************************************************************/
47 44
48 45 /**
49 - * @var string Forum post type id
46 + * bbPress uses many variables, several of which can be filtered to
47 + * customize the way it operates. Most of these variables are stored in a
48 + * private array that gets updated with the help of PHP magic methods.
49 + *
50 + * This is a precautionary measure, to avoid potential errors produced by
51 + * unanticipated direct manipulation of run-time data.
52 + *
53 + * @see bbPress::setup_globals()
54 + * @var array
50 55 */
51 - var $forum_post_type;
56 + private $data;
52 57
53 - /**
54 - * @var string Topic post type id
55 - */
56 - var $topic_post_type;
58 + /** Not Magic *************************************************************/
57 59
58 60 /**
59 - * @var string Reply post type id
61 + * @var mixed False when not logged in; WP_User object when logged in
60 62 */
61 - var $reply_post_type;
63 + public $current_user = false;
62 64
63 - /** Taxonomies ************************************************************/
64 -
65 65 /**
66 - * @var string Topic tag id
66 + * @var stdClass Add-ons append to this (Akismet, BuddyPress, etc...)
67 67 */
68 - var $topic_tag_id;
68 + public $extend;
69 69
70 - /** Post statuses *********************************************************/
71 -
72 70 /**
73 - * @var string Closed post status id. Used by topics.
71 + * @var array Topic views
74 72 */
75 - var $closed_status_id;
73 + public $views = array();
76 74
77 75 /**
78 - * @var string Spam post status id. Used by topics and replies.
76 + * @var array Overloads get_option()
79 77 */
80 - var $spam_status_id;
78 + public $options = array();
81 79
82 80 /**
83 - * @var string Trash post status id. Used by topics and replies.
81 + * @var array Storage of options not in the database
84 82 */
85 - var $trash_status_id;
83 + public $not_options = array();
86 84
87 85 /**
88 - * @var string Orphan post status id. Used by topics and replies.
86 + * @var array Overloads get_user_meta()
89 87 */
90 - var $orphan_status_id;
88 + public $user_options = array();
91 89
92 90 /**
93 - * @var string Hidden post status id. Used by forums.
91 + * @var array Dynamically initialized user roles
94 92 */
95 - var $hidden_status_id;
93 + public $roles = array();
96 94
97 - /** Slugs *****************************************************************/
95 + /** Singleton *************************************************************/
98 96
99 97 /**
100 - * @var string Root slug
98 + * Main bbPress Instance
99 + *
100 + * bbPress is fun
101 + * Please load it only one time
102 + * For this, we thank you
103 + *
104 + * Insures that only one instance of bbPress exists in memory at any one
105 + * time. Also prevents needing to define globals all over the place.
106 + *
107 + * @since 2.1.0 bbPress (r3757)
108 + *
109 + * @staticvar object $instance
110 + * @see bbpress()
111 + * @return bbPress The one true bbPress
101 112 */
102 - var $root_slug;
113 + public static function instance() {
103 114
104 - /**
105 - * @var string Forum slug
106 - */
107 - var $forum_slug;
115 + // Store the instance locally to avoid private static replication
116 + static $instance = null;
108 117
109 - /**
110 - * @var string Topic slug
111 - */
112 - var $topic_slug;
118 + // Only run these methods if they haven't been ran previously
119 + if ( null === $instance ) {
120 + $instance = new bbPress();
121 + $instance->setup_environment();
122 + $instance->includes();
123 + $instance->setup_variables();
124 + $instance->setup_actions();
125 + }
113 126
114 - /**
115 - * @var string Topic archive slug
116 - */
117 - var $topic_archive_slug;
127 + // Always return the instance
128 + return $instance;
129 + }
118 130
119 - /**
120 - * @var string Reply slug
121 - */
122 - var $reply_slug;
131 + /** Magic Methods *********************************************************/
123 132
124 133 /**
125 - * @var string Topic tag slug
134 + * A dummy constructor to prevent bbPress from being loaded more than once.
135 + *
136 + * @since 2.0.0 bbPress (r2464)
137 + *
138 + * @see bbPress::instance()
139 + * @see bbpress();
126 140 */
127 - var $topic_tag_slug;
141 + private function __construct() {
142 + /* Do nothing here */
143 + }
128 144
129 145 /**
130 - * @var string User slug
146 + * A dummy magic method to prevent bbPress from being cloned
147 + *
148 + * @since 2.0.0 bbPress (r2464)
131 149 */
132 - var $user_slug;
150 + public function __clone() {
151 + _doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'bbpress' ), '2.1' );
152 + }
133 153
134 154 /**
135 - * @var string View slug
155 + * A dummy magic method to prevent bbPress from being unserialized
156 + *
157 + * @since 2.0.0 bbPress (r2464)
136 158 */
137 - var $view_slug;
159 + public function __wakeup() {
160 + _doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'bbpress' ), '2.1' );
161 + }
138 162
139 - /** Paths *****************************************************************/
140 -
141 163 /**
142 - * @var string Absolute path to the bbPress plugin directory
164 + * Magic method for checking the existence of a certain custom field
165 + *
166 + * @since 2.1.0 bbPress (r3951)
143 167 */
144 - var $plugin_dir;
168 + public function __isset( $key ) {
169 + return isset( $this->data[ $key ] );
170 + }
145 171
146 172 /**
147 - * @var string Absolute path to the bbPress themes directory
173 + * Magic method for getting bbPress variables
174 + *
175 + * @since 2.1.0 bbPress (r3951)
148 176 */
149 - var $themes_dir;
177 + public function __get( $key ) {
178 + return isset( $this->data[ $key ] )
179 + ? $this->data[ $key ]
180 + : null;
181 + }
150 182
151 - /** URLs ******************************************************************/
152 -
153 183 /**
154 - * @var string URL to the bbPress plugin directory
184 + * Magic method for setting bbPress variables
185 + *
186 + * @since 2.1.0 bbPress (r3951)
155 187 */
156 - var $plugin_url;
188 + public function __set( $key, $value ) {
189 + $this->data[ $key ] = $value;
190 + }
157 191
158 192 /**
159 - * @var string URL to the bbPress themes directory
193 + * Magic method for unsetting bbPress variables
194 + *
195 + * @since 2.3.0 bbPress (r4628)
160 196 */
161 - var $themes_url;
197 + public function __unset( $key ) {
198 + if ( isset( $this->data[ $key ] ) ) {
199 + unset( $this->data[ $key ] );
200 + }
201 + }
162 202
163 - /** Current ID's **********************************************************/
164 -
165 203 /**
166 - * @var string Current forum id
204 + * Magic method to prevent notices and errors from invalid method calls
205 + *
206 + * @since 2.2.0 bbPress (r4252)
167 207 */
168 - var $current_forum_id = null;
208 + public function __call( $name = '', $args = array() ) {
209 + unset( $name, $args );
210 + return null;
211 + }
169 212
170 - /**
171 - * @var string Current topic id
172 - */
173 - var $current_topic_id = null;
213 + /** Private Methods *******************************************************/
174 214
175 215 /**
176 - * @var string Current reply id
216 + * Setup the environment variables to allow the rest of bbPress to function
217 + * more easily.
218 + *
219 + * @since 2.0.0 bbPress (r2626)
220 + *
221 + * @access private
177 222 */
178 - var $current_reply_id = null;
223 + private function setup_environment() {
179 224
180 - /** Users *****************************************************************/
225 + /** Versions **********************************************************/
181 226
182 - /**
183 - * @var object Current user
184 - */
185 - var $current_user;
227 + $this->version = '2.6.17';
228 + $this->db_version = '263';
186 229
187 - /**
188 - * @var object Displayed user
189 - */
190 - var $displayed_user;
230 + /** Paths *************************************************************/
191 231
192 - /** Queries ***************************************************************/
232 + // File & base
233 + $this->file = __FILE__;
234 + $this->basename = apply_filters( 'bbp_plugin_basename', str_replace( array( 'build/', 'src/' ), '', plugin_basename( $this->file ) ) );
235 + $this->basepath = apply_filters( 'bbp_plugin_basepath', trailingslashit( dirname( $this->basename ) ) );
193 236
194 - /**
195 - * @var WP_Query For forums
196 - */
197 - var $forum_query;
237 + // Path and URL
238 + $this->plugin_dir = apply_filters( 'bbp_plugin_dir_path', plugin_dir_path( $this->file ) );
239 + $this->plugin_url = apply_filters( 'bbp_plugin_dir_url', plugin_dir_url ( $this->file ) );
198 240
199 - /**
200 - * @var WP_Query For topics
201 - */
202 - var $topic_query;
241 + // Includes
242 + $this->includes_dir = apply_filters( 'bbp_includes_dir', trailingslashit( $this->plugin_dir . 'includes' ) );
243 + $this->includes_url = apply_filters( 'bbp_includes_url', trailingslashit( $this->plugin_url . 'includes' ) );
203 244
204 - /**
205 - * @var WP_Query For replies
206 - */
207 - var $reply_query;
245 + // Languages
246 + $this->lang_base = apply_filters( 'bbp_lang_base', trailingslashit( $this->basepath . 'languages' ) );
247 + $this->lang_dir = apply_filters( 'bbp_lang_dir', trailingslashit( $this->plugin_dir . 'languages' ) );
208 248
209 - /** Arrays ****************************************************************/
210 -
211 - /**
212 - * @var array Sub Forums
213 - */
214 - var $sub_forums;
215 -
216 - /** Errors ****************************************************************/
217 -
218 - /**
219 - * @var WP_Error Used to log and display errors
220 - */
221 - var $errors;
222 -
223 - /** Views *****************************************************************/
224 -
225 - /**
226 - * @var array An array of registered bbPress views
227 - */
228 - var $views;
229 -
230 - /** Forms *****************************************************************/
231 -
232 - /**
233 - * @var int The current tab index for form building
234 - */
235 - var $tab_index;
236 -
237 - /** Functions *************************************************************/
238 -
239 - /**
240 - * The main bbPress loader (PHP4 compat)
241 - *
242 - * @since bbPress (r2464)
243 - *
244 - * @uses bbPress::__construct() Setup the globals needed
245 - */
246 - function bbPress() {
247 - $this->__construct();
249 + // Templates
250 + $this->themes_dir = apply_filters( 'bbp_themes_dir', trailingslashit( $this->plugin_dir . 'templates' ) );
251 + $this->themes_url = apply_filters( 'bbp_themes_url', trailingslashit( $this->plugin_url . 'templates' ) );
248 252 }
249 253
250 254 /**
251 - * The main bbPress loader
255 + * Smart defaults to many bbPress specific class variables.
252 256 *
253 - * @since bbPress (r2464)
254 - *
255 - * @uses bbPress::_setup_globals() Setup the globals needed
256 - * @uses bbPress::_includes() Include the required files
257 - * @uses bbPress::_setup_actions() Setup the hooks and actions
257 + * @since 2.6.0 bbPress (r6330)
258 258 */
259 - function __construct() {
260 - $this->_setup_globals();
261 - $this->_includes();
262 - $this->_setup_actions();
263 - }
259 + private function setup_variables() {
264 260
265 - /**
266 - * Component global variables
267 - *
268 - * @since bbPress (r2626)
269 - * @access private
270 - *
271 - * @uses plugin_dir_path() To generate bbPress plugin path
272 - * @uses plugin_dir_url() To generate bbPress plugin url
273 - * @uses apply_filters() Calls various filters
274 - */
275 - function _setup_globals() {
276 -
277 - /** Paths *************************************************************/
278 -
279 - // bbPress root directory
280 - $this->file = __FILE__;
281 - $this->plugin_dir = plugin_dir_path( $this->file );
282 - $this->plugin_url = plugin_dir_url ( $this->file );
283 -
284 - // Themes
285 - $this->themes_dir = WP_PLUGIN_DIR . '/' . basename( dirname( __FILE__ ) ) . '/bbp-themes';
286 - $this->themes_url = $this->plugin_url . 'bbp-themes';
287 -
288 261 /** Identifiers *******************************************************/
289 262
290 263 // Post type identifiers
291 - $this->forum_post_type = apply_filters( 'bbp_forum_post_type', 'forum' );
292 - $this->topic_post_type = apply_filters( 'bbp_topic_post_type', 'topic' );
293 - $this->reply_post_type = apply_filters( 'bbp_reply_post_type', 'reply' );
294 - $this->topic_tag_id = apply_filters( 'bbp_topic_tag_id', 'topic-tag' );
264 + $this->forum_post_type = apply_filters( 'bbp_forum_post_type', 'forum' );
265 + $this->topic_post_type = apply_filters( 'bbp_topic_post_type', 'topic' );
266 + $this->topic_tag_tax_id = apply_filters( 'bbp_topic_tag_tax_id', 'topic-tag' );
267 + $this->reply_post_type = apply_filters( 'bbp_reply_post_type', 'reply' );
295 268
296 269 // Status identifiers
297 - $this->spam_status_id = apply_filters( 'bbp_spam_post_status', 'spam' );
298 - $this->closed_status_id = apply_filters( 'bbp_closed_post_status', 'closed' );
299 - $this->orphan_status_id = apply_filters( 'bbp_orphan_post_status', 'orphan' );
300 - $this->hidden_status_id = apply_filters( 'bbp_hidden_post_status', 'hidden' );
301 - $this->trash_status_id = 'trash';
270 + $this->spam_status_id = apply_filters( 'bbp_spam_post_status', 'spam' );
271 + $this->closed_status_id = apply_filters( 'bbp_closed_post_status', 'closed' );
272 + $this->orphan_status_id = apply_filters( 'bbp_orphan_post_status', 'orphan' );
273 + $this->public_status_id = apply_filters( 'bbp_public_post_status', 'publish' );
274 + $this->pending_status_id = apply_filters( 'bbp_pending_post_status', 'pending' );
275 + $this->private_status_id = apply_filters( 'bbp_private_post_status', 'private' );
276 + $this->hidden_status_id = apply_filters( 'bbp_hidden_post_status', 'hidden' );
277 + $this->trash_status_id = apply_filters( 'bbp_trash_post_status', 'trash' );
302 278
303 - /** Slugs *************************************************************/
279 + // Other identifiers
280 + $this->user_id = apply_filters( 'bbp_user_id', 'bbp_user' );
281 + $this->tops_id = apply_filters( 'bbp_tops_id', 'bbp_tops' );
282 + $this->reps_id = apply_filters( 'bbp_reps_id', 'bbp_reps' );
283 + $this->favs_id = apply_filters( 'bbp_favs_id', 'bbp_favs' );
284 + $this->subs_id = apply_filters( 'bbp_subs_id', 'bbp_subs' );
285 + $this->view_id = apply_filters( 'bbp_view_id', 'bbp_view' );
286 + $this->edit_id = apply_filters( 'bbp_edit_id', 'edit' );
287 + $this->paged_id = apply_filters( 'bbp_paged_id', 'paged' );
288 + $this->search_id = apply_filters( 'bbp_search_id', 'bbp_search' );
289 + $this->engagements_id = apply_filters( 'bbp_engagements_id', 'bbp_engagements' );
304 290
305 - // Root forum slug
306 - $this->root_slug = apply_filters( 'bbp_root_slug', get_option( '_bbp_root_slug', 'forums' ) );
307 - $this->topic_archive_slug = apply_filters( 'bbp_topic_archive_slug', get_option( '_bbp_topic_archive_slug', 'topics' ) );
291 + /** Queries ***********************************************************/
308 292
309 - // Should we include the root slug in front of component slugs
310 - $prefix = !empty( $this->root_slug ) && get_option( '_bbp_include_root', true ) ? trailingslashit( $this->root_slug ) : '';
293 + $this->current_view_id = 0; // Current view id
294 + $this->current_forum_id = 0; // Current forum id
295 + $this->current_topic_id = 0; // Current topic id
296 + $this->current_reply_id = 0; // Current reply id
297 + $this->current_topic_tag_id = 0; // Current topic tag id
298 + $this->current_user_id = 0; // Current topic tag id
311 299
312 - // Component slugs
313 - $this->forum_slug = apply_filters( 'bbp_forum_slug', $prefix . get_option( '_bbp_forum_slug', 'forum' ) );
314 - $this->topic_slug = apply_filters( 'bbp_topic_slug', $prefix . get_option( '_bbp_topic_slug', 'topic' ) );
315 - $this->reply_slug = apply_filters( 'bbp_reply_slug', $prefix . get_option( '_bbp_reply_slug', 'reply' ) );
300 + $this->forum_query = new WP_Query(); // Main forum query
301 + $this->topic_query = new WP_Query(); // Main topic query
302 + $this->reply_query = new WP_Query(); // Main reply query
303 + $this->search_query = new WP_Query(); // Main search query
304 + $this->user_query = new BBP_User_Query(); // Main user query
316 305
317 - // Taxonomy slugs
318 - $this->topic_tag_slug = apply_filters( 'bbp_topic_tag_slug', $prefix . get_option( '_bbp_topic_tag_slug', 'tag' ) );
306 + /** Theme Compat ******************************************************/
319 307
320 - /** Other Slugs *******************************************************/
308 + $this->theme_compat = new stdClass(); // Base theme compatibility class
309 + $this->filters = new stdClass(); // Used when adding/removing filters
321 310
322 - $this->user_slug = apply_filters( 'bbp_user_slug', $prefix . get_option( '_bbp_user_slug', 'user' ) );
323 - $this->view_slug = apply_filters( 'bbp_view_slug', $prefix . get_option( '_bbp_view_slug', 'view' ) );
311 + /** Users *************************************************************/
324 312
313 + $this->current_user = new WP_User(); // Currently logged in user
314 + $this->displayed_user = new WP_User(); // Currently displayed user
315 +
325 316 /** Misc **************************************************************/
326 317
327 - // Errors
328 - $this->errors = new WP_Error();
318 + $this->domain = 'bbpress'; // Unique identifier for retrieving translated strings
319 + $this->extend = new stdClass(); // Plugins add data here
320 + $this->errors = new WP_Error(); // Feedback
329 321
330 - // Views
331 - $this->views = array();
322 + /** Deprecated ********************************************************/
332 323
333 - // Tab Index
334 - $this->tab_index = apply_filters( 'bbp_default_tab_index', 100 );
335 -
336 - /** Cache *************************************************************/
337 -
338 - // Add bbPress to global cache groups
339 - wp_cache_add_global_groups( 'bbpress' );
324 + $this->tab_index = apply_filters( 'bbp_default_tab_index', 100 );
340 325 }
341 326
342 327 /**
343 328 * Include required files
344 329 *
345 - * @since bbPress (r2626)
330 + * @since 2.0.0 bbPress (r2626)
331 + *
346 332 * @access private
347 - *
348 - * @uses is_admin() If in WordPress admin, load additional file
349 333 */
350 - function _includes() {
334 + private function includes() {
351 335
352 - /** Individual files **************************************************/
336 + /** Core **************************************************************/
353 337
354 - $files = array( 'loader', 'options', 'caps', 'hooks', 'classes', 'widgets', 'shortcodes', 'compatibility' );
338 + require $this->includes_dir . 'core/abstraction.php';
339 + require $this->includes_dir . 'core/sub-actions.php';
340 + require $this->includes_dir . 'core/functions.php';
341 + require $this->includes_dir . 'core/cache.php';
342 + require $this->includes_dir . 'core/options.php';
343 + require $this->includes_dir . 'core/capabilities.php';
344 + require $this->includes_dir . 'core/update.php';
345 + require $this->includes_dir . 'core/template-functions.php';
346 + require $this->includes_dir . 'core/template-loader.php';
347 + require $this->includes_dir . 'core/theme-compat.php';
355 348
356 - // Load the files
357 - foreach ( $files as $file )
358 - require( $this->plugin_dir . '/bbp-includes/bbp-core-' . $file . '.php' );
349 + /** Components ********************************************************/
359 350
360 - /** Components ********************************************************/
351 + // Common
352 + require $this->includes_dir . 'common/ajax.php';
353 + require $this->includes_dir . 'common/classes.php';
354 + require $this->includes_dir . 'common/engagements.php';
355 + require $this->includes_dir . 'common/functions.php';
356 + require $this->includes_dir . 'common/formatting.php';
357 + require $this->includes_dir . 'common/locale.php';
358 + require $this->includes_dir . 'common/locks.php';
359 + require $this->includes_dir . 'common/rest.php';
360 + require $this->includes_dir . 'common/xmlrpc.php';
361 + require $this->includes_dir . 'common/template.php';
362 + require $this->includes_dir . 'common/widgets.php';
363 + require $this->includes_dir . 'common/shortcodes.php';
361 364
362 - $components = array( 'general', 'forum', 'topic', 'reply', 'user' );
365 + // Forums
366 + require $this->includes_dir . 'forums/capabilities.php';
367 + require $this->includes_dir . 'forums/functions.php';
368 + require $this->includes_dir . 'forums/template.php';
363 369
364 - // Load the function and template files
365 - foreach ( $components as $file ) {
366 - require( $this->plugin_dir . '/bbp-includes/bbp-' . $file . '-functions.php' );
367 - require( $this->plugin_dir . '/bbp-includes/bbp-' . $file . '-template.php' );
368 - }
370 + // Topics
371 + require $this->includes_dir . 'topics/capabilities.php';
372 + require $this->includes_dir . 'topics/functions.php';
373 + require $this->includes_dir . 'topics/template.php';
369 374
375 + // Replies
376 + require $this->includes_dir . 'replies/capabilities.php';
377 + require $this->includes_dir . 'replies/functions.php';
378 + require $this->includes_dir . 'replies/template.php';
379 +
380 + // Search
381 + require $this->includes_dir . 'search/functions.php';
382 + require $this->includes_dir . 'search/template.php';
383 +
384 + // Users
385 + require $this->includes_dir . 'users/capabilities.php';
386 + require $this->includes_dir . 'users/engagements.php';
387 + require $this->includes_dir . 'users/functions.php';
388 + require $this->includes_dir . 'users/template.php';
389 + require $this->includes_dir . 'users/options.php';
390 + require $this->includes_dir . 'users/signups.php';
391 +
392 + /** Hooks *************************************************************/
393 +
394 + require $this->includes_dir . 'core/extend.php';
395 + require $this->includes_dir . 'core/actions.php';
396 + require $this->includes_dir . 'core/filters.php';
397 +
370 398 /** Admin *************************************************************/
371 399
372 400 // Quick admin check and load if needed
373 - if ( is_admin() )
374 - require( $this->plugin_dir . '/bbp-admin/bbp-admin.php' );
401 + if ( is_admin() ) {
402 + require $this->includes_dir . 'admin/actions.php';
403 + }
375 404 }
376 405
377 406 /**
378 407 * Setup the default hooks and actions
379 408 *
380 - * @since bbPress (r2644)
409 + * @since 2.0.0 bbPress (r2644)
410 + *
381 411 * @access private
382 - *
383 - * @uses register_activation_hook() To register the activation hook
384 - * @uses register_deactivation_hook() To register the deactivation hook
385 - * @uses add_action() To add various actions
386 412 */
387 - function _setup_actions() {
413 + private function setup_actions() {
388 414
389 - // Register bbPress activation/deactivation sequences
390 - register_activation_hook ( $this->file, 'bbp_activation' );
391 - register_deactivation_hook( $this->file, 'bbp_deactivation' );
415 + // Add actions to plugin activation and deactivation hooks
416 + add_action( 'activate_' . $this->basename, 'bbp_activation' );
417 + add_action( 'deactivate_' . $this->basename, 'bbp_deactivation' );
392 418
393 - // Setup the currently logged in user
394 - add_action( 'bbp_setup_current_user', array( $this, 'setup_current_user' ), 10 );
419 + // If bbPress is being deactivated, do not add any actions
420 + if ( bbp_is_deactivation( $this->basename ) ) {
421 + return;
422 + }
395 423
396 - // Register content types
397 - add_action( 'bbp_register_post_types', array( $this, 'register_post_types' ), 10 );
424 + // Array of bbPress core actions
425 + $actions = array(
426 + 'setup_theme', // Setup the default theme compat
427 + 'setup_current_user', // Setup currently logged in user
428 + 'setup_engagements', // Setup user engagements strategy
429 + 'roles_init', // User roles init
430 + 'register_meta', // Register meta (forum|topic|reply|user)
431 + 'register_post_types', // Register post types (forum|topic|reply)
432 + 'register_post_statuses', // Register post statuses (closed|spam|orphan|hidden)
433 + 'register_taxonomies', // Register taxonomies (topic-tag)
434 + 'register_shortcodes', // Register shortcodes (bbp-login)
435 + 'register_views', // Register the views (no-replies)
436 + 'register_theme_packages', // Register bundled theme packages (bbp-theme-compat/bbp-themes)
437 + 'load_textdomain', // Load textdomain (bbpress)
438 + 'add_rewrite_tags', // Add rewrite tags (view|user|edit|search)
439 + 'add_rewrite_rules', // Generate rewrite rules (view|edit|paged|search)
440 + 'add_permastructs' // Add permalink structures (view|user|search)
441 + );
398 442
399 - // Register post statuses
400 - add_action( 'bbp_register_post_statuses', array( $this, 'register_post_statuses' ), 10 );
443 + // Add the actions
444 + foreach ( $actions as $class_action ) {
445 + add_action( 'bbp_' . $class_action, array( $this, $class_action ), 5 );
446 + }
401 447
402 - // Register taxonomies
403 - add_action( 'bbp_register_taxonomies', array( $this, 'register_taxonomies' ), 10 );
448 + // All bbPress actions are setup (includes bbp-core-hooks.php)
449 + do_action_ref_array( 'bbp_after_setup_actions', array( &$this ) );
450 + }
404 451
405 - // Register the views
406 - add_action( 'bbp_register_views', array( $this, 'register_views' ), 10 );
452 + /** Public Methods ********************************************************/
407 453
408 - // Register the theme directory
409 - add_action( 'bbp_register_theme_directory', array( $this, 'register_theme_directory' ), 10 );
410 -
411 - // Load textdomain
412 - add_action( 'bbp_load_textdomain', array( $this, 'register_textdomain' ), 10 );
413 -
414 - // Add the %bbp_user% rewrite tag
415 - add_action( 'bbp_add_rewrite_tags', array( $this, 'add_rewrite_tags' ), 10 );
416 -
417 - // Generate rewrite rules
418 - add_action( 'bbp_generate_rewrite_rules', array( $this, 'generate_rewrite_rules' ), 10 );
419 -
420 - // Check theme compatability
421 - add_action( 'bbp_setup_theme_compat', array( $this, 'theme_compat' ), 10 );
422 - }
423 -
424 454 /**
425 - * Register Textdomain
455 + * Register bundled theme packages
426 456 *
427 - * Load the translation file for current language. Checks only the default
428 - * WordPress languages folder to avoid language files being wiped out
429 - * with plugin updates.
457 + * Note that since we currently have complete control over bbp-themes and
458 + * the bbp-theme-compat folders, it's fine to hardcode these here. If at a
459 + * later date we need to automate this, and API will need to be built.
430 460 *
431 - * @since bbPress (r2596)
432 - *
433 - * @uses apply_filters() Calls 'bbpress_locale' with the
434 - * {@link get_locale()} value
435 - * @uses load_textdomain() To load the textdomain
436 - * @return bool True on success, false on failure
461 + * @since 2.1.0 bbPress (r3829)
437 462 */
438 - function register_textdomain() {
463 + public function register_theme_packages() {
439 464
440 - // Allow locale to be filtered
441 - $locale = apply_filters( 'bbpress_locale', get_locale() );
465 + // Register the basic theme stack. This is really dope.
466 + bbp_register_template_stack( 'get_stylesheet_directory', 6 );
467 + bbp_register_template_stack( 'get_template_directory', 8 );
442 468
443 - // Get mo file name
444 - $mofile = sprintf( 'bbpress-%s.mo', $locale );
445 -
446 - // Setup path to current locale file
447 - $mofile_global = WP_LANG_DIR . '/bbpress/' . $mofile;
448 -
449 - // Look in global /wp-content/languages/ folder
450 - if ( file_exists( $mofile_global ) )
451 - return load_textdomain( 'bbpress', $mofile_global );
452 -
453 - // Nothing found
454 - return false;
469 + // Register the default theme compatibility package
470 + bbp_register_theme_package(
471 + array(
472 + 'id' => 'default',
473 + 'name' => 'bbPress Default',
474 + 'version' => bbp_get_version(),
475 + 'dir' => trailingslashit( $this->themes_dir . 'default' ),
476 + 'url' => trailingslashit( $this->themes_url . 'default' )
477 + )
478 + );
455 479 }
456 480
457 481 /**
458 - * Sets up the bbPress theme directory to use in WordPress
482 + * Setup the default bbPress theme compatibility location.
459 483 *
460 - * @since bbPress (r2507)
461 - *
462 - * @uses register_theme_directory() To register the theme directory
463 - * @return bool True on success, false on failure
484 + * @since 2.1.0 bbPress (r3778)
464 485 */
465 - function register_theme_directory() {
466 - return register_theme_directory( $this->themes_dir );
486 + public function setup_theme() {
487 + bbp_setup_theme_compat( bbp_get_theme_package_id() );
467 488 }
468 489
469 490 /**
470 - * Setup the post types for forums, topics and replies
491 + * Load the translation file for current language. Checks the deprecated
492 + * languages folder inside the bbPress plugin first, and then the default
493 + * WordPress languages folder.
471 494 *
472 - * @todo messages
495 + * Note that custom translation files inside the bbPress plugin folder
496 + * will be removed on bbPress updates. If you're creating custom
497 + * translation files, please use the global language folder.
473 498 *
474 - * @since bbPress (r2597)
475 - *
476 - * @uses register_post_type() To register the post types
477 - * @uses apply_filters() Calls various filters to modify the arguments
478 - * sent to register_post_type()
499 + * @since 2.0.0 bbPress (r2596)
479 500 */
480 - function register_post_types() {
501 + public function load_textdomain() {
481 502
482 - /** FORUMS ************************************************************/
503 + // Define the old directory
504 + $old_dir = WP_LANG_DIR . '/bbpress/';
483 505
484 - // Forum labels
485 - $forum['labels'] = array(
486 - 'name' => __( 'Forums', 'bbpress' ),
487 - 'singular_name' => __( 'Forum', 'bbpress' ),
488 - 'add_new' => __( 'New Forum', 'bbpress' ),
489 - 'add_new_item' => __( 'Create New Forum', 'bbpress' ),
490 - 'edit' => __( 'Edit', 'bbpress' ),
491 - 'edit_item' => __( 'Edit Forum', 'bbpress' ),
492 - 'new_item' => __( 'New Forum', 'bbpress' ),
493 - 'view' => __( 'View Forum', 'bbpress' ),
494 - 'view_item' => __( 'View Forum', 'bbpress' ),
495 - 'search_items' => __( 'Search Forums', 'bbpress' ),
496 - 'not_found' => __( 'No forums found', 'bbpress' ),
497 - 'not_found_in_trash' => __( 'No forums found in Trash', 'bbpress' ),
498 - 'parent_item_colon' => __( 'Parent Forum:', 'bbpress' )
499 - );
506 + // Old location, deprecated in 2.6.0
507 + if ( is_dir( $old_dir ) ) {
500 508
501 - // Forum rewrite
502 - $forum['rewrite'] = array(
503 - 'slug' => $this->forum_slug,
504 - 'with_front' => false
505 - );
509 + // Get locale & file-name
510 + $type = is_admin() ? get_user_locale() : get_locale();
511 + $locale = apply_filters( 'plugin_locale', $type, $this->domain );
512 + $mofile = sprintf( '%1$s-%2$s.mo', $this->domain, $locale );
506 513
507 - // Forum supports
508 - $forum['supports'] = array(
509 - 'title',
510 - 'editor',
511 - 'revisions'
512 - );
514 + // Look in global /wp-content/languages/bbpress/ folder
515 + load_textdomain( $this->domain, $old_dir . $mofile );
516 + }
513 517
514 - // Forum filter
515 - $bbp_cpt['forum'] = apply_filters( 'bbp_register_forum_post_type', array(
516 - 'labels' => $forum['labels'],
517 - 'rewrite' => $forum['rewrite'],
518 - 'supports' => $forum['supports'],
519 - 'description' => __( 'bbPress Forums', 'bbpress' ),
520 - 'capabilities' => bbp_get_forum_caps(),
521 - 'capability_type' => 'forum',
522 - 'menu_position' => 56,
523 - 'has_archive' => get_page_by_path( $this->root_slug ) ? false : $this->root_slug,
524 - 'show_in_nav_menus' => true,
525 - 'public' => true,
526 - 'show_ui' => true,
527 - 'can_export' => true,
528 - 'hierarchical' => true,
529 - 'query_var' => true,
530 - 'menu_icon' => ''
531 - ) );
518 + // Look in global /wp-content/languages/plugins/
519 + load_plugin_textdomain( $this->domain, false, $this->lang_base );
520 + }
532 521
533 - // Register Forum content type
534 - register_post_type( $this->forum_post_type, $bbp_cpt['forum'] );
522 + /**
523 + * Setup the post types for forums, topics and replies
524 + *
525 + * @since 2.0.0 bbPress (r2597)
526 + */
527 + public static function register_post_types() {
535 528
536 - /** TOPICS ************************************************************/
529 + /** Forums ************************************************************/
537 530
538 - // Topic labels
539 - $topic['labels'] = array(
540 - 'name' => __( 'Topics', 'bbpress' ),
541 - 'singular_name' => __( 'Topic', 'bbpress' ),
542 - 'add_new' => __( 'New Topic', 'bbpress' ),
543 - 'add_new_item' => __( 'Create New Topic', 'bbpress' ),
544 - 'edit' => __( 'Edit', 'bbpress' ),
545 - 'edit_item' => __( 'Edit Topic', 'bbpress' ),
546 - 'new_item' => __( 'New Topic', 'bbpress' ),
547 - 'view' => __( 'View Topic', 'bbpress' ),
548 - 'view_item' => __( 'View Topic', 'bbpress' ),
549 - 'search_items' => __( 'Search Topics', 'bbpress' ),
550 - 'not_found' => __( 'No topics found', 'bbpress' ),
551 - 'not_found_in_trash' => __( 'No topics found in Trash', 'bbpress' ),
552 - 'parent_item_colon' => __( 'Forum:', 'bbpress' )
531 + // Register Forum content type
532 + register_post_type(
533 + bbp_get_forum_post_type(),
534 + apply_filters(
535 + 'bbp_register_forum_post_type',
536 + array(
537 + 'labels' => bbp_get_forum_post_type_labels(),
538 + 'rewrite' => bbp_get_forum_post_type_rewrite(),
539 + 'supports' => bbp_get_forum_post_type_supports(),
540 + 'description' => esc_html__( 'bbPress Forums', 'bbpress' ),
541 + 'capabilities' => bbp_get_forum_caps(),
542 + 'capability_type' => array( 'forum', 'forums' ),
543 + 'menu_position' => 555555,
544 + 'has_archive' => bbp_get_root_slug(),
545 + 'exclude_from_search' => true,
546 + 'show_in_nav_menus' => true,
547 + 'public' => true,
548 + 'show_ui' => current_user_can( 'bbp_forums_admin' ),
549 + 'rest_controller_class' => 'BBP_REST_Posts_Controller',
550 + 'can_export' => true,
551 + 'hierarchical' => true,
552 + 'query_var' => true,
553 + 'menu_icon' => '',
554 + 'source' => 'bbpress',
555 + )
556 + )
553 557 );
554 558
555 - // Topic rewrite
556 - $topic['rewrite'] = array(
557 - 'slug' => $this->topic_slug,
558 - 'with_front' => false
559 - );
559 + /** Topics ************************************************************/
560 560
561 - // Topic supports
562 - $topic['supports'] = array(
563 - 'title',
564 - 'editor',
565 - 'revisions'
566 - );
567 -
568 - // Topic Filter
569 - $bbp_cpt['topic'] = apply_filters( 'bbp_register_topic_post_type', array(
570 - 'labels' => $topic['labels'],
571 - 'rewrite' => $topic['rewrite'],
572 - 'supports' => $topic['supports'],
573 - 'description' => __( 'bbPress Topics', 'bbpress' ),
574 - 'capabilities' => bbp_get_topic_caps(),
575 - 'capability_type' => 'topic',
576 - 'menu_position' => 57,
577 - 'has_archive' => get_page_by_path( $this->topic_archive_slug ) ? false : $this->topic_archive_slug,
578 - 'show_in_nav_menus' => false,
579 - 'public' => true,
580 - 'show_ui' => true,
581 - 'can_export' => true,
582 - 'hierarchical' => false,
583 - 'query_var' => true,
584 - 'menu_icon' => ''
585 - ) );
586 -
587 561 // Register Topic content type
588 - register_post_type( $this->topic_post_type, $bbp_cpt['topic'] );
589 -
590 - /** REPLIES ***********************************************************/
591 -
592 - // Reply labels
593 - $reply['labels'] = array(
594 - 'name' => __( 'Replies', 'bbpress' ),
595 - 'singular_name' => __( 'Reply', 'bbpress' ),
596 - 'add_new' => __( 'New Reply', 'bbpress' ),
597 - 'add_new_item' => __( 'Create New Reply', 'bbpress' ),
598 - 'edit' => __( 'Edit', 'bbpress' ),
599 - 'edit_item' => __( 'Edit Reply', 'bbpress' ),
600 - 'new_item' => __( 'New Reply', 'bbpress' ),
601 - 'view' => __( 'View Reply', 'bbpress' ),
602 - 'view_item' => __( 'View Reply', 'bbpress' ),
603 - 'search_items' => __( 'Search Replies', 'bbpress' ),
604 - 'not_found' => __( 'No replies found', 'bbpress' ),
605 - 'not_found_in_trash' => __( 'No replies found in Trash', 'bbpress' ),
606 - 'parent_item_colon' => __( 'Topic:', 'bbpress' )
562 + register_post_type(
563 + bbp_get_topic_post_type(),
564 + apply_filters(
565 + 'bbp_register_topic_post_type',
566 + array(
567 + 'labels' => bbp_get_topic_post_type_labels(),
568 + 'rewrite' => bbp_get_topic_post_type_rewrite(),
569 + 'supports' => bbp_get_topic_post_type_supports(),
570 + 'description' => esc_html__( 'bbPress Topics', 'bbpress' ),
571 + 'capabilities' => bbp_get_topic_caps(),
572 + 'capability_type' => array( 'topic', 'topics' ),
573 + 'menu_position' => 555555,
574 + 'has_archive' => ( 'forums' === bbp_show_on_root() ) ? bbp_get_topic_archive_slug() : false,
575 + 'exclude_from_search' => true,
576 + 'show_in_nav_menus' => false,
577 + 'public' => true,
578 + 'show_ui' => current_user_can( 'bbp_topics_admin' ),
579 + 'rest_controller_class' => 'BBP_REST_Posts_Controller',
580 + 'can_export' => true,
581 + 'hierarchical' => false,
582 + 'query_var' => true,
583 + 'menu_icon' => '',
584 + 'source' => 'bbpress',
585 + )
586 + )
607 587 );
608 588
609 - // Reply rewrite
610 - $reply['rewrite'] = array(
611 - 'slug' => $this->reply_slug,
612 - 'with_front' => false
613 - );
589 + /** Replies ***********************************************************/
614 590
615 - // Reply supports
616 - $reply['supports'] = array(
617 - 'title',
618 - 'editor',
619 - 'revisions'
591 + // Register reply content type
592 + register_post_type(
593 + bbp_get_reply_post_type(),
594 + apply_filters(
595 + 'bbp_register_reply_post_type',
596 + array(
597 + 'labels' => bbp_get_reply_post_type_labels(),
598 + 'rewrite' => bbp_get_reply_post_type_rewrite(),
599 + 'supports' => bbp_get_reply_post_type_supports(),
600 + 'description' => esc_html__( 'bbPress Replies', 'bbpress' ),
601 + 'capabilities' => bbp_get_reply_caps(),
602 + 'capability_type' => array( 'reply', 'replies' ),
603 + 'menu_position' => 555555,
604 + 'exclude_from_search' => true,
605 + 'has_archive' => false,
606 + 'show_in_nav_menus' => false,
607 + 'public' => true,
608 + 'show_ui' => current_user_can( 'bbp_replies_admin' ),
609 + 'rest_controller_class' => 'BBP_REST_Posts_Controller',
610 + 'can_export' => true,
611 + 'hierarchical' => false,
612 + 'query_var' => true,
613 + 'menu_icon' => '',
614 + 'source' => 'bbpress',
615 + )
616 + )
620 617 );
621 -
622 - // Reply filter
623 - $bbp_cpt['reply'] = apply_filters( 'bbp_register_reply_post_type', array(
624 - 'labels' => $reply['labels'],
625 - 'rewrite' => $reply['rewrite'],
626 - 'supports' => $reply['supports'],
627 - 'description' => __( 'bbPress Replies', 'bbpress' ),
628 - 'capabilities' => bbp_get_reply_caps(),
629 - 'capability_type' => 'reply',
630 - 'menu_position' => 58,
631 - 'has_archive' => false,
632 - 'show_in_nav_menus' => false,
633 - 'public' => true,
634 - 'show_ui' => true,
635 - 'can_export' => true,
636 - 'hierarchical' => false,
637 - 'query_var' => true,
638 - 'menu_icon' => ''
639 - ) );
640 -
641 - // Register reply content type
642 - register_post_type( $this->reply_post_type, $bbp_cpt['reply'] );
643 618 }
644 619
645 620 /**
646 - * Register the post statuses
621 + * Register the post statuses used by bbPress
647 622 *
648 - * @since bbPress (r2727)
623 + * We do some manipulation of the 'trash' status so trashed topics and
624 + * replies can be viewed from within the theme.
649 625 *
650 - * @uses register_post_status() To register post statuses
651 - * @uses $wp_post_statuses To modify trash and private statuses
652 - * @uses current_user_can() To check if the current user is capable &
653 - * modify $wp_post_statuses accordingly
626 + * @since 2.0.0 bbPress (r2727)
654 627 */
655 - function register_post_statuses() {
656 - global $wp_post_statuses;
628 + public static function register_post_statuses() {
657 629
658 630 // Closed
659 - $status = apply_filters( 'bbp_register_closed_post_status', array(
660 - 'label' => _x( 'Closed', 'post', 'bbpress' ),
661 - 'label_count' => _nx_noop( 'Closed <span class="count">(%s)</span>', 'Closed <span class="count">(%s)</span>', 'bbpress' ),
662 - 'public' => true,
663 - 'show_in_admin_all' => true
664 - ) );
665 - register_post_status( $this->closed_status_id, $status );
631 + register_post_status(
632 + bbp_get_closed_status_id(),
633 + apply_filters(
634 + 'bbp_register_closed_post_status',
635 + array(
636 + 'label' => _x( 'Closed', 'post', 'bbpress' ),
637 + /* translators: %s: Number of closed items */
638 + 'label_count' => _nx_noop( 'Closed <span class="count">(%s)</span>', 'Closed <span class="count">(%s)</span>', 'post', 'bbpress' ),
639 + 'public' => true,
640 + 'show_in_admin_status_list' => true,
641 + 'show_in_admin_all_list' => true,
642 + 'source' => 'bbpress'
643 + )
644 + )
645 + );
666 646
667 647 // Spam
668 - $status = apply_filters( 'bbp_register_spam_post_status', array(
669 - 'label' => _x( 'Spam', 'post', 'bbpress' ),
670 - 'label_count' => _nx_noop( 'Spam <span class="count">(%s)</span>', 'Spam <span class="count">(%s)</span>', 'bbpress' ),
671 - 'protected' => true,
672 - 'exclude_from_search' => true,
673 - 'show_in_admin_status_list' => true,
674 - 'show_in_admin_all_list' => false
675 - ) );
676 - register_post_status( $this->spam_status_id, $status );
648 + register_post_status(
649 + bbp_get_spam_status_id(),
650 + apply_filters(
651 + 'bbp_register_spam_post_status',
652 + array(
653 + 'label' => _x( 'Spam', 'post', 'bbpress' ),
654 + /* translators: %s: Number of spammed items */
655 + 'label_count' => _nx_noop( 'Spam <span class="count">(%s)</span>', 'Spam <span class="count">(%s)</span>', 'post', 'bbpress' ),
656 + 'protected' => true,
657 + 'exclude_from_search' => true,
658 + 'show_in_admin_status_list' => true,
659 + 'show_in_admin_all_list' => false,
660 + 'source' => 'bbpress'
661 + )
662 + )
663 + );
677 664
678 665 // Orphan
679 - $status = apply_filters( 'bbp_register_orphan_post_status', array(
680 - 'label' => _x( 'Orphan', 'post', 'bbpress' ),
681 - 'label_count' => _nx_noop( 'Orphan <span class="count">(%s)</span>', 'Orphans <span class="count">(%s)</span>', 'bbpress' ),
682 - 'protected' => true,
683 - 'exclude_from_search' => true,
684 - 'show_in_admin_status_list' => true,
685 - 'show_in_admin_all_list' => false
686 - ) );
687 - register_post_status( $this->orphan_status_id, $status );
666 + register_post_status(
667 + bbp_get_orphan_status_id(),
668 + apply_filters(
669 + 'bbp_register_orphan_post_status',
670 + array(
671 + 'label' => _x( 'Orphan', 'post', 'bbpress' ),
672 + /* translators: %s: Number of orphaned items */
673 + 'label_count' => _nx_noop( 'Orphan <span class="count">(%s)</span>', 'Orphans <span class="count">(%s)</span>', 'post', 'bbpress' ),
674 + 'protected' => true,
675 + 'exclude_from_search' => true,
676 + 'show_in_admin_status_list' => true,
677 + 'show_in_admin_all_list' => false,
678 + 'source' => 'bbpress'
679 + )
680 + )
681 + );
688 682
689 683 // Hidden
690 - $status = apply_filters( 'bbp_register_hidden_post_status', array(
691 - 'label' => _x( 'Hidden', 'post', 'bbpress' ),
692 - 'label_count' => _nx_noop( 'Hidden <span class="count">(%s)</span>', 'Hidden <span class="count">(%s)</span>', 'bbpress' ),
693 - 'protected' => true,
694 - 'exclude_from_search' => true,
695 - 'show_in_admin_status_list' => true,
696 - 'show_in_admin_all_list' => false
697 - ) );
698 - register_post_status( $this->hidden_status_id, $status );
684 + register_post_status(
685 + bbp_get_hidden_status_id(),
686 + apply_filters(
687 + 'bbp_register_hidden_post_status',
688 + array(
689 + 'label' => _x( 'Hidden', 'post', 'bbpress' ),
690 + /* translators: %s: Number of hidden items */
691 + 'label_count' => _nx_noop( 'Hidden <span class="count">(%s)</span>', 'Hidden <span class="count">(%s)</span>', 'post', 'bbpress' ),
692 + 'private' => true,
693 + 'exclude_from_search' => true,
694 + 'show_in_admin_status_list' => true,
695 + 'show_in_admin_all_list' => true,
696 + 'source' => 'bbpress'
697 + )
698 + )
699 + );
699 700
700 701 /**
701 - * Trash fix
702 + * Trash fix.
702 703 *
703 704 * We need to remove the internal arg and change that to
704 705 * protected so that the users with 'view_trash' cap can view
705 706 * single trashed topics/replies in the front-end as wp_query
@@ -704,230 +705,440 @@
704 705 * protected so that the users with 'view_trash' cap can view
705 706 * single trashed topics/replies in the front-end as wp_query
706 707 * doesn't allow any hack for the trashed topics to be viewed.
707 708 */
708 - if ( !empty( $wp_post_statuses['trash'] ) && current_user_can( 'view_trash' ) ) {
709 - $wp_post_statuses['trash']->internal = false; // changed to protected
710 - $wp_post_statuses['trash']->protected = true;
709 + global $wp_post_statuses;
710 +
711 + if ( ! empty( $wp_post_statuses['trash'] ) ) {
712 +
713 + // User can view trash so set internal to false
714 + if ( current_user_can( 'view_trash' ) ) {
715 + $wp_post_statuses['trash']->internal = false;
716 + $wp_post_statuses['trash']->protected = true;
717 +
718 + // User cannot view trash so set internal to true
719 + } else {
720 + $wp_post_statuses['trash']->internal = true;
721 + }
711 722 }
712 723 }
713 724
714 725 /**
715 - * Register the topic tag taxonomy
726 + * Register the topic tag and forum moderator taxonomies
716 727 *
717 - * @since bbPress (r2464)
728 + * @since 2.0.0 bbPress (r2464) Added bbp_get_topic_tag_tax_id() taxonomy
729 + */
730 + public static function register_taxonomies() {
731 +
732 + // Register the topic-tag taxonomy.
733 + register_taxonomy(
734 + bbp_get_topic_tag_tax_id(),
735 + bbp_get_topic_post_type(),
736 + apply_filters(
737 + 'bbp_register_topic_taxonomy',
738 + array(
739 + 'labels' => bbp_get_topic_tag_tax_labels(),
740 + 'rewrite' => bbp_get_topic_tag_tax_rewrite(),
741 + 'capabilities' => bbp_get_topic_tag_caps(),
742 + 'update_count_callback' => 'bbp_update_topic_tag_count',
743 + 'query_var' => true,
744 + 'show_tagcloud' => true,
745 + 'hierarchical' => false,
746 + 'show_in_nav_menus' => false,
747 + 'public' => true,
748 + 'show_ui' => bbp_allow_topic_tags() && current_user_can( 'bbp_topic_tags_admin' ),
749 + 'source' => 'bbpress'
750 + )
751 + )
752 + );
753 + }
754 +
755 + /**
756 + * Register the bbPress views
718 757 *
719 - * @uses register_taxonomy() To register the taxonomy
758 + * @since 2.0.0 bbPress (r2789)
720 759 */
721 - function register_taxonomies() {
760 + public static function register_views() {
722 761
723 - // Topic tag labels
724 - $topic_tag['labels'] = array(
725 - 'name' => __( 'Topic Tags', 'bbpress' ),
726 - 'singular_name' => __( 'Topic Tag', 'bbpress' ),
727 - 'search_items' => __( 'Search Tags', 'bbpress' ),
728 - 'popular_items' => __( 'Popular Tags', 'bbpress' ),
729 - 'all_items' => __( 'All Tags', 'bbpress' ),
730 - 'edit_item' => __( 'Edit Tag', 'bbpress' ),
731 - 'update_item' => __( 'Update Tag', 'bbpress' ),
732 - 'add_new_item' => __( 'Add New Tag', 'bbpress' ),
733 - 'new_item_name' => __( 'New Tag Name', 'bbpress' )
762 + // Popular topics
763 + bbp_register_view(
764 + 'popular',
765 + esc_html__( 'Most popular topics', 'bbpress' ),
766 + apply_filters(
767 + 'bbp_register_view_popular',
768 + array(
769 + 'meta_key' => '_bbp_reply_count',
770 + 'meta_type' => 'NUMERIC',
771 + 'max_num_pages' => 1,
772 + 'orderby' => 'meta_value_num',
773 + 'show_stickies' => false
774 + )
775 + )
734 776 );
735 777
736 - // Topic tag rewrite
737 - $topic_tag['rewrite'] = array(
738 - 'slug' => $this->topic_tag_slug,
739 - 'with_front' => false
778 + // Topics with no replies
779 + bbp_register_view(
780 + 'no-replies',
781 + esc_html__( 'Topics with no replies', 'bbpress' ),
782 + apply_filters(
783 + 'bbp_register_view_no_replies',
784 + array(
785 + 'meta_key' => '_bbp_reply_count',
786 + 'meta_type' => 'NUMERIC',
787 + 'meta_value' => 1,
788 + 'meta_compare' => '<',
789 + 'orderby' => '',
790 + 'show_stickies' => false
791 + )
792 + )
740 793 );
794 + }
741 795
742 - // Topic tag filter
743 - $bbp_tt = apply_filters( 'bbp_register_topic_taxonomy', array(
744 - 'labels' => $topic_tag['labels'],
745 - 'rewrite' => $topic_tag['rewrite'],
746 - 'capabilities' => bbp_get_topic_tag_caps(),
747 - 'update_count_callback' => '_update_post_term_count',
748 - 'query_var' => true,
749 - 'show_tagcloud' => true,
750 - 'hierarchical' => false,
751 - 'public' => true,
752 - 'show_ui' => true
753 - ) );
754 -
755 - // Register the topic tag taxonomy
756 - register_taxonomy(
757 - $this->topic_tag_id, // The topic tag id
758 - $this->topic_post_type, // The topic post type
759 - $bbp_tt
760 - );
796 + /**
797 + * Register the bbPress shortcodes
798 + *
799 + * @since 2.0.0 bbPress (r3031)
800 + */
801 + public function register_shortcodes() {
802 + $this->shortcodes = new BBP_Shortcodes();
761 803 }
762 804
763 805 /**
764 - * Register the bbPress views
806 + * Register bbPress meta-data
765 807 *
766 - * @since bbPress (r2789)
808 + * Counts added in 2.6.0 to avoid negative values
767 809 *
768 - * @uses bbp_register_view() To register the views
810 + * @since 2.6.0 bbPress (r6300)
769 811 */
770 - function register_views() {
812 + public function register_meta() {
771 813
772 - // Topics with no replies
773 - $no_replies = apply_filters( 'bbp_register_view_no_replies', array(
774 - 'meta_key' => '_bbp_reply_count',
775 - 'meta_value' => 1,
776 - 'meta_compare' => '<',
777 - 'orderby' => ''
778 - ) );
814 + // Define "count" meta-type array
815 + $count = array(
779 816
780 - bbp_register_view( 'no-replies', __( 'Topics with no replies', 'bbpress' ), $no_replies );
817 + // Counts are always integers
818 + 'type' => 'integer',
819 +
820 + // Generic count description
821 + 'description' => esc_html__( 'bbPress Item Count', 'bbpress' ),
822 +
823 + // Counts are single values
824 + 'single' => true,
825 +
826 + // Counts should be made available in REST
827 + 'show_in_rest' => true,
828 +
829 + // Never allow counts to go negative
830 + 'sanitize_callback' => 'bbp_number_not_negative',
831 +
832 + // All users may update count meta data
833 + 'auth_callback' => '__return_true'
834 + );
835 +
836 + /** Post **************************************************************/
837 +
838 + // Counts
839 + register_meta( 'post', '_bbp_topic_count', $count );
840 + register_meta( 'post', '_bbp_reply_count', $count );
841 + register_meta( 'post', '_bbp_total_topic_count', $count );
842 + register_meta( 'post', '_bbp_total_reply_count', $count );
843 + register_meta( 'post', '_bbp_voice_count', $count );
844 + register_meta( 'post', '_bbp_anonymous_reply_count', $count );
845 + register_meta( 'post', '_bbp_topic_count_hidden', $count );
846 + register_meta( 'post', '_bbp_reply_count_hidden', $count );
847 + register_meta( 'post', '_bbp_total_topic_count_hidden', $count );
848 + register_meta( 'post', '_bbp_total_reply_count_hidden', $count );
849 + register_meta( 'post', '_bbp_forum_subforum_count', $count );
850 +
851 + /** User **************************************************************/
852 +
853 + // Counts
854 + register_meta( 'user', '_bbp_topic_count', $count );
855 + register_meta( 'user', '_bbp_reply_count', $count );
856 +
857 + // Activity
858 + register_meta(
859 + 'user',
860 + '_bbp_last_posted',
861 + array(
862 + 'type' => 'integer',
863 + 'description' => esc_html__( 'bbPress User Activity', 'bbpress' ),
864 + 'single' => true,
865 + 'show_in_rest' => true,
866 + 'sanitize_callback' => 'bbp_number_not_negative',
867 + 'auth_callback' => '__return_true'
868 + )
869 + );
781 870 }
782 871
783 872 /**
784 873 * Setup the currently logged-in user
785 874 *
786 - * Do not to call this prematurely, I.E. before the 'init' action has
787 - * started. This function is naturally hooked into 'init' to ensure proper
788 - * execution. get_currentuserinfo() is used to check for XMLRPC_REQUEST to
789 - * avoid xmlrpc errors.
875 + * @since 2.0.0 bbPress (r2697)
876 + */
877 + public function setup_current_user() {
878 + $this->current_user = wp_get_current_user();
879 + }
880 +
881 + /**
882 + * Setup the user engagements strategy
790 883 *
791 - * @since bbPress (r2697)
792 - *
793 - * @uses get_currentuserinfo()
794 - * @global WP_User Current user object
884 + * @since 2.6.0 bbPress (r6875)
795 885 */
796 - function setup_current_user() {
797 - global $current_user;
886 + public function setup_engagements() {
798 887
799 - if ( !isset( $current_user ) )
800 - $current_user = get_currentuserinfo();
888 + // Setup the class name
889 + $strategy = ucwords( bbp_engagements_strategy() );
890 + $class_name = "BBP_User_Engagements_{$strategy}";
801 891
802 - // Set the current user in the bbPress global
803 - $this->current_user = $current_user;
892 + // Setup the engagements interface
893 + $this->engagements = new $class_name();
804 894 }
805 895
806 896 /**
807 - * Add the bbPress-specific rewrite tags
897 + * Initialize forum-specific roles
808 898 *
809 - * @since bbPress (r2753)
810 - *
811 - * @uses add_rewrite_tag() To add the rewrite tags
899 + * @since 2.6.0
812 900 */
813 - function add_rewrite_tags() {
901 + public function roles_init() {
814 902
815 - // User Profile tag
816 - add_rewrite_tag( '%bbp_user%', '([^/]+)' );
903 + // Get role IDs
904 + $keymaster = bbp_get_keymaster_role();
905 + $moderator = bbp_get_moderator_role();
906 + $participant = bbp_get_participant_role();
907 + $spectator = bbp_get_spectator_role();
908 + $blocked = bbp_get_blocked_role();
817 909
818 - // View Page tag
819 - add_rewrite_tag( '%bbp_view%', '([^/]+)' );
910 + // Build the roles into one useful array
911 + // phpcs:disable WordPress.Arrays.ArrayKeySpacingRestrictions.TooMuchSpaceAfterKey
912 + $this->roles[ $keymaster ] = new WP_Role( 'Keymaster', bbp_get_caps_for_role( $keymaster ) );
913 + $this->roles[ $moderator ] = new WP_Role( 'Moderator', bbp_get_caps_for_role( $moderator ) );
914 + $this->roles[ $participant ] = new WP_Role( 'Participant', bbp_get_caps_for_role( $participant ) );
915 + $this->roles[ $spectator ] = new WP_Role( 'Spectator', bbp_get_caps_for_role( $spectator ) );
916 + $this->roles[ $blocked ] = new WP_Role( 'Blocked', bbp_get_caps_for_role( $blocked ) );
917 + // phpcs:enable
918 + }
820 919
821 - // Edit Page tag
822 - add_rewrite_tag( '%edit%', '([1]{1,})' );
920 + /** Custom Rewrite Rules **************************************************/
921 +
922 + /**
923 + * Add the bbPress-specific rewrite tags
924 + *
925 + * @since 2.0.0 bbPress (r2753)
926 + */
927 + public static function add_rewrite_tags() {
928 + add_rewrite_tag( '%' . bbp_get_view_rewrite_id() . '%', '([^/]+)' ); // View Page tag
929 + add_rewrite_tag( '%' . bbp_get_edit_rewrite_id() . '%', '([1]{1,})' ); // Edit Page tag
930 + add_rewrite_tag( '%' . bbp_get_search_rewrite_id() . '%', '([^/]+)' ); // Search Results tag
931 + add_rewrite_tag( '%' . bbp_get_user_rewrite_id() . '%', '([^/]+)' ); // User Profile tag
932 + add_rewrite_tag( '%' . bbp_get_user_favorites_rewrite_id() . '%', '([1]{1,})' ); // User Favorites tag
933 + add_rewrite_tag( '%' . bbp_get_user_subscriptions_rewrite_id() . '%', '([1]{1,})' ); // User Subscriptions tag
934 + add_rewrite_tag( '%' . bbp_get_user_engagements_rewrite_id() . '%', '([1]{1,})' ); // User Engagements tag
935 + add_rewrite_tag( '%' . bbp_get_user_topics_rewrite_id() . '%', '([1]{1,})' ); // User Topics Tag
936 + add_rewrite_tag( '%' . bbp_get_user_replies_rewrite_id() . '%', '([1]{1,})' ); // User Replies Tag
823 937 }
824 938
825 939 /**
826 - * Register bbPress-specific rewrite rules
940 + * Add bbPress-specific rewrite rules for uri's that are not
941 + * setup for us by way of custom post types or taxonomies. This includes:
942 + * - Front-end editing
943 + * - Topic views
944 + * - User profiles
827 945 *
828 - * @since bbPress (r2688)
946 + * @since 2.0.0 bbPress (r2688)
829 947 *
830 - * @param WP_Rewrite $wp_rewrite bbPress-sepecific rules are appended in
831 - * $wp_rewrite->rules
948 + * @todo Extract into an API
832 949 */
833 - function generate_rewrite_rules( $wp_rewrite ) {
950 + public static function add_rewrite_rules() {
834 951
835 - // New rules to merge with existing
836 - $bbp_rules = array(
952 + /** Setup *************************************************************/
837 953
838 - // Edit Topic/Reply
839 - $this->topic_slug . '/([^/]+)/edit/?$' => 'index.php?' . $this->topic_post_type . '=' . $wp_rewrite->preg_index( 1 ) . '&edit=1',
840 - $this->reply_slug . '/([^/]+)/edit/?$' => 'index.php?' . $this->reply_post_type . '=' . $wp_rewrite->preg_index( 1 ) . '&edit=1',
954 + // Add rules to top or bottom?
955 + $priority = 'top';
841 956
842 - // Profile Page
843 - $this->user_slug . '/([^/]+)/page/?([0-9]{1,})/?$' => 'index.php?bbp_user=' . $wp_rewrite->preg_index( 1 ) . '&paged=' . $wp_rewrite->preg_index( 2 ),
844 - $this->user_slug . '/([^/]+)/?$' => 'index.php?bbp_user=' . $wp_rewrite->preg_index( 1 ),
845 - $this->user_slug . '/([^/]+)/edit/?$' => 'index.php?bbp_user=' . $wp_rewrite->preg_index( 1 ) . '&edit=1',
957 + // Single Slugs
958 + $forum_slug = bbp_get_forum_slug();
959 + $topic_slug = bbp_get_topic_slug();
960 + $reply_slug = bbp_get_reply_slug();
961 + $ttag_slug = bbp_get_topic_tag_tax_slug();
846 962
847 - // @todo - favorites feeds
848 - //$this->user_slug . '/([^/]+)/(feed|rdf|rss|rss2|atom)/?$' => 'index.php?bbp_user=' . $wp_rewrite->preg_index( 1 ) . '&feed=' . $wp_rewrite->preg_index( 2 ),
849 - //$this->user_slug . '/([^/]+)/feed/(feed|rdf|rss|rss2|atom)/?$' => 'index.php?bbp_user=' . $wp_rewrite->preg_index( 1 ) . '&feed=' . $wp_rewrite->preg_index( 2 ),
963 + // Archive Slugs
964 + $user_slug = bbp_get_user_slug();
965 + $view_slug = bbp_get_view_slug();
966 + $search_slug = bbp_get_search_slug();
967 + $topic_archive_slug = bbp_get_topic_archive_slug();
968 + $reply_archive_slug = bbp_get_reply_archive_slug();
850 969
851 - // @todo - view feeds
852 - //$this->view_slug . '/([^/]+)/feed/(feed|rdf|rss|rss2|atom)/?$' => 'index.php?bbp_view=' . $wp_rewrite->preg_index( 1 ) . '&feed=' . $wp_rewrite->preg_index( 2 ),
970 + // Tertiary Slugs
971 + $feed_slug = 'feed';
972 + $edit_slug = bbp_get_edit_slug();
973 + $paged_slug = bbp_get_paged_slug();
974 + $user_favs_slug = bbp_get_user_favorites_slug();
975 + $user_subs_slug = bbp_get_user_subscriptions_slug();
976 + $user_engs_slug = bbp_get_user_engagements_slug();
853 977
854 - // View Page
855 - $this->view_slug . '/([^/]+)/page/?([0-9]{1,})/?$' => 'index.php?bbp_view=' . $wp_rewrite->preg_index( 1 ) . '&paged=' . $wp_rewrite->preg_index( 2 ),
856 - $this->view_slug . '/([^/]+)/?$' => 'index.php?bbp_view=' . $wp_rewrite->preg_index( 1 )
857 - );
978 + // Unique rewrite ID's
979 + $feed_id = 'feed';
980 + $edit_id = bbp_get_edit_rewrite_id();
981 + $view_id = bbp_get_view_rewrite_id();
982 + $paged_id = bbp_get_paged_rewrite_id();
983 + $search_id = bbp_get_search_rewrite_id();
984 + $user_id = bbp_get_user_rewrite_id();
985 + $user_favs_id = bbp_get_user_favorites_rewrite_id();
986 + $user_subs_id = bbp_get_user_subscriptions_rewrite_id();
987 + $user_tops_id = bbp_get_user_topics_rewrite_id();
988 + $user_reps_id = bbp_get_user_replies_rewrite_id();
989 + $user_engs_id = bbp_get_user_engagements_rewrite_id();
858 990
859 - // Merge bbPress rules with existing
860 - $wp_rewrite->rules = array_merge( $bbp_rules, $wp_rewrite->rules );
991 + // Rewrite rule matches used repeatedly below
992 + $root_rule = '/([^/]+)/?$';
993 + $feed_rule = '/([^/]+)/' . $feed_slug . '/?$';
994 + $edit_rule = '/([^/]+)/' . $edit_slug . '/?$';
995 + $paged_rule = '/([^/]+)/' . $paged_slug . '/?([0-9]{1,})/?$';
861 996
862 - // Return merged rules
863 - return $wp_rewrite;
997 + // Search rules (without slug check)
998 + $search_root_rule = '/?$';
999 + $search_paged_rule = '/' . $paged_slug . '/?([0-9]{1,})/?$';
1000 +
1001 + /** Add ***************************************************************/
1002 +
1003 + // User profile rules
1004 + $tops_rule = '/([^/]+)/' . $topic_archive_slug . '/?$';
1005 + $reps_rule = '/([^/]+)/' . $reply_archive_slug . '/?$';
1006 + $favs_rule = '/([^/]+)/' . $user_favs_slug . '/?$';
1007 + $subs_rule = '/([^/]+)/' . $user_subs_slug . '/?$';
1008 + $engs_rule = '/([^/]+)/' . $user_engs_slug . '/?$';
1009 + $tops_paged_rule = '/([^/]+)/' . $topic_archive_slug . '/' . $paged_slug . '/?([0-9]{1,})/?$';
1010 + $reps_paged_rule = '/([^/]+)/' . $reply_archive_slug . '/' . $paged_slug . '/?([0-9]{1,})/?$';
1011 + $favs_paged_rule = '/([^/]+)/' . $user_favs_slug . '/' . $paged_slug . '/?([0-9]{1,})/?$';
1012 + $subs_paged_rule = '/([^/]+)/' . $user_subs_slug . '/' . $paged_slug . '/?([0-9]{1,})/?$';
1013 + $engs_paged_rule = '/([^/]+)/' . $user_engs_slug . '/' . $paged_slug . '/?([0-9]{1,})/?$';
1014 +
1015 + // Edit Forum|Topic|Reply|Topic-tag
1016 + add_rewrite_rule( $forum_slug . $edit_rule, 'index.php?' . bbp_get_forum_post_type() . '=$matches[1]&' . $edit_id . '=1', $priority );
1017 + add_rewrite_rule( $topic_slug . $edit_rule, 'index.php?' . bbp_get_topic_post_type() . '=$matches[1]&' . $edit_id . '=1', $priority );
1018 + add_rewrite_rule( $reply_slug . $edit_rule, 'index.php?' . bbp_get_reply_post_type() . '=$matches[1]&' . $edit_id . '=1', $priority );
1019 + add_rewrite_rule( $ttag_slug . $edit_rule, 'index.php?' . bbp_get_topic_tag_tax_id() . '=$matches[1]&' . $edit_id . '=1', $priority );
1020 +
1021 + // User Pagination|Edit|View
1022 + add_rewrite_rule( $user_slug . $tops_paged_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_tops_id . '=1&' . $paged_id . '=$matches[2]', $priority );
1023 + add_rewrite_rule( $user_slug . $reps_paged_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_reps_id . '=1&' . $paged_id . '=$matches[2]', $priority );
1024 + add_rewrite_rule( $user_slug . $favs_paged_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_favs_id . '=1&' . $paged_id . '=$matches[2]', $priority );
1025 + add_rewrite_rule( $user_slug . $subs_paged_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_subs_id . '=1&' . $paged_id . '=$matches[2]', $priority );
1026 + add_rewrite_rule( $user_slug . $engs_paged_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_engs_id . '=1&' . $paged_id . '=$matches[2]', $priority );
1027 + add_rewrite_rule( $user_slug . $tops_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_tops_id . '=1', $priority );
1028 + add_rewrite_rule( $user_slug . $reps_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_reps_id . '=1', $priority );
1029 + add_rewrite_rule( $user_slug . $favs_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_favs_id . '=1', $priority );
1030 + add_rewrite_rule( $user_slug . $subs_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_subs_id . '=1', $priority );
1031 + add_rewrite_rule( $user_slug . $engs_rule, 'index.php?' . $user_id . '=$matches[1]&' . $user_engs_id . '=1', $priority );
1032 + add_rewrite_rule( $user_slug . $edit_rule, 'index.php?' . $user_id . '=$matches[1]&' . $edit_id . '=1', $priority );
1033 + add_rewrite_rule( $user_slug . $root_rule, 'index.php?' . $user_id . '=$matches[1]', $priority );
1034 +
1035 + // Topic-View Pagination|Feed|View
1036 + add_rewrite_rule( $view_slug . $paged_rule, 'index.php?' . $view_id . '=$matches[1]&' . $paged_id . '=$matches[2]', $priority );
1037 + add_rewrite_rule( $view_slug . $feed_rule, 'index.php?' . $view_id . '=$matches[1]&' . $feed_id . '=$matches[2]', $priority );
1038 + add_rewrite_rule( $view_slug . $root_rule, 'index.php?' . $view_id . '=$matches[1]', $priority );
1039 +
1040 + // Search All
1041 + add_rewrite_rule( $search_slug . $search_paged_rule, 'index.php?' . $paged_id .'=$matches[1]', $priority );
1042 + add_rewrite_rule( $search_slug . $search_root_rule, 'index.php?' . $search_id, $priority );
864 1043 }
865 1044
866 1045 /**
867 - * If not using a bbPress compatable theme, enqueue some basic styling and js
1046 + * Add permalink structures for new archive-style destinations.
868 1047 *
869 - * @since bbPress (r3029)
1048 + * - Users
1049 + * - Topic Views
1050 + * - Search
870 1051 *
871 - * @global bbPress $bbp
872 - * @uses bbp_set_theme_compat() Set the compatable theme to bbp-twentyten
873 - * @uses current_theme_supports() Check bbPress theme support
874 - * @uses wp_enqueue_style() Enqueue the bbp-twentyten default CSS
875 - * @uses wp_enqueue_script() Enqueue the bbp-twentyten default topic JS
1052 + * @since 2.4.0 bbPress (r4930)
876 1053 */
877 - function theme_compat() {
878 - global $bbp;
1054 + public static function add_permastructs() {
879 1055
880 - // Check if current theme supports bbPress
881 - if ( !current_theme_supports( 'bbpress' ) ) {
1056 + // Get unique ID's
1057 + $user_id = bbp_get_user_rewrite_id();
1058 + $view_id = bbp_get_view_rewrite_id();
1059 + $search_id = bbp_get_search_rewrite_id();
882 1060
883 - // Set the compat_theme global for help with loading template parts
884 - bbp_set_theme_compat( $bbp->themes_dir . '/bbp-twentyten' );
1061 + // Get root slugs
1062 + $user_slug = bbp_get_user_slug();
1063 + $view_slug = bbp_get_view_slug();
1064 + $search_slug = bbp_get_search_slug();
885 1065
886 - // Load up the default bbPress CSS from bbp-twentyten
887 - wp_enqueue_style ( 'bbpress-style', $bbp->themes_url . '/bbp-twentyten/css/bbpress.css' );
888 - }
1066 + // User Permastruct
1067 + add_permastruct(
1068 + $user_id,
1069 + $user_slug . '/%' . $user_id . '%',
1070 + array(
1071 + 'with_front' => false,
1072 + 'ep_mask' => EP_NONE,
1073 + 'paged' => false,
1074 + 'feed' => false,
1075 + 'forcomments' => false,
1076 + 'walk_dirs' => true,
1077 + 'endpoints' => false,
1078 + )
1079 + );
1080 +
1081 + // Topic View Permastruct
1082 + add_permastruct(
1083 + $view_id,
1084 + $view_slug . '/%' . $view_id . '%',
1085 + array(
1086 + 'with_front' => false,
1087 + 'ep_mask' => EP_NONE,
1088 + 'paged' => false,
1089 + 'feed' => false,
1090 + 'forcomments' => false,
1091 + 'walk_dirs' => true,
1092 + 'endpoints' => false,
1093 + )
1094 + );
1095 +
1096 + // Search Permastruct
1097 + add_permastruct(
1098 + $search_id,
1099 + $search_slug . '/%' . $search_id . '%',
1100 + array(
1101 + 'with_front' => false,
1102 + 'ep_mask' => EP_NONE,
1103 + 'paged' => true,
1104 + 'feed' => false,
1105 + 'forcomments' => false,
1106 + 'walk_dirs' => true,
1107 + 'endpoints' => false,
1108 + )
1109 + );
889 1110 }
890 1111 }
891 1112
892 -// "And now here's something we hope you'll really like!"
893 -$bbp = new bbPress();
894 -
895 -endif; // class_exists check
896 -
897 1113 /**
898 - * Runs on bbPress activation
1114 + * The main function responsible for returning the one true bbPress Instance
1115 + * to functions everywhere.
899 1116 *
900 - * @since bbPress (r2509)
1117 + * Use this function like you would a global variable, except without needing
1118 + * to declare the global.
901 1119 *
902 - * @uses register_uninstall_hook() To register our own uninstall hook
903 - * @uses do_action() Calls 'bbp_activation' hook
904 - */
905 -function bbp_activation() {
906 - register_uninstall_hook( __FILE__, 'bbp_uninstall' );
907 -
908 - do_action( 'bbp_activation' );
909 -}
910 -
911 -/**
912 - * Runs on bbPress deactivation
1120 + * Example: <?php $bbp = bbpress(); ?>
913 1121 *
914 - * @since bbPress (r2509)
1122 + * @since 2.0.0 bbPress (r2464)
915 1123 *
916 - * @uses do_action() Calls 'bbp_deactivation' hook
1124 + * @return bbPress The one true bbPress Instance
917 1125 */
918 -function bbp_deactivation() {
919 - do_action( 'bbp_deactivation' );
1126 +function bbpress() {
1127 + return bbPress::instance();
920 1128 }
921 1129
922 1130 /**
923 - * Runs when uninstalling bbPress
1131 + * Hook bbPress early onto the 'plugins_loaded' action.
924 1132 *
925 - * @since bbPress (r2509)
926 - *
927 - * @uses do_action() Calls 'bbp_uninstall' hook
1133 + * This gives all other plugins the chance to load before bbPress, to get their
1134 + * actions, filters, and overrides setup without bbPress being in the way.
928 1135 */
929 -function bbp_uninstall() {
930 - do_action( 'bbp_uninstall' );
1136 +if ( defined( 'BBPRESS_LATE_LOAD' ) ) {
1137 + add_action( 'plugins_loaded', 'bbpress', (int) BBPRESS_LATE_LOAD );
1138 +
1139 +// "And now here's something we hope you'll really like!"
1140 +} else {
1141 + bbpress();
931 1142 }
932 1143
933 -?>
1144 +endif; // class_exists check