Changeset 2753 for branches/plugin/bbp-includes/bbp-loader.php

Timestamp:

01/05/2011 06:52:36 PM (15 years ago)

Author:

johnjamesjacoby

Message:

Rename bbp-filters.php to bbp-hooks.php, and move a majority of actions/filters into it. Introduce ability to edit topics/posts from front-end of theme, and consequently introduce page-bbp_edit.php. Also includes various phpDoc clean-up. Props GautamGupta via Google Code-in

File:

• branches/plugin/bbp-includes/bbp-loader.php (modified) (3 diffs)

branches/plugin/bbp-includes/bbp-loader.php

@@ -1 +1 @@
 <?php
+
 /**
- * bbp-loader.php
- *
- * The main bbPress loader. Action priorities included for the sake of human
- * readability and clarification.
+ * The main bbPress loader.
  *
  * @package bbPress
  * @subpackage Loader
- * @since bbPress (r2464)
  */
-
-// Attach to WordPress actions
-add_action( 'plugins_loaded',         'bbp_loaded'                   , 10 );
-add_action( 'init',                   'bbp_init'                     , 10 );
-add_action( 'generate_rewrite_rules', 'bbp_generate_rewrite_rules'   , 12 );
-
-// Attach to bbp_loaded.
-add_action( 'bbp_loaded',             'bbp_constants'                , 2  );
-add_action( 'bbp_loaded',             'bbp_boot_strap_globals'       , 4  );
-add_action( 'bbp_loaded',             'bbp_includes'                 , 6  );
-add_action( 'bbp_loaded',             'bbp_setup_globals'            , 8  );
-add_action( 'bbp_loaded',             'bbp_register_theme_directory' , 10 );
-
-// Attach to bbp_init.
-add_action( 'bbp_init',               'bbp_setup_current_user'       , 2  );
-add_action( 'bbp_init',               'bbp_register_post_types'      , 4  );
-add_action( 'bbp_init',               'bbp_register_post_statuses'   , 6  );
-add_action( 'bbp_init',               'bbp_register_taxonomies'      , 8  );
-add_action( 'bbp_init',               'bbp_register_textdomain'      , 10 );
-add_action( 'bbp_init',               'bbp_add_user_rewrite_tag'     , 12 );
-add_action( 'bbp_init',               'bbp_ready'                    , 999 );
 
 /** Main Actions **************************************************************/
 
 /**
- * bbp_bbp_constants ()
+ * Setup constants
  *
- * Setup constants
+ * @since bbPress (r2599)
+ *
+ * @uses do_action() Calls 'bbp_constants'
  */
-function bbp_constants () {
+function bbp_constants() {
     do_action( 'bbp_constants' );
 }
 
 /**
- * boot_strap_globals ()
+ * Setup globals BEFORE includes
  *
- * Setup globals BEFORE includes
+ * @since bbPress (r2599)
+ *
+ * @uses do_action() Calls 'bbp_boot_strap_globals'
  */
-function bbp_boot_strap_globals () {
+function bbp_boot_strap_globals() {
     do_action( 'bbp_boot_strap_globals' );
 }
 
 /**
- * bbp_includes ()
+ * Include files
  *
- * Include files
+ * @since bbPress (r2599)
+ *
+ * @uses do_action() Calls 'bbp_includes'
  */
-function bbp_includes () {
+function bbp_includes() {
     do_action( 'bbp_includes' );
 }
 
 /**
- * bbp_setup_globals ()
+ * Setup globals AFTER includes
  *
- * Setup globals AFTER includes
+ * @since bbPress (r2599)
+ *
+ * @uses do_action() Calls 'bbp_setup_globals'
  */
-function bbp_setup_globals () {
+function bbp_setup_globals() {
     do_action( 'bbp_setup_globals' );
 }
 
 /**
- * bbp_loaded ()
+ * Main action responsible for constants, globals, and includes
  *
- * Main action responsible for constants, globals, and includes
+ * @since bbPress (r2599)
+ *
+ * @uses do_action() Calls 'bbp_loaded'
  */
-function bbp_loaded () {
+function bbp_loaded() {
     do_action( 'bbp_loaded' );
 }
 
 /**
- * bbp_init ()
+ * Initialize any code after everything has been loaded
  *
- * Initialize any code after everything has been loaded
+ * @since bbPress (r2599)
+ *
+ * @uses do_action() Calls 'bbp_init'
  */
-function bbp_init () {
+function bbp_init() {
     do_action ( 'bbp_init' );
 }
@@ -91 +79 @@
 
 /**
- * bbp_setup_current_user ()
- *
  * Setup the currently logged-in user
  *
  * @since bbPress (r2695)
+ *
+ * @uses do_action() Calls 'bbp_setup_current_user'
  */
-function bbp_setup_current_user () {
+function bbp_setup_current_user() {
     do_action ( 'bbp_setup_current_user' );
 }
 
 /**
- * register_textdomain ()
+ * Load translations for current language
  *
- * Load translations for current language
+ * @since bbPress (r2599)
+ *
+ * @uses do_action() Calls 'bbp_load_textdomain'
  */
-function bbp_register_textdomain () {
+function bbp_register_textdomain() {
     do_action( 'bbp_load_textdomain' );
 }
 
 /**
- * bbp_register_theme_directory ()
- *
  * Sets up the theme directory
  *
  * @since bbPress (r2507)
+ *
+ * @uses do_action() Calls 'bbp_register_theme_directory'
  */
-function bbp_register_theme_directory () {
+function bbp_register_theme_directory() {
     do_action( 'bbp_register_theme_directory' );
 }
 
 /**
- * bbp_register_post_types ()
- *
  * Setup the post types
  *
  * @since bbPress (r2464)
+ *
+ * @uses do_action() Calls 'bbp_register_post_type'
  */
-function bbp_register_post_types () {
+function bbp_register_post_types() {
     do_action ( 'bbp_register_post_types' );
 }
 
 /**
- * bbp_register_post_statuses ()
- *
  * Setup the post statuses
  *
  * @since bbPress (r2727)
+ *
+ * @uses do_action() Calls 'bbp_register_post_statuses'
  */
-function bbp_register_post_statuses () {
+function bbp_register_post_statuses() {
     do_action ( 'bbp_register_post_statuses' );
 }
 
 /**
- * bbp_register_taxonomies ()
- *
  * Register the built in bbPress taxonomies
  *
  * @since bbPress (r2464)
+ *
+ * @uses do_action() Calls 'bbp_register_taxonomies'
  */
-function bbp_register_taxonomies () {
+function bbp_register_taxonomies() {
     do_action ( 'bbp_register_taxonomies' );
 }
 
 /**
- * bbp_add_user_rewrite_tag ()
+ * Add the bbPress-specific rewrite tags
  *
- * Add the %bbp_user% rewrite tag
+ * @since bbPress (r2753)
  *
- * @since bbPress (r2688)
+ * @uses do_action() Calls 'bbp_add_rewrite_tags'
  */
-function bbp_add_user_rewrite_tag () {
-    do_action ( 'bbp_add_user_rewrite_tag' );
+function bbp_add_rewrite_tags() {
+    do_action ( 'bbp_add_rewrite_tags' );
 }
 
 /**
- * bbp_generate_rewrite_rules ()
- *
- * Generate rewrite rules, particularly for /user/%bbp_user%/ pages
+ * Generate bbPress-specific rewrite rules
  *
  * @since bbPress (r2688)
  *
- * @param object $wp_rewrite
+ * @param WP_Rewrite $wp_rewrite
+ *
+ * @uses do_action() Calls 'bbp_generate_rewrite_rules' with {@link WP_Rewrite}
  */
-function bbp_generate_rewrite_rules ( $wp_rewrite ) {
+function bbp_generate_rewrite_rules( $wp_rewrite ) {
     do_action_ref_array( 'bbp_generate_rewrite_rules', array( &$wp_rewrite ) );
 }
@@ -181 +171 @@
 
 /**
- * bbp_ready ()
+ * bbPress has loaded and initialized everything, and is okay to go
  *
- * bbPress has loaded and initialized everything, and is okay to go
+ * @since bbPress (r2618)
+ *
+ * @uses do_action() Calls 'bbp_ready'
  */
-function bbp_ready () {
+function bbp_ready() {
     do_action( 'bbp_ready' );
 }