Changeset 6106

Timestamp:

11/01/2016 05:14:29 AM (9 years ago)

Author:

johnjamesjacoby

Message:

Roles: Introduce bbp_roles_init subaction, and use this for future dynamic roles initialization.

See: #2452;

Location:

trunk/src/includes/core

Files:

• abstraction.php (modified) (2 diffs)
• actions.php (modified) (3 diffs)
• sub-actions.php (modified) (1 diff)

trunk/src/includes/core/abstraction.php

@@ -8 +8 @@
  *
  * Many of the functions in this file are considered superfluous by
- * WordPress coding standards, but
+ * WordPress coding standards, but they're handy for plugins of plugins to use.
  *
  * @package bbPress
@@ -49 +49 @@
     // Filter & return
     return apply_filters( 'bbp_get_global_object', $retval, $name, $type, $default );
+}
+
+/**
+ * Get the `$wp_roles` global without needing to declare it everywhere
+ *
+ * @since 2.2.0 bbPress (r4293)
+ *
+ * @return WP_Roles
+ */
+function bbp_get_wp_roles() {
+    return bbp_get_global_object( 'wp_roles', 'WP_Roles' );
 }
 

trunk/src/includes/core/actions.php

@@ -42 +42 @@
 add_action( 'parse_query',              'bbp_parse_query',            2     ); // Early for overrides
 add_action( 'widgets_init',             'bbp_widgets_init',           10    );
+add_action( 'wp_roles_init',            'bbp_roles_init',             10    );
 add_action( 'generate_rewrite_rules',   'bbp_generate_rewrite_rules', 10    );
 add_action( 'wp_enqueue_scripts',       'bbp_enqueue_scripts',        10    );
@@ -68 +69 @@
 add_action( 'bbp_loaded', 'bbp_setup_user_option_filters', 12 );
 add_action( 'bbp_loaded', 'bbp_register_theme_packages',   14 );
-add_action( 'bbp_loaded', 'bbp_filter_user_roles_option',  16 );
 
 /**
@@ -85 +85 @@
 
 /**
- * There is no action API for roles to use, so hook in immediately after
- * everything is included (including the theme's functions.php. This is after
- * the $wp_roles global is set but before $wp->init().
- *
- * If it's hooked in any sooner, role names may not be translated correctly.
- *
- * @link https://bbpress.trac.wordpress.org/ticket/2219
- *
- * This is kind of lame, but is all we have for now.
- */
-add_action( 'bbp_after_setup_theme', 'bbp_add_forums_roles', 1 );
+ * bbp_roles_init - Attached to 'wp_roles_init' above
+ *
+ * Attach various role related actions to the wp_roles_init action.
+ * The load order helps to execute code at the correct time.
+ *                                                    v---Load order
+ */
+add_action( 'bbp_roles_init', 'bbp_add_forums_roles', 1 );
 
 /**

trunk/src/includes/core/sub-actions.php

@@ -134 +134 @@
 function bbp_init() {
     do_action( 'bbp_init' );
+}
+
+/**
+ * Initialize roles
+ *
+ * @since 2.6.0 bbPress (r6106)
+ *
+ * @uses do_action() Calls 'bbp_roles_init'
+ *
+ * @param WP_Roles $wp_roles The array of WP_Role objects that was initialized
+ */
+function bbp_roles_init( $wp_roles ) {
+    do_action( 'bbp_roles_init', $wp_roles );
 }