PluginProbe
bbPress / 2.6.17
bbPress v2.6.17
2.6.17 trunk 2.0 2.0-beta-1 2.0-beta-2b 2.0-beta-3 2.0-beta-3b 2.0-rc-2 2.0-rc-3 2.0-rc-4 2.0-rc-5 2.0.1 2.0.2 2.0.3 2.1 2.1-beta-1 2.1-rc1 2.1-rc2 2.1-rc3 2.1-rc4 2.1.1 2.1.2 2.1.3 2.2 2.2.1 All 72 releases
← All changes | includes/search/functions.php +10 -10 trunk2.6.17 View file →
@@ -1,8 +1,8 @@
1 1 <?php
2 2
3 3 /**
4 - * bbPress Search Functions.
4 + * bbPress Search Functions
5 5 *
6 6 * @package bbPress
7 7 * @subpackage Functions
8 8 */
@@ -12,14 +12,14 @@
12 12
13 13 /** Query *********************************************************************/
14 14
15 15 /**
16 - * Run the search query.
16 + * Run the search query
17 17 *
18 18 * @since 2.3.0 bbPress (r4579)
19 19 *
20 - * @param mixed $new_args New arguments.
21 - * @return bool False if no results, otherwise if search results are there.
20 + * @param mixed $new_args New arguments
21 + * @return bool False if no results, otherwise if search results are there
22 22 */
23 23 function bbp_search_query( $new_args = array() ) {
24 24
25 25 // Existing arguments
@@ -34,13 +34,13 @@
34 34 return bbp_has_search_results( $query_args );
35 35 }
36 36
37 37 /**
38 - * Return the search query arguments.
38 + * Return the search query args
39 39 *
40 40 * @since 2.3.0 bbPress (r4579)
41 41 *
42 - * @return array Query arguments.
42 + * @return array Query arguments
43 43 */
44 44 function bbp_get_search_query_args() {
45 45
46 46 // Get search terms
@@ -53,13 +53,13 @@
53 53 return apply_filters( 'bbp_get_search_query_args', $retval );
54 54 }
55 55
56 56 /**
57 - * Redirect to search results page if needed.
57 + * Redirect to search results page if needed
58 58 *
59 59 * @since 2.4.0 bbPress (r4928)
60 60 *
61 - * @return If a redirect is not needed.
61 + * @return If a redirect is not needed
62 62 */
63 63 function bbp_search_results_redirect() {
64 64
65 65 // Bail if not a search request action
@@ -82,9 +82,9 @@
82 82 bbp_redirect( $redirect_to );
83 83 }
84 84
85 85 /**
86 - * Return an array of search types.
86 + * Return an array of search types
87 87 *
88 88 * @since 2.6.0 bbPress (r6903)
89 89 *
90 90 * @return array
@@ -99,9 +99,9 @@
99 99 * Accepts a single parameter to be used for forums, topics, or replies.
100 100 *
101 101 * @since 2.6.0 bbPress (r6903)
102 102 *
103 - * @param string $query_arg s|fs|ts|rs.
103 + * @param string $query_arg s|fs|ts|rs
104 104 *
105 105 * @return mixed
106 106 */
107 107 function bbp_sanitize_search_request( $query_arg = 's' ) {