bbp_request_feed_trap( array $query_vars = array() )

This function is hooked into the WordPress ‘request’ action and is responsible for sniffing out the query vars and serving up RSS2 feeds if the stars align and the user has requested a feed of any Forums type.

Description

Parameters

$query_vars

(Optional)

Default value: array()

Return

(array)

Source

File: bp-forums/common/functions.php

1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
function bbp_request_feed_trap( $query_vars = array() ) {
 
    // Looking at a feed
    if ( isset( $query_vars['feed'] ) ) {
 
        // Forum/Topic/Reply Feed
        if ( isset( $query_vars['post_type'] ) ) {
 
            // Matched post type
            $post_type = false;
 
            // Post types to check
            $post_types = array(
                bbp_get_forum_post_type(),
                bbp_get_topic_post_type(),
                bbp_get_reply_post_type()
            );
 
            // Cast query vars as array outside of foreach loop
            $qv_array = (array) $query_vars['post_type'];
 
            // Check if this query is for a Forums post type
            foreach ( $post_types as $bbp_pt ) {
                if ( in_array( $bbp_pt, $qv_array, true ) ) {
                    $post_type = $bbp_pt;
                    break;
                }
            }
 
            // Looking at a Forums post type
            if ( ! empty( $post_type ) ) {
 
                // Supported select query vars
                $select_query_vars = array(
                    'p'        => false,
                    'name'     => false,
                    $post_type => false,
                );
 
                // Setup matched variables to select
                foreach ( $query_vars as $key => $value ) {
                    if ( isset( $select_query_vars[$key] ) ) {
                        $select_query_vars[$key] = $value;
                    }
                }
 
                // Remove any empties
                $select_query_vars = array_filter( $select_query_vars );
 
                // What Forums post type are we looking for feeds on?
                switch ( $post_type ) {
 
                    // Forum
                    case bbp_get_forum_post_type() :
 
                        // Define local variable(s)
                        $meta_query = array();
 
                        // Single forum
                        if ( !empty( $select_query_vars ) ) {
 
                            // Load up our own query
                            query_posts( array_merge( array(
                                'post_type' => bbp_get_forum_post_type(),
                                'feed'      => true
                            ), $select_query_vars ) );
 
                            // Restrict to specific forum ID
                            $meta_query = array( array(
                                'key'     => '_bbp_forum_id',
                                'value'   => bbp_get_forum_id(),
                                'type'    => 'numeric',
                                'compare' => '='
                            ) );
                        }
 
                        // Only forum replies
                        if ( !empty( $_GET['type'] ) && ( bbp_get_reply_post_type() === $_GET['type'] ) ) {
 
                            // The query
                            $the_query = array(
                                'author'         => 0,
                                'feed'           => true,
                                'post_type'      => bbp_get_reply_post_type(),
                                'post_parent'    => 'any',
                                'post_status'    => array( bbp_get_public_status_id(), bbp_get_closed_status_id() ),
                                'posts_per_page' => bbp_get_replies_per_rss_page(),
                                'order'          => 'DESC',
                                'meta_query'     => $meta_query
                            );
 
                            // Output the feed
                            bbp_display_replies_feed_rss2( $the_query );
 
                        // Only forum topics
                        } elseif ( !empty( $_GET['type'] ) && ( bbp_get_topic_post_type() === $_GET['type'] ) ) {
 
                            // The query
                            $the_query = array(
                                'author'         => 0,
                                'feed'           => true,
                                'post_type'      => bbp_get_topic_post_type(),
                                'post_parent'    => bbp_get_forum_id(),
                                'post_status'    => array( bbp_get_public_status_id(), bbp_get_closed_status_id() ),
                                'posts_per_page' => bbp_get_topics_per_rss_page(),
                                'order'          => 'DESC'
                            );
 
                            // Output the feed
                            bbp_display_topics_feed_rss2( $the_query );
 
                        // All forum topics and replies
                        } else {
 
                            // Exclude private/hidden forums if not looking at single
                            if ( empty( $select_query_vars ) )
                                $meta_query = array( bbp_exclude_forum_ids( 'meta_query' ) );
 
                            // The query
                            $the_query = array(
                                'author'         => 0,
                                'feed'           => true,
                                'post_type'      => array( bbp_get_reply_post_type(), bbp_get_topic_post_type() ),
                                'post_parent'    => 'any',
                                'post_status'    => array( bbp_get_public_status_id(), bbp_get_closed_status_id() ),
                                'posts_per_page' => bbp_get_replies_per_rss_page(),
                                'order'          => 'DESC',
                                'meta_query'     => $meta_query
                            );
 
                            // Output the feed
                            bbp_display_replies_feed_rss2( $the_query );
                        }
 
                        break;
 
                    // Topic feed - Show replies
                    case bbp_get_topic_post_type() :
 
                        // Single topic
                        if ( !empty( $select_query_vars ) ) {
 
                            // Load up our own query
                            query_posts( array_merge( array(
                                'post_type' => bbp_get_topic_post_type(),
                                'feed'      => true
                            ), $select_query_vars ) );
 
                            // Output the feed
                            bbp_display_replies_feed_rss2( array( 'feed' => true ) );
 
                        // All topics
                        } else {
 
                            // The query
                            $the_query = array(
                                'author'         => 0,
                                'feed'           => true,
                                'post_parent'    => 'any',
                                'posts_per_page' => bbp_get_topics_per_rss_page(),
                                'show_stickies'  => false
                            );
 
                            // Output the feed
                            bbp_display_topics_feed_rss2( $the_query );
                        }
 
                        break;
 
                    // Replies
                    case bbp_get_reply_post_type() :
 
                        // The query
                        $the_query = array(
                            'posts_per_page' => bbp_get_replies_per_rss_page(),
                            'meta_query'     => array( array( ) ),
                            'feed'           => true
                        );
 
                        // All replies
                        if ( empty( $select_query_vars ) ) {
                            bbp_display_replies_feed_rss2( $the_query );
                        }
 
                        break;
                }
            }
 
        // Single Topic Vview
        } elseif ( isset( $query_vars[ bbp_get_view_rewrite_id() ] ) ) {
 
            // Get the view
            $view = $query_vars[ bbp_get_view_rewrite_id() ];
 
            // We have a view to display a feed
            if ( !empty( $view ) ) {
 
                // Get the view query
                $the_query = bbp_get_view_query_args( $view );
 
                // Output the feed
                bbp_display_topics_feed_rss2( $the_query );
            }
        }
 
        // @todo User profile feeds
    }
 
    // No feed so continue on
    return $query_vars;
}

Changelog

Changelog
Version Description
bbPress (r3171) Introduced.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.