Changeset 2812 for branches/plugin/bbp-includes/bbp-general-template.php

Timestamp:

01/17/2011 06:57:34 PM (15 years ago)

Author:

johnjamesjacoby

Message:

Normalize bbp-includes directory. Mostly documentation fixes. Introduce bbp-shortcodes placeholder.

File:

• branches/plugin/bbp-includes/bbp-general-template.php (modified) (8 diffs)

branches/plugin/bbp-includes/bbp-general-template.php

@@ -8 +8 @@
  */
 
-/** START - WordPress Add-on Actions ******************************************/
+/** Add-on Actions ************************************************************/
 
 /**
@@ -32 +32 @@
 }
 
-/** END - WordPress Add-on Actions ********************************************/
-
-/** START is_ Functions *******************************************************/
+/** is_ ***********************************************************************/
 
 /**
@@ -319 +317 @@
 }
 
-/** END is_ Functions *********************************************************/
-
-/** START Form Functions ******************************************************/
+/** Forms *********************************************************************/
 
 /**
@@ -619 +615 @@
 
     <?php wp_referer_field(); ?>
+
     <?php wp_nonce_field( 'update-user_' . bbp_get_displayed_user_id() );
 }
@@ -659 +656 @@
 }
 
-/** END Form Functions ********************************************************/
-
-/** Start Views ***************************************************************/
+/** Views *********************************************************************/
 
 /**
@@ -772 +767 @@
     }
 
-/** End Views *****************************************************************/
-
-/** Start General Functions ***************************************************/
-
-/**
- * Display possible error messages inside a template file
- *
- * @since bbPress (r2688)
- *
- * @uses WP_Error bbPress::errors::get_error_codes() To get the error codes
- * @uses WP_Error bbPress::errors::get_error_messages() To get the error
- *                                                       messages
- * @uses is_wp_error() To check if it's a {@link WP_Error}
- */
-function bbp_error_messages() {
-    global $bbp;
-
-    if ( isset( $bbp->errors ) && is_wp_error( $bbp->errors ) && $bbp->errors->get_error_codes() ) : ?>
-
-        <div class="bbp-template-notice error">
-            <p>
-                <?php echo implode( "</p>\n<p>", $bbp->errors->get_error_messages() ); ?>
-            </p>
-        </div>
-
-<?php endif;
-}
+/** Query *********************************************************************/
+
+/**
+ * Get the '_bbp_query_name' setting
+ *
+ * @since bbPress (r2695)
+ *
+ * @uses get_query_var() To get the query var '_bbp_query_name'
+ * @return string To return the query var value
+ */
+function bbp_get_query_name()  {
+    return get_query_var( '_bbp_query_name' );
+}
+
+/**
+ * Set the '_bbp_query_name' setting to $name
+ *
+ * @since bbPress (r2692)
+ *
+ * @param string $name What to set the query var to
+ * @uses set_query_var() To set the query var '_bbp_query_name'
+ */
+function bbp_set_query_name( $name = '' )  {
+    set_query_var( '_bbp_query_name', $name );
+}
+
+/**
+ * Used to clear the '_bbp_query_name' setting
+ *
+ * @since bbPress (r2692)
+ *
+ * @uses bbp_set_query_name() To set the query var '_bbp_query_name' to ''
+ */
+function bbp_reset_query_name() {
+    bbp_set_query_name();
+}
+
+/** Breadcrumbs ***************************************************************/
 
 /**
@@ -890 +896 @@
     }
 
+/** Topic Tags ***************************************************************/
+
 /**
  * Output all of the allowed tags in HTML format with attributes.
@@ -919 +927 @@
     }
 
-/** Start Query Functions *****************************************************/
-
-/**
- * Get the '_bbp_query_name' setting
- *
- * @since bbPress (r2695)
- *
- * @uses get_query_var() To get the query var '_bbp_query_name'
- * @return string To return the query var value
- */
-function bbp_get_query_name()  {
-    return get_query_var( '_bbp_query_name' );
-}
-
-/**
- * Set the '_bbp_query_name' setting to $name
- *
- * @since bbPress (r2692)
- *
- * @param string $name What to set the query var to
- * @uses set_query_var() To set the query var '_bbp_query_name'
- */
-function bbp_set_query_name( $name = '' )  {
-    set_query_var( '_bbp_query_name', $name );
-}
-
-/**
- * Used to clear the '_bbp_query_name' setting
- *
- * @since bbPress (r2692)
- *
- * @uses bbp_set_query_name() To set the query var '_bbp_query_name' to ''
- */
-function bbp_reset_query_name() {
-    bbp_set_query_name();
+/** Errors ********************************************************************/
+
+/**
+ * Display possible error messages inside a template file
+ *
+ * @since bbPress (r2688)
+ *
+ * @uses WP_Error bbPress::errors::get_error_codes() To get the error codes
+ * @uses WP_Error bbPress::errors::get_error_messages() To get the error
+ *                                                       messages
+ * @uses is_wp_error() To check if it's a {@link WP_Error}
+ */
+function bbp_error_messages() {
+    global $bbp;
+
+    if ( isset( $bbp->errors ) && is_wp_error( $bbp->errors ) && $bbp->errors->get_error_codes() ) : ?>
+
+        <div class="bbp-template-notice error">
+            <p>
+                <?php echo implode( "</p>\n<p>", $bbp->errors->get_error_messages() ); ?>
+            </p>
+        </div>
+
+<?php endif;
 }