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 +850 -687 2.0-rc-22.6.17 View file →
@@ -4,768 +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-rc-2
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 30 // Exit if accessed directly
22 -if ( !defined( 'ABSPATH' ) ) exit;
31 +defined( 'ABSPATH' ) || exit;
23 32
24 -if ( !class_exists( 'bbPress' ) ) :
33 +if ( ! class_exists( 'bbPress' ) ) :
25 34 /**
26 35 * Main bbPress Class
27 36 *
28 - * Tap tap tap... Is this thing on?
37 + * "Word hard. Stay bumble."
29 38 *
30 - * @since bbPress (r2464)
39 + * @since 2.0.0 bbPress (r2464)
31 40 */
32 -class bbPress {
41 +final class bbPress {
33 42
34 - /** Version ***************************************************************/
43 + /** Magic *****************************************************************/
35 44
36 45 /**
37 - * @public string bbPress version
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
38 55 */
39 - public $version = '2.0-rc-2';
56 + private $data;
40 57
41 - /** Post types ************************************************************/
58 + /** Not Magic *************************************************************/
42 59
43 60 /**
44 - * @public string Forum post type id
61 + * @var mixed False when not logged in; WP_User object when logged in
45 62 */
46 - public $forum_post_type = '';
63 + public $current_user = false;
47 64
48 65 /**
49 - * @public string Topic post type id
66 + * @var stdClass Add-ons append to this (Akismet, BuddyPress, etc...)
50 67 */
51 - public $topic_post_type = '';
68 + public $extend;
52 69
53 70 /**
54 - * @ string Reply post type id
71 + * @var array Topic views
55 72 */
56 - public $reply_post_type = '';
73 + public $views = array();
57 74
58 - /** Taxonomies ************************************************************/
59 -
60 75 /**
61 - * @public string Topic tag id
76 + * @var array Overloads get_option()
62 77 */
63 - public $topic_tag_tax_id = '';
78 + public $options = array();
64 79
65 - /** Permastructs **********************************************************/
66 -
67 80 /**
68 - * @public string User struct
81 + * @var array Storage of options not in the database
69 82 */
70 - public $user_id = '';
83 + public $not_options = array();
71 84
72 85 /**
73 - * @public string View struct
86 + * @var array Overloads get_user_meta()
74 87 */
75 - public $view_id = '';
88 + public $user_options = array();
76 89
77 90 /**
78 - * @public string Edit struct
91 + * @var array Dynamically initialized user roles
79 92 */
80 - public $edit_id = '';
93 + public $roles = array();
81 94
82 - /** Post statuses *********************************************************/
95 + /** Singleton *************************************************************/
83 96
84 97 /**
85 - * @public string Closed post status id. Used by topics.
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
86 112 */
87 - public $closed_status_id = '';
113 + public static function instance() {
88 114
89 - /**
90 - * @public string Spam post status id. Used by topics and replies.
91 - */
92 - public $spam_status_id = '';
115 + // Store the instance locally to avoid private static replication
116 + static $instance = null;
93 117
94 - /**
95 - * @public string Trash post status id. Used by topics and replies.
96 - */
97 - public $trash_status_id = '';
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 + }
98 126
99 - /**
100 - * @public string Orphan post status id. Used by topics and replies.
101 - */
102 - public $orphan_status_id = '';
127 + // Always return the instance
128 + return $instance;
129 + }
103 130
104 - /**
105 - * @public string Hidden post status id. Used by forums.
106 - */
107 - public $hidden_status_id = '';
131 + /** Magic Methods *********************************************************/
108 132
109 - /** Slugs *****************************************************************/
110 -
111 133 /**
112 - * @public string Root 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();
113 140 */
114 - public $root_slug = '';
141 + private function __construct() {
142 + /* Do nothing here */
143 + }
115 144
116 145 /**
117 - * @public string Forum slug
146 + * A dummy magic method to prevent bbPress from being cloned
147 + *
148 + * @since 2.0.0 bbPress (r2464)
118 149 */
119 - public $forum_slug = '';
150 + public function __clone() {
151 + _doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'bbpress' ), '2.1' );
152 + }
120 153
121 154 /**
122 - * @public string Topic slug
155 + * A dummy magic method to prevent bbPress from being unserialized
156 + *
157 + * @since 2.0.0 bbPress (r2464)
123 158 */
124 - public $topic_slug = '';
159 + public function __wakeup() {
160 + _doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'bbpress' ), '2.1' );
161 + }
125 162
126 163 /**
127 - * @public string Topic archive slug
164 + * Magic method for checking the existence of a certain custom field
165 + *
166 + * @since 2.1.0 bbPress (r3951)
128 167 */
129 - public $topic_archive_slug = '';
168 + public function __isset( $key ) {
169 + return isset( $this->data[ $key ] );
170 + }
130 171
131 172 /**
132 - * @public string Reply slug
173 + * Magic method for getting bbPress variables
174 + *
175 + * @since 2.1.0 bbPress (r3951)
133 176 */
134 - public $reply_slug = '';
177 + public function __get( $key ) {
178 + return isset( $this->data[ $key ] )
179 + ? $this->data[ $key ]
180 + : null;
181 + }
135 182
136 183 /**
137 - * @public string Topic tag slug
184 + * Magic method for setting bbPress variables
185 + *
186 + * @since 2.1.0 bbPress (r3951)
138 187 */
139 - public $topic_tag_slug = '';
188 + public function __set( $key, $value ) {
189 + $this->data[ $key ] = $value;
190 + }
140 191
141 192 /**
142 - * @public string User slug
193 + * Magic method for unsetting bbPress variables
194 + *
195 + * @since 2.3.0 bbPress (r4628)
143 196 */
144 - public $user_slug = '';
197 + public function __unset( $key ) {
198 + if ( isset( $this->data[ $key ] ) ) {
199 + unset( $this->data[ $key ] );
200 + }
201 + }
145 202
146 203 /**
147 - * @public string View slug
204 + * Magic method to prevent notices and errors from invalid method calls
205 + *
206 + * @since 2.2.0 bbPress (r4252)
148 207 */
149 - public $view_slug = '';
208 + public function __call( $name = '', $args = array() ) {
209 + unset( $name, $args );
210 + return null;
211 + }
150 212
151 - /** Paths *****************************************************************/
213 + /** Private Methods *******************************************************/
152 214
153 215 /**
154 - * @public string Basename of the bbPress plugin directory
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
155 222 */
156 - public $basename = '';
223 + private function setup_environment() {
157 224
158 - /**
159 - * @public string Absolute path to the bbPress plugin directory
160 - */
161 - public $plugin_dir = '';
225 + /** Versions **********************************************************/
162 226
163 - /**
164 - * @public string Absolute path to the bbPress themes directory
165 - */
166 - public $themes_dir = '';
227 + $this->version = '2.6.17';
228 + $this->db_version = '263';
167 229
168 - /**
169 - * @public string Absolute path to the bbPress language directory
170 - */
171 - public $lang_dir = '';
230 + /** Paths *************************************************************/
172 231
173 - /** URLs ******************************************************************/
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 ) ) );
174 236
175 - /**
176 - * @public string URL to the bbPress plugin directory
177 - */
178 - public $plugin_url = '';
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 ) );
179 240
180 - /**
181 - * @public string URL to the bbPress themes directory
182 - */
183 - public $themes_url = '';
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' ) );
184 244
185 - /** Current ID's **********************************************************/
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' ) );
186 248
187 - /**
188 - * @public string Current forum id
189 - */
190 - public $current_forum_id = 0;
191 -
192 - /**
193 - * @public string Current topic id
194 - */
195 - public $current_topic_id = 0;
196 -
197 - /**
198 - * @public string Current reply id
199 - */
200 - public $current_reply_id = 0;
201 -
202 - /** Users *****************************************************************/
203 -
204 - /**
205 - * @public object Current user
206 - */
207 - public $current_user = array();
208 -
209 - /**
210 - * @public object Displayed user
211 - */
212 - public $displayed_user = array();
213 -
214 - /** Queries ***************************************************************/
215 -
216 - /**
217 - * @public WP_Query For forums
218 - */
219 - public $forum_query;
220 -
221 - /**
222 - * @public WP_Query For topics
223 - */
224 - public $topic_query;
225 -
226 - /**
227 - * @public WP_Query For replies
228 - */
229 - public $reply_query;
230 -
231 - /** Arrays ****************************************************************/
232 -
233 - /**
234 - * @public array Sub Forums
235 - */
236 - public $sub_forums = array();
237 -
238 - /** Errors ****************************************************************/
239 -
240 - /**
241 - * @public WP_Error Used to log and display errors
242 - */
243 - public $errors = array();
244 -
245 - /** Views *****************************************************************/
246 -
247 - /**
248 - * @public array An array of registered bbPress views
249 - */
250 - public $views = array();
251 -
252 - /** Forms *****************************************************************/
253 -
254 - /**
255 - * @public int The current tab index for form building
256 - */
257 - public $tab_index = 0;
258 -
259 - /** Theme Compat **********************************************************/
260 -
261 - /**
262 - * @public string Theme to use for theme compatibility
263 - */
264 - public $theme_compat = '';
265 -
266 - /** Extensions ************************************************************/
267 -
268 - /**
269 - * @public mixed bbPress add-ons should append globals to this
270 - */
271 - public $extend = false;
272 -
273 - /** Functions *************************************************************/
274 -
275 - /**
276 - * The main bbPress loader (PHP4 compat)
277 - *
278 - * @since bbPress (r2464)
279 - *
280 - * @uses bbPress::__construct() Setup the globals needed
281 - */
282 - public function bbPress() {
283 - $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' ) );
284 252 }
285 253
286 254 /**
287 - * The main bbPress loader
255 + * Smart defaults to many bbPress specific class variables.
288 256 *
289 - * @since bbPress (r2464)
290 - *
291 - * @uses bbPress::setup_globals() Setup the globals needed
292 - * @uses bbPress::includes() Include the required files
293 - * @uses bbPress::setup_actions() Setup the hooks and actions
257 + * @since 2.6.0 bbPress (r6330)
294 258 */
295 - public function __construct() {
296 - $this->setup_globals();
297 - $this->includes();
298 - $this->setup_actions();
299 - }
259 + private function setup_variables() {
300 260
301 - /**
302 - * Component global variables
303 - *
304 - * @since bbPress (r2626)
305 - * @access private
306 - *
307 - * @uses plugin_dir_path() To generate bbPress plugin path
308 - * @uses plugin_dir_url() To generate bbPress plugin url
309 - * @uses apply_filters() Calls various filters
310 - */
311 - private function setup_globals() {
312 -
313 - /** Paths *************************************************************/
314 -
315 - // bbPress root directory
316 - $this->file = __FILE__;
317 - $this->basename = plugin_basename( $this->file );
318 - $this->plugin_dir = plugin_dir_path( $this->file );
319 - $this->plugin_url = plugin_dir_url ( $this->file );
320 -
321 - // Themes
322 - $this->themes_dir = $this->plugin_dir . 'bbp-themes';
323 - $this->themes_url = $this->plugin_url . 'bbp-themes';
324 -
325 - // Languages
326 - $this->lang_dir = $this->plugin_dir . 'bbp-languages';
327 -
328 261 /** Identifiers *******************************************************/
329 262
330 263 // Post type identifiers
331 - $this->forum_post_type = apply_filters( 'bbp_forum_post_type', 'forum' );
332 - $this->topic_post_type = apply_filters( 'bbp_topic_post_type', 'topic' );
333 - $this->reply_post_type = apply_filters( 'bbp_reply_post_type', 'reply' );
334 - $this->topic_tag_tax_id = apply_filters( 'bbp_topic_tag_tax_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' );
335 268
336 269 // Status identifiers
337 - $this->spam_status_id = apply_filters( 'bbp_spam_post_status', 'spam' );
338 - $this->closed_status_id = apply_filters( 'bbp_closed_post_status', 'closed' );
339 - $this->orphan_status_id = apply_filters( 'bbp_orphan_post_status', 'orphan' );
340 - $this->hidden_status_id = apply_filters( 'bbp_hidden_post_status', 'hidden' );
341 - $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' );
342 278
343 279 // Other identifiers
344 - $this->user_id = apply_filters( 'bbp_user_id', 'bbp_user' );
345 - $this->view_id = apply_filters( 'bbp_view_id', 'bbp_view' );
346 - $this->edit_id = apply_filters( 'bbp_edit_id', 'edit' );
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' );
347 290
348 - /** Slugs *************************************************************/
291 + /** Queries ***********************************************************/
349 292
350 - // Root forum slug
351 - $this->root_slug = apply_filters( 'bbp_root_slug', get_option( '_bbp_root_slug', 'forums' ) );
352 - $this->topic_archive_slug = apply_filters( 'bbp_topic_archive_slug', get_option( '_bbp_topic_archive_slug', 'topics' ) );
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
353 299
354 - // Should we include the root slug in front of component slugs
355 - $prefix = !empty( $this->root_slug ) && get_option( '_bbp_include_root', true ) ? trailingslashit( $this->root_slug ) : '';
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
356 305
357 - // Component slugs
358 - $this->forum_slug = apply_filters( 'bbp_forum_slug', $prefix . get_option( '_bbp_forum_slug', 'forum' ) );
359 - $this->topic_slug = apply_filters( 'bbp_topic_slug', $prefix . get_option( '_bbp_topic_slug', 'topic' ) );
360 - $this->reply_slug = apply_filters( 'bbp_reply_slug', $prefix . get_option( '_bbp_reply_slug', 'reply' ) );
306 + /** Theme Compat ******************************************************/
361 307
362 - // Taxonomy slugs
363 - $this->topic_tag_slug = apply_filters( 'bbp_topic_tag_slug', $prefix . get_option( '_bbp_topic_tag_slug', 'topic-tag' ) );
308 + $this->theme_compat = new stdClass(); // Base theme compatibility class
309 + $this->filters = new stdClass(); // Used when adding/removing filters
364 310
365 - /** Other Slugs *******************************************************/
311 + /** Users *************************************************************/
366 312
367 - $this->user_slug = apply_filters( 'bbp_user_slug', $prefix . get_option( '_bbp_user_slug', 'user' ) );
368 - $this->view_slug = apply_filters( 'bbp_view_slug', $prefix . get_option( '_bbp_view_slug', 'view' ) );
313 + $this->current_user = new WP_User(); // Currently logged in user
314 + $this->displayed_user = new WP_User(); // Currently displayed user
369 315
370 - /** Queries ***********************************************************/
371 -
372 - $this->forum_query = new stdClass;
373 - $this->topic_query = new stdClass;
374 - $this->reply_query = new stdClass;
375 -
376 316 /** Misc **************************************************************/
377 317
378 - // Errors
379 - $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
380 321
381 - // Views
382 - $this->views = array();
322 + /** Deprecated ********************************************************/
383 323
384 - // Tab Index
385 - $this->tab_index = apply_filters( 'bbp_default_tab_index', 100 );
386 -
387 - /** Cache *************************************************************/
388 -
389 - // Add bbPress to global cache groups
390 - wp_cache_add_global_groups( 'bbpress' );
324 + $this->tab_index = apply_filters( 'bbp_default_tab_index', 100 );
391 325 }
392 326
393 327 /**
394 328 * Include required files
395 329 *
396 - * @since bbPress (r2626)
330 + * @since 2.0.0 bbPress (r2626)
331 + *
397 332 * @access private
398 - *
399 - * @uses is_admin() If in WordPress admin, load additional file
400 333 */
401 334 private function includes() {
402 335
403 336 /** Core **************************************************************/
404 337
405 - require( $this->plugin_dir . 'bbp-includes/bbp-core-hooks.php' ); // All filters and actions
406 - require( $this->plugin_dir . 'bbp-includes/bbp-core-options.php' ); // Configuration Options
407 - require( $this->plugin_dir . 'bbp-includes/bbp-core-caps.php' ); // Roles and capabilities
408 - require( $this->plugin_dir . 'bbp-includes/bbp-core-classes.php' ); // Common classes
409 - require( $this->plugin_dir . 'bbp-includes/bbp-core-widgets.php' ); // Sidebar widgets
410 - require( $this->plugin_dir . 'bbp-includes/bbp-core-shortcodes.php' ); // Shortcodes for use with pages and posts
411 - require( $this->plugin_dir . 'bbp-includes/bbp-core-compatibility.php' ); // Theme compatibility for existing themes
412 -
413 - /** Extensions ********************************************************/
414 -
415 - require( $this->plugin_dir . 'bbp-includes/bbp-extend-akismet.php' ); // Spam prevention for topics and replies
416 - require( $this->plugin_dir . 'bbp-includes/bbp-extend-buddypress.php' ); // Social network integration
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';
417 348
418 349 /** Components ********************************************************/
419 350
420 - require( $this->plugin_dir . 'bbp-includes/bbp-common-functions.php' ); // Common functions
421 - require( $this->plugin_dir . 'bbp-includes/bbp-common-template.php' ); // Common template tags
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';
422 364
423 - require( $this->plugin_dir . 'bbp-includes/bbp-forum-functions.php' ); // Forum functions
424 - require( $this->plugin_dir . 'bbp-includes/bbp-forum-template.php' ); // Forum template tags
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';
425 369
426 - require( $this->plugin_dir . 'bbp-includes/bbp-topic-functions.php' ); // Topic functions
427 - require( $this->plugin_dir . 'bbp-includes/bbp-topic-template.php' ); // Topic template tags
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';
428 374
429 - require( $this->plugin_dir . 'bbp-includes/bbp-reply-functions.php' ); // Reply functions
430 - require( $this->plugin_dir . 'bbp-includes/bbp-reply-template.php' ); // Reply template tags
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';
431 379
432 - require( $this->plugin_dir . 'bbp-includes/bbp-user-functions.php' ); // User functions
433 - require( $this->plugin_dir . 'bbp-includes/bbp-user-template.php' ); // User template tags
380 + // Search
381 + require $this->includes_dir . 'search/functions.php';
382 + require $this->includes_dir . 'search/template.php';
434 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 +
435 398 /** Admin *************************************************************/
436 399
437 400 // Quick admin check and load if needed
438 - if ( is_admin() )
439 - require( $this->plugin_dir . 'bbp-admin/bbp-admin.php' );
401 + if ( is_admin() ) {
402 + require $this->includes_dir . 'admin/actions.php';
403 + }
440 404 }
441 405
442 406 /**
443 407 * Setup the default hooks and actions
444 408 *
445 - * @since bbPress (r2644)
409 + * @since 2.0.0 bbPress (r2644)
410 + *
446 411 * @access private
447 - *
448 - * @uses register_activation_hook() To register the activation hook
449 - * @uses register_deactivation_hook() To register the deactivation hook
450 - * @uses add_action() To add various actions
451 412 */
452 413 private function setup_actions() {
453 414
454 - // Register bbPress activation/deactivation sequences
455 - register_activation_hook ( $this->file, 'bbp_activation' );
456 - 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' );
457 418
419 + // If bbPress is being deactivated, do not add any actions
420 + if ( bbp_is_deactivation( $this->basename ) ) {
421 + return;
422 + }
423 +
458 424 // Array of bbPress core actions
459 425 $actions = array(
426 + 'setup_theme', // Setup the default theme compat
460 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)
461 431 'register_post_types', // Register post types (forum|topic|reply)
462 432 'register_post_statuses', // Register post statuses (closed|spam|orphan|hidden)
463 433 'register_taxonomies', // Register taxonomies (topic-tag)
434 + 'register_shortcodes', // Register shortcodes (bbp-login)
464 435 'register_views', // Register the views (no-replies)
465 - 'register_theme_directory', // Register the theme directory (bbp-themes)
436 + 'register_theme_packages', // Register bundled theme packages (bbp-theme-compat/bbp-themes)
466 437 'load_textdomain', // Load textdomain (bbpress)
467 - 'add_rewrite_tags', // Add rewrite tags (view|user|edit)
468 - 'generate_rewrite_rules' // Generate rewrite rules (view|edit)
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)
469 441 );
470 442
471 443 // Add the actions
472 - foreach( $actions as $class_action )
444 + foreach ( $actions as $class_action ) {
473 445 add_action( 'bbp_' . $class_action, array( $this, $class_action ), 5 );
446 + }
447 +
448 + // All bbPress actions are setup (includes bbp-core-hooks.php)
449 + do_action_ref_array( 'bbp_after_setup_actions', array( &$this ) );
474 450 }
475 451
452 + /** Public Methods ********************************************************/
453 +
476 454 /**
477 - * Load the translation file for current language. Checks the languages
478 - * folder inside the bbPress plugin first, and then the default WordPress
479 - * languages folder.
455 + * Register bundled theme packages
480 456 *
481 - * Note that custom translation files inside the bbPress plugin folder
482 - * will be removed on bbPress updates. If you're creating custom
483 - * translation files, please use the global language folder.
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.
484 460 *
485 - * @since bbPress (r2596)
486 - *
487 - * @uses apply_filters() Calls 'bbpress_locale' with the
488 - * {@link get_locale()} value
489 - * @uses load_textdomain() To load the textdomain
490 - * @return bool True on success, false on failure
461 + * @since 2.1.0 bbPress (r3829)
491 462 */
492 - public function load_textdomain() {
463 + public function register_theme_packages() {
493 464
494 - // Allow locale to be filtered
495 - $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 );
496 468
497 - // Get mo file name
498 - $mofile = sprintf( 'bbpress-%s.mo', $locale );
499 -
500 - // Setup paths to current locale file
501 - $mofile_local = $this->lang_dir . '/' . $mofile;
502 - $mofile_global = WP_LANG_DIR . '/bbpress/' . $mofile;
503 -
504 - // Look in local /wp-content/plugins/bbpress/bbp-languages/ folder
505 - if ( file_exists( $mofile_local ) )
506 - return load_textdomain( 'bbpress', $mofile_local );
507 -
508 - // Look in global /wp-content/languages/ folder
509 - elseif ( file_exists( $mofile_global ) )
510 - return load_textdomain( 'bbpress', $mofile_global );
511 -
512 - // Nothing found
513 - 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 + );
514 479 }
515 480
516 481 /**
517 - * Sets up the bbPress theme directory to use in WordPress
482 + * Setup the default bbPress theme compatibility location.
518 483 *
519 - * @since bbPress (r2507)
520 - *
521 - * @uses register_theme_directory() To register the theme directory
522 - * @return bool True on success, false on failure
484 + * @since 2.1.0 bbPress (r3778)
523 485 */
524 - public function register_theme_directory() {
525 - return register_theme_directory( $this->themes_dir );
486 + public function setup_theme() {
487 + bbp_setup_theme_compat( bbp_get_theme_package_id() );
526 488 }
527 489
528 490 /**
529 - * 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.
530 494 *
531 - * @since bbPress (r2597)
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.
532 498 *
533 - * @uses register_post_type() To register the post types
534 - * @uses apply_filters() Calls various filters to modify the arguments
535 - * sent to register_post_type()
499 + * @since 2.0.0 bbPress (r2596)
536 500 */
537 - public function register_post_types() {
501 + public function load_textdomain() {
538 502
539 - /** Forums ************************************************************/
503 + // Define the old directory
504 + $old_dir = WP_LANG_DIR . '/bbpress/';
540 505
541 - // Forum labels
542 - $forum['labels'] = array(
543 - 'name' => __( 'Forums', 'bbpress' ),
544 - 'menu_name' => __( 'Forums', 'bbpress' ),
545 - 'singular_name' => __( 'Forum', 'bbpress' ),
546 - 'all_items' => __( 'All Forums', 'bbpress' ),
547 - 'add_new' => __( 'New Forum', 'bbpress' ),
548 - 'add_new_item' => __( 'Create New Forum', 'bbpress' ),
549 - 'edit' => __( 'Edit', 'bbpress' ),
550 - 'edit_item' => __( 'Edit Forum', 'bbpress' ),
551 - 'new_item' => __( 'New Forum', 'bbpress' ),
552 - 'view' => __( 'View Forum', 'bbpress' ),
553 - 'view_item' => __( 'View Forum', 'bbpress' ),
554 - 'search_items' => __( 'Search Forums', 'bbpress' ),
555 - 'not_found' => __( 'No forums found', 'bbpress' ),
556 - 'not_found_in_trash' => __( 'No forums found in Trash', 'bbpress' ),
557 - 'parent_item_colon' => __( 'Parent Forum:', 'bbpress' )
558 - );
506 + // Old location, deprecated in 2.6.0
507 + if ( is_dir( $old_dir ) ) {
559 508
560 - // Forum rewrite
561 - $forum['rewrite'] = array(
562 - 'slug' => $this->forum_slug,
563 - 'with_front' => false
564 - );
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 );
565 513
566 - // Forum supports
567 - $forum['supports'] = array(
568 - 'title',
569 - 'editor',
570 - 'revisions'
571 - );
514 + // Look in global /wp-content/languages/bbpress/ folder
515 + load_textdomain( $this->domain, $old_dir . $mofile );
516 + }
572 517
573 - // Forum filter
574 - $bbp_cpt['forum'] = apply_filters( 'bbp_register_forum_post_type', array(
575 - 'labels' => $forum['labels'],
576 - 'rewrite' => $forum['rewrite'],
577 - 'supports' => $forum['supports'],
578 - 'description' => __( 'bbPress Forums', 'bbpress' ),
579 - 'capabilities' => bbp_get_forum_caps(),
580 - 'capability_type' => array( 'forum', 'forums' ),
581 - 'menu_position' => 56,
582 - 'has_archive' => $this->root_slug,
583 - 'exclude_from_search' => true,
584 - 'show_in_nav_menus' => true,
585 - 'public' => true,
586 - 'show_ui' => true,
587 - 'can_export' => true,
588 - 'hierarchical' => true,
589 - 'query_var' => true,
590 - 'menu_icon' => ''
591 - ) );
518 + // Look in global /wp-content/languages/plugins/
519 + load_plugin_textdomain( $this->domain, false, $this->lang_base );
520 + }
592 521
593 - // Register Forum content type
594 - 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() {
595 528
596 - /** Topics ************************************************************/
529 + /** Forums ************************************************************/
597 530
598 - // Topic labels
599 - $topic['labels'] = array(
600 - 'name' => __( 'Topics', 'bbpress' ),
601 - 'menu_name' => __( 'Topics', 'bbpress' ),
602 - 'singular_name' => __( 'Topic', 'bbpress' ),
603 - 'all_items' => __( 'All Topics', 'bbpress' ),
604 - 'add_new' => __( 'New Topic', 'bbpress' ),
605 - 'add_new_item' => __( 'Create New Topic', 'bbpress' ),
606 - 'edit' => __( 'Edit', 'bbpress' ),
607 - 'edit_item' => __( 'Edit Topic', 'bbpress' ),
608 - 'new_item' => __( 'New Topic', 'bbpress' ),
609 - 'view' => __( 'View Topic', 'bbpress' ),
610 - 'view_item' => __( 'View Topic', 'bbpress' ),
611 - 'search_items' => __( 'Search Topics', 'bbpress' ),
612 - 'not_found' => __( 'No topics found', 'bbpress' ),
613 - 'not_found_in_trash' => __( 'No topics found in Trash', 'bbpress' ),
614 - '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 + )
615 557 );
616 558
617 - // Topic rewrite
618 - $topic['rewrite'] = array(
619 - 'slug' => $this->topic_slug,
620 - 'with_front' => false
621 - );
559 + /** Topics ************************************************************/
622 560
623 - // Topic supports
624 - $topic['supports'] = array(
625 - 'title',
626 - 'editor',
627 - 'revisions'
561 + // Register Topic content type
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 + )
628 587 );
629 588
630 - // Topic Filter
631 - $bbp_cpt['topic'] = apply_filters( 'bbp_register_topic_post_type', array(
632 - 'labels' => $topic['labels'],
633 - 'rewrite' => $topic['rewrite'],
634 - 'supports' => $topic['supports'],
635 - 'description' => __( 'bbPress Topics', 'bbpress' ),
636 - 'capabilities' => bbp_get_topic_caps(),
637 - 'capability_type' => array( 'topic', 'topics' ),
638 - 'menu_position' => 57,
639 - 'has_archive' => $this->topic_archive_slug,
640 - 'exclude_from_search' => true,
641 - 'show_in_nav_menus' => false,
642 - 'public' => true,
643 - 'show_ui' => true,
644 - 'can_export' => true,
645 - 'hierarchical' => false,
646 - 'query_var' => true,
647 - 'menu_icon' => ''
648 - ) );
649 -
650 - // Register Topic content type
651 - register_post_type( $this->topic_post_type, $bbp_cpt['topic'] );
652 -
653 589 /** Replies ***********************************************************/
654 590
655 - // Reply labels
656 - $reply['labels'] = array(
657 - 'name' => __( 'Replies', 'bbpress' ),
658 - 'menu_name' => __( 'Replies', 'bbpress' ),
659 - 'singular_name' => __( 'Reply', 'bbpress' ),
660 - 'all_items' => __( 'All Replies', 'bbpress' ),
661 - 'add_new' => __( 'New Reply', 'bbpress' ),
662 - 'add_new_item' => __( 'Create New Reply', 'bbpress' ),
663 - 'edit' => __( 'Edit', 'bbpress' ),
664 - 'edit_item' => __( 'Edit Reply', 'bbpress' ),
665 - 'new_item' => __( 'New Reply', 'bbpress' ),
666 - 'view' => __( 'View Reply', 'bbpress' ),
667 - 'view_item' => __( 'View Reply', 'bbpress' ),
668 - 'search_items' => __( 'Search Replies', 'bbpress' ),
669 - 'not_found' => __( 'No replies found', 'bbpress' ),
670 - 'not_found_in_trash' => __( 'No replies found in Trash', 'bbpress' ),
671 - 'parent_item_colon' => __( 'Topic:', 'bbpress' )
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 + )
672 617 );
673 -
674 - // Reply rewrite
675 - $reply['rewrite'] = array(
676 - 'slug' => $this->reply_slug,
677 - 'with_front' => false
678 - );
679 -
680 - // Reply supports
681 - $reply['supports'] = array(
682 - 'title',
683 - 'editor',
684 - 'revisions'
685 - );
686 -
687 - // Reply filter
688 - $bbp_cpt['reply'] = apply_filters( 'bbp_register_reply_post_type', array(
689 - 'labels' => $reply['labels'],
690 - 'rewrite' => $reply['rewrite'],
691 - 'supports' => $reply['supports'],
692 - 'description' => __( 'bbPress Replies', 'bbpress' ),
693 - 'capabilities' => bbp_get_reply_caps(),
694 - 'capability_type' => array( 'reply', 'replies' ),
695 - 'menu_position' => 58,
696 - 'exclude_from_search' => true,
697 - 'has_archive' => false,
698 - 'show_in_nav_menus' => false,
699 - 'public' => true,
700 - 'show_ui' => true,
701 - 'can_export' => true,
702 - 'hierarchical' => false,
703 - 'query_var' => true,
704 - 'menu_icon' => ''
705 - ) );
706 -
707 - // Register reply content type
708 - register_post_type( $this->reply_post_type, $bbp_cpt['reply'] );
709 618 }
710 619
711 620 /**
712 - * Register the post statuses
621 + * Register the post statuses used by bbPress
713 622 *
714 - * @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.
715 625 *
716 - * @uses register_post_status() To register post statuses
717 - * @uses $wp_post_statuses To modify trash and private statuses
718 - * @uses current_user_can() To check if the current user is capable &
719 - * modify $wp_post_statuses accordingly
626 + * @since 2.0.0 bbPress (r2727)
720 627 */
721 - public function register_post_statuses() {
722 - global $wp_post_statuses;
628 + public static function register_post_statuses() {
723 629
724 630 // Closed
725 - $status = apply_filters( 'bbp_register_closed_post_status', array(
726 - 'label' => _x( 'Closed', 'post', 'bbpress' ),
727 - 'label_count' => _nx_noop( 'Closed <span class="count">(%s)</span>', 'Closed <span class="count">(%s)</span>', 'bbpress' ),
728 - 'public' => true,
729 - 'show_in_admin_all' => true
730 - ) );
731 - 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 + );
732 646
733 647 // Spam
734 - $status = apply_filters( 'bbp_register_spam_post_status', array(
735 - 'label' => _x( 'Spam', 'post', 'bbpress' ),
736 - 'label_count' => _nx_noop( 'Spam <span class="count">(%s)</span>', 'Spam <span class="count">(%s)</span>', 'bbpress' ),
737 - 'protected' => true,
738 - 'exclude_from_search' => true,
739 - 'show_in_admin_status_list' => true,
740 - 'show_in_admin_all_list' => false
741 - ) );
742 - 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 + );
743 664
744 665 // Orphan
745 - $status = apply_filters( 'bbp_register_orphan_post_status', array(
746 - 'label' => _x( 'Orphan', 'post', 'bbpress' ),
747 - 'label_count' => _nx_noop( 'Orphan <span class="count">(%s)</span>', 'Orphans <span class="count">(%s)</span>', 'bbpress' ),
748 - 'protected' => true,
749 - 'exclude_from_search' => true,
750 - 'show_in_admin_status_list' => true,
751 - 'show_in_admin_all_list' => false
752 - ) );
753 - 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 + );
754 682
755 683 // Hidden
756 - $status = apply_filters( 'bbp_register_hidden_post_status', array(
757 - 'label' => _x( 'Hidden', 'post', 'bbpress' ),
758 - 'label_count' => _nx_noop( 'Hidden <span class="count">(%s)</span>', 'Hidden <span class="count">(%s)</span>', 'bbpress' ),
759 - 'protected' => true,
760 - 'exclude_from_search' => true,
761 - 'show_in_admin_status_list' => true,
762 - 'show_in_admin_all_list' => true
763 - ) );
764 - 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 + );
765 700
766 701 /**
767 - * Trash fix
702 + * Trash fix.
768 703 *
769 704 * We need to remove the internal arg and change that to
770 705 * protected so that the users with 'view_trash' cap can view
771 706 * single trashed topics/replies in the front-end as wp_query
@@ -770,10 +705,12 @@
770 705 * protected so that the users with 'view_trash' cap can view
771 706 * single trashed topics/replies in the front-end as wp_query
772 707 * doesn't allow any hack for the trashed topics to be viewed.
773 708 */
774 - if ( !empty( $wp_post_statuses['trash'] ) ) {
709 + global $wp_post_statuses;
775 710
711 + if ( ! empty( $wp_post_statuses['trash'] ) ) {
712 +
776 713 // User can view trash so set internal to false
777 714 if ( current_user_can( 'view_trash' ) ) {
778 715 $wp_post_statuses['trash']->internal = false;
779 716 $wp_post_statuses['trash']->protected = true;
@@ -778,9 +715,9 @@
778 715 $wp_post_statuses['trash']->internal = false;
779 716 $wp_post_statuses['trash']->protected = true;
780 717
781 718 // User cannot view trash so set internal to true
782 - } elseif ( !current_user_can( 'view_trash' ) ) {
719 + } else {
783 720 $wp_post_statuses['trash']->internal = true;
784 721 }
785 722 }
786 723 }
@@ -785,197 +722,423 @@
785 722 }
786 723 }
787 724
788 725 /**
789 - * Register the topic tag taxonomy
726 + * Register the topic tag and forum moderator taxonomies
790 727 *
791 - * @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
792 757 *
793 - * @uses register_taxonomy() To register the taxonomy
758 + * @since 2.0.0 bbPress (r2789)
794 759 */
795 - public function register_taxonomies() {
760 + public static function register_views() {
796 761
797 - // Topic tag labels
798 - $topic_tag['labels'] = array(
799 - 'name' => __( 'Topic Tags', 'bbpress' ),
800 - 'singular_name' => __( 'Topic Tag', 'bbpress' ),
801 - 'search_items' => __( 'Search Tags', 'bbpress' ),
802 - 'popular_items' => __( 'Popular Tags', 'bbpress' ),
803 - 'all_items' => __( 'All Tags', 'bbpress' ),
804 - 'edit_item' => __( 'Edit Tag', 'bbpress' ),
805 - 'update_item' => __( 'Update Tag', 'bbpress' ),
806 - 'add_new_item' => __( 'Add New Tag', 'bbpress' ),
807 - 'new_item_name' => __( 'New Tag Name', 'bbpress' ),
808 - 'view_item' => __( 'View Topic Tag', '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 + )
809 776 );
810 777
811 - // Topic tag rewrite
812 - $topic_tag['rewrite'] = array(
813 - 'slug' => $this->topic_tag_slug,
814 - '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 + )
815 793 );
794 + }
816 795
817 - // Topic tag filter
818 - $bbp_tt = apply_filters( 'bbp_register_topic_taxonomy', array(
819 - 'labels' => $topic_tag['labels'],
820 - 'rewrite' => $topic_tag['rewrite'],
821 - 'capabilities' => bbp_get_topic_tag_caps(),
822 - 'update_count_callback' => '_update_post_term_count',
823 - 'query_var' => true,
824 - 'show_tagcloud' => true,
825 - 'hierarchical' => false,
826 - 'public' => true,
827 - 'show_ui' => true
828 - ) );
829 -
830 - // Register the topic tag taxonomy
831 - register_taxonomy(
832 - $this->topic_tag_tax_id, // The topic tag id
833 - $this->topic_post_type, // The topic post type
834 - $bbp_tt
835 - );
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();
836 803 }
837 804
838 805 /**
839 - * Register the bbPress views
806 + * Register bbPress meta-data
840 807 *
841 - * @since bbPress (r2789)
808 + * Counts added in 2.6.0 to avoid negative values
842 809 *
843 - * @uses bbp_register_view() To register the views
810 + * @since 2.6.0 bbPress (r6300)
844 811 */
845 - public function register_views() {
812 + public function register_meta() {
846 813
847 - // Topics with no replies
848 - $no_replies = apply_filters( 'bbp_register_view_no_replies', array(
849 - 'meta_key' => '_bbp_reply_count',
850 - 'meta_value' => 1,
851 - 'meta_compare' => '<',
852 - 'orderby' => ''
853 - ) );
814 + // Define "count" meta-type array
815 + $count = array(
854 816
855 - 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 + );
856 870 }
857 871
858 872 /**
859 873 * Setup the currently logged-in user
860 874 *
861 - * Do not to call this prematurely, I.E. before the 'init' action has
862 - * started. This function is naturally hooked into 'init' to ensure proper
863 - * execution. get_currentuserinfo() is used to check for XMLRPC_REQUEST to
864 - * 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
865 883 *
866 - * @since bbPress (r2697)
884 + * @since 2.6.0 bbPress (r6875)
885 + */
886 + public function setup_engagements() {
887 +
888 + // Setup the class name
889 + $strategy = ucwords( bbp_engagements_strategy() );
890 + $class_name = "BBP_User_Engagements_{$strategy}";
891 +
892 + // Setup the engagements interface
893 + $this->engagements = new $class_name();
894 + }
895 +
896 + /**
897 + * Initialize forum-specific roles
867 898 *
868 - * @uses wp_get_current_user()
899 + * @since 2.6.0
869 900 */
870 - public function setup_current_user() {
871 - $this->current_user = &wp_get_current_user();
901 + public function roles_init() {
902 +
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();
909 +
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
872 918 }
873 919
920 + /** Custom Rewrite Rules **************************************************/
921 +
874 922 /**
875 923 * Add the bbPress-specific rewrite tags
876 924 *
877 - * @since bbPress (r2753)
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
937 + }
938 +
939 + /**
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
878 945 *
879 - * @uses add_rewrite_tag() To add the rewrite tags
946 + * @since 2.0.0 bbPress (r2688)
947 + *
948 + * @todo Extract into an API
880 949 */
881 - public function add_rewrite_tags() {
950 + public static function add_rewrite_rules() {
882 951
883 - // Pad attributes
884 - $pad = 2;
885 - $wrapper = '%';
952 + /** Setup *************************************************************/
886 953
887 - // Setup the tags
888 - $bbp_user = str_pad( $this->user_id, strlen( $this->user_id ) + $pad, $wrapper, STR_PAD_BOTH );
889 - $bbp_view = str_pad( $this->view_id, strlen( $this->view_id ) + $pad, $wrapper, STR_PAD_BOTH );
890 - $bbp_edit = str_pad( $this->edit_id, strlen( $this->edit_id ) + $pad, $wrapper, STR_PAD_BOTH );
954 + // Add rules to top or bottom?
955 + $priority = 'top';
891 956
892 - // User Profile tag
893 - add_rewrite_tag( $bbp_user, '([^/]+)' );
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();
894 962
895 - // View Page tag
896 - add_rewrite_tag( $bbp_view, '([^/]+)' );
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();
897 969
898 - // Edit Page tag
899 - add_rewrite_tag( $bbp_edit, '([1]{1,})' );
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();
977 +
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();
990 +
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,})/?$';
996 +
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 );
900 1043 }
901 1044
902 1045 /**
903 - * Register bbPress-specific rewrite rules
1046 + * Add permalink structures for new archive-style destinations.
904 1047 *
905 - * @since bbPress (r2688)
1048 + * - Users
1049 + * - Topic Views
1050 + * - Search
906 1051 *
907 - * @param WP_Rewrite $wp_rewrite bbPress-sepecific rules are appended in
908 - * $wp_rewrite->rules
1052 + * @since 2.4.0 bbPress (r4930)
909 1053 */
910 - public function generate_rewrite_rules( $wp_rewrite ) {
1054 + public static function add_permastructs() {
911 1055
912 - // New rules to merge with existing
913 - $bbp_rules = array(
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();
914 1060
915 - // Edit Topic/Reply
916 - $this->topic_slug . '/([^/]+)/edit/?$' => 'index.php?' . $this->topic_post_type . '=' . $wp_rewrite->preg_index( 1 ) . '&edit=1',
917 - $this->reply_slug . '/([^/]+)/edit/?$' => 'index.php?' . $this->reply_post_type . '=' . $wp_rewrite->preg_index( 1 ) . '&edit=1',
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();
918 1065
919 - // Edit Topic Tag
920 - $this->topic_tag_slug . '/([^/]+)/edit/?$' => 'index.php?' . $this->topic_tag_tax_id . '=' . $wp_rewrite->preg_index( 1 ) . '&edit=1',
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 + );
921 1080
922 - // Profile Page
923 - $this->user_slug . '/([^/]+)/page/?([0-9]{1,})/?$' => 'index.php?' . $this->user_id . '=' . $wp_rewrite->preg_index( 1 ) . '&paged=' . $wp_rewrite->preg_index( 2 ),
924 - $this->user_slug . '/([^/]+)/?$' => 'index.php?' . $this->user_id . '=' . $wp_rewrite->preg_index( 1 ),
925 - $this->user_slug . '/([^/]+)/edit/?$' => 'index.php?' . $this->user_id . '=' . $wp_rewrite->preg_index( 1 ) . '&edit=1',
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 + );
926 1095
927 - // View Page
928 - $this->view_slug . '/([^/]+)/page/?([0-9]{1,})/?$' => 'index.php?' . $this->view_id . '=' . $wp_rewrite->preg_index( 1 ) . '&paged=' . $wp_rewrite->preg_index( 2 ),
929 - $this->view_slug . '/([^/]+)/?$' => 'index.php?' . $this->view_id . '=' . $wp_rewrite->preg_index( 1 )
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 + )
930 1109 );
931 -
932 - // Merge bbPress rules with existing
933 - $wp_rewrite->rules = array_merge( $bbp_rules, $wp_rewrite->rules );
934 -
935 - // Return merged rules
936 - return $wp_rewrite;
937 1110 }
938 1111 }
939 1112
940 -// "And now here's something we hope you'll really like!"
941 -$GLOBALS['bbp'] = new bbPress();
942 -
943 -endif; // class_exists check
944 -
945 1113 /**
946 - * Runs on bbPress activation
1114 + * The main function responsible for returning the one true bbPress Instance
1115 + * to functions everywhere.
947 1116 *
948 - * @since bbPress (r2509)
1117 + * Use this function like you would a global variable, except without needing
1118 + * to declare the global.
949 1119 *
950 - * @uses register_uninstall_hook() To register our own uninstall hook
951 - * @uses do_action() Calls 'bbp_activation' hook
952 - */
953 -function bbp_activation() {
954 - register_uninstall_hook( __FILE__, 'bbp_uninstall' );
955 -
956 - do_action( 'bbp_activation' );
957 -}
958 -
959 -/**
960 - * Runs on bbPress deactivation
1120 + * Example: <?php $bbp = bbpress(); ?>
961 1121 *
962 - * @since bbPress (r2509)
1122 + * @since 2.0.0 bbPress (r2464)
963 1123 *
964 - * @uses do_action() Calls 'bbp_deactivation' hook
1124 + * @return bbPress The one true bbPress Instance
965 1125 */
966 -function bbp_deactivation() {
967 - do_action( 'bbp_deactivation' );
1126 +function bbpress() {
1127 + return bbPress::instance();
968 1128 }
969 1129
970 1130 /**
971 - * Runs when uninstalling bbPress
1131 + * Hook bbPress early onto the 'plugins_loaded' action.
972 1132 *
973 - * @since bbPress (r2509)
974 - *
975 - * @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.
976 1135 */
977 -function bbp_uninstall() {
978 - 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();
979 1142 }
980 1143
981 -?>
1144 +endif; // class_exists check