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

Timestamp:

01/09/2011 10:06:53 PM (14 years ago)

Author:

johnjamesjacoby

Message:

Introduce views API into plugin. Allows for creating specific topic views with code rather than with templates. The 'no-replies' view is included as default. Props GautamGupta via Google Code-in

File:

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

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

@@ -297 +297 @@
 
     if ( !empty( $wp_query->bbp_is_user_profile_edit ) && $wp_query->bbp_is_user_profile_edit == true )
+        return true;
+
+    return false;
+}
+
+/**
+ * Check if current page is a view page
+ *
+ * @since bbPress (r2789)
+ *
+ * @uses WP_Query Checks if WP_Query::bbp_is_view is true
+ * @return bool Is it a view page?
+ */
+function bbp_is_view() {
+    global $wp_query;
+
+    if ( !empty( $wp_query->bbp_is_view ) && $wp_query->bbp_is_view == true )
         return true;
 
@@ -597 +614 @@
 /** END Form Functions ********************************************************/
 
+/** Start Views ***************************************************************/
+
+/**
+ * Output the view id
+ *
+ * @since bbPress (r2789)
+ *
+ * @param string $view Optional. View id
+ * @uses bbp_get_view_id() To get the view id
+ */
+function bbp_view_id( $view = '' ) {
+    echo bbp_get_view_id( $view );
+}
+
+    /**
+     * Get the view id
+     *
+     * If a view id is supplied, that is used. Otherwise the 'bbp_view'
+     * query var is checked for.
+     *
+     * @since bbPress (r2789)
+     *
+     * @param string $view Optional. View id.
+     * @uses sanitize_title() To sanitize the view id
+     * @uses get_query_var() To get the view id from query var 'bbp_view'
+     * @return bool|string ID on success, false on failure
+     */
+    function bbp_get_view_id( $view = '' ) {
+        global $bbp;
+
+        $view = !empty( $view ) ? sanitize_title( $view ) : get_query_var( 'bbp_view' );
+
+        if ( array_key_exists( $view, $bbp->views ) )
+            return $view;
+
+        return false;
+    }
+
+/**
+ * Output the view name aka title
+ *
+ * @since bbPress (r2789)
+ *
+ * @param string $view Optional. View id
+ * @uses bbp_get_view_title() To get the view title
+ */
+function bbp_view_title( $view = '' ) {
+    echo bbp_get_view_title( $view );
+}
+
+    /**
+     * Get the view name aka title
+     *
+     * If a view id is supplied, that is used. Otherwise the bbp_view
+     * query var is checked for.
+     *
+     * @since bbPress (r2789)
+     *
+     * @param string $view Optional. View id
+     * @uses bbp_get_view_id() To get the view id
+     * @return bool|string Title on success, false on failure
+     */
+    function bbp_get_view_title( $view = '' ) {
+        global $bbp;
+
+        if ( !$view = bbp_get_view_id( $view ) )
+            return false;
+
+        return $bbp->views[$view]['title'];
+    }
+
+/**
+ * Output the view url
+ *
+ * @since bbPress (r2789)
+ *
+ * @param string $view Optional. View id
+ * @uses bbp_get_view_url() To get the view url
+ */
+function bbp_view_url( $view = false ) {
+    echo bbp_get_view_url( $view );
+}
+    /**
+     * Return the view url
+     *
+     * @since bbPress (r2789)
+     *
+     * @param string $view Optional. View id
+     * @uses sanitize_title() To sanitize the view id
+     * @uses home_url() To get blog home url
+     * @uses add_query_arg() To add custom args to the url
+     * @uses apply_filters() Calls 'bbp_get_view_url' with the view url,
+     *                        used view id
+     * @return string View url (or home url if the view was not found)
+     */
+    function bbp_get_view_url( $view = false ) {
+        global $bbp, $wp_rewrite;
+
+        if ( !$view = bbp_get_view_id( $view ) )
+            return home_url();
+
+        if ( !empty( $wp_rewrite->permalink_structure ) ) {
+            $url = $wp_rewrite->front . $bbp->view_slug . '/' . $view;
+            $url = home_url( user_trailingslashit( $url ) );
+        } else {
+            $url = add_query_arg( array( 'bbp_view' => $view ), home_url( '/' ) );
+        }
+
+        return apply_filters( 'bbp_get_view_link', $url, $view );
+    }
+
+/** End Views *****************************************************************/
+
 /** Start General Functions ***************************************************/
 
@@ -712 +842 @@
         return apply_filters( 'bbp_get_breadcrumb', $trail . get_the_title() );
     }
-    
+
 /**
  * Output all of the allowed tags in HTML format with attributes.
@@ -721 +851 @@
  * @since bbPress (r2780)
  *
- * @uses bbp_get_allowed_tags() 
+ * @uses bbp_get_allowed_tags()
  */
 function bbp_allowed_tags() {