Changeset 5676 for trunk/src/includes/forums/template.php

Timestamp:

04/15/2015 02:33:11 AM (11 years ago)

Author:

johnjamesjacoby

Message:

All: Update default values for $args parameters from empty strings to empty arrays.

This is a micro-optimization to avoid unnecessary calls to wp_parse_str() inside bbp_parse_args().

File:

• trunk/src/includes/forums/template.php (modified) (15 diffs)

trunk/src/includes/forums/template.php

@@ -102 +102 @@
  * @since bbPress (r2464)
  *
- * @param mixed $args All the arguments supported by {@link WP_Query}
+ * @param array $args All the arguments supported by {@link WP_Query}
  * @uses WP_Query To make query and get the forums
  * @uses bbp_get_forum_post_type() To get the forum post type id
@@ -114 +114 @@
  * @return object Multidimensional array of forum information
  */
-function bbp_has_forums( $args = '' ) {
+function bbp_has_forums( $args = array() ) {
 
     // Forum archive only shows root
@@ -677 +677 @@
  * @since bbPress (r2747)
  *
- * @param mixed $args All the arguments supported by {@link WP_Query}
+ * @param array $args All the arguments supported by {@link WP_Query}
  * @uses bbp_get_forum_id() To get the forum id
  * @uses current_user_can() To check if the current user is capable of
@@ -686 +686 @@
  * @return mixed false if none, array of subs if yes
  */
-function bbp_forum_get_subforums( $args = '' ) {
+function bbp_forum_get_subforums( $args = array() ) {
 
     // Use passed integer as post_parent
@@ -739 +739 @@
  * Output a list of forums (can be used to list subforums)
  *
- * @param mixed $args The function supports these args:
+ * @param array $args The function supports these args:
  *  - before: To put before the output. Defaults to '<ul class="bbp-forums">'
  *  - after: To put after the output. Defaults to '</ul>'
@@ -755 +755 @@
  * @uses bbp_get_forum_reply_count() To get forum reply count
  */
-function bbp_list_forums( $args = '' ) {
+function bbp_list_forums( $args = array() ) {
 
     // Define used variables
@@ -2036 +2036 @@
  * @uses bbp_get_single_forum_description() Return the eventual output
  */
-function bbp_single_forum_description( $args = '' ) {
+function bbp_single_forum_description( $args = array() ) {
     echo bbp_get_single_forum_description( $args );
 }
@@ -2045 +2045 @@
      * @since bbPress (r2860)
      *
-     * @param mixed $args This function supports these arguments:
+     * @param array $args This function supports these arguments:
      *  - forum_id: Forum id
      *  - before: Before the text
@@ -2061 +2061 @@
      * @return string Filtered forum description
      */
-    function bbp_get_single_forum_description( $args = '' ) {
+    function bbp_get_single_forum_description( $args = array() ) {
 
         // Parse arguments against default values
@@ -2425 +2425 @@
  * @uses bbp_get_form_forum_type() To get the topic's forum id
  */
-function bbp_form_forum_type_dropdown( $args = '' ) {
+function bbp_form_forum_type_dropdown( $args = array() ) {
     echo bbp_get_form_forum_type_dropdown( $args );
 }
@@ -2443 +2443 @@
      * @return string HTML select list for selecting forum type
      */
-    function bbp_get_form_forum_type_dropdown( $args = '' ) {
+    function bbp_get_form_forum_type_dropdown( $args = array() ) {
 
         // Backpat for handling passing of a forum ID as integer
@@ -2517 +2517 @@
  * @uses bbp_get_form_forum_status() To get the topic's forum id
  */
-function bbp_form_forum_status_dropdown( $args = '' ) {
+function bbp_form_forum_status_dropdown( $args = array() ) {
     echo bbp_get_form_forum_status_dropdown( $args );
 }
@@ -2535 +2535 @@
      * @return string HTML select list for selecting forum status
      */
-    function bbp_get_form_forum_status_dropdown( $args = '' ) {
+    function bbp_get_form_forum_status_dropdown( $args = array() ) {
 
         // Backpat for handling passing of a forum ID
@@ -2609 +2609 @@
  * @uses bbp_get_form_forum_visibility() To get the topic's forum id
  */
-function bbp_form_forum_visibility_dropdown( $args = '' ) {
+function bbp_form_forum_visibility_dropdown( $args = array() ) {
     echo bbp_get_form_forum_visibility_dropdown( $args );
 }
@@ -2627 +2627 @@
      * @return string HTML select list for selecting forum visibility
      */
-    function bbp_get_form_forum_visibility_dropdown( $args = '' ) {
+    function bbp_get_form_forum_visibility_dropdown( $args = array() ) {
 
         // Backpat for handling passing of a forum ID