Changeset 5676 for trunk/src/includes/users/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/users/template.php (modified) (15 diffs)

trunk/src/includes/users/template.php

@@ -533 +533 @@
  * @since bbPress (r2827)
  *
- * @param mixed $args Optional. See {@link bbp_get_admin_link()}
+ * @param array $args Optional. See {@link bbp_get_admin_link()}
  * @uses bbp_get_admin_link() To get the admin link
  */
-function bbp_admin_link( $args = '' ) {
+function bbp_admin_link( $args = array() ) {
     echo bbp_get_admin_link( $args );
 }
@@ -544 +544 @@
      * @since bbPress (r2827)
      *
-     * @param mixed $args Optional. This function supports these arguments:
+     * @param array $args Optional. This function supports these arguments:
      *  - text: The text
      *  - before: Before the lnk
@@ -553 +553 @@
      * @return The link
      */
-    function bbp_get_admin_link( $args = '' ) {
+    function bbp_get_admin_link( $args = array() ) {
         if ( ! current_user_can( 'moderate' ) ) {
             return;
@@ -581 +581 @@
  * @since bbPress (r3120)
  *
- * @param mixed $args Optional. If it is an integer, it is used as post id.
+ * @param array $args Optional. If it is an integer, it is used as post id.
  * @uses bbp_get_author_ip() To get the post author link
  */
-function bbp_author_ip( $args = '' ) {
+function bbp_author_ip( $args = array() ) {
     echo bbp_get_author_ip( $args );
 }
@@ -592 +592 @@
      * @since bbPress (r3120)
      *
-     * @param mixed $args Optional. If an integer, it is used as reply id.
+     * @param array $args Optional. If an integer, it is used as reply id.
      * @uses get_post_meta() To check if it's a topic page
      * @return string Author link of reply
      */
-    function bbp_get_author_ip( $args = '' ) {
+    function bbp_get_author_ip( $args = array() ) {
 
         // Used as post id
@@ -859 +859 @@
  * @since bbPress (r2652)
  *
- * @param mixed $args See {@link bbp_get_user_favorites_link()}
+ * @param array $args See {@link bbp_get_user_favorites_link()}
  * @param int $user_id Optional. User id
  * @param bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">.
@@ -875 +875 @@
      * @since bbPress (r2652)
      *
-     * @param mixed $args This function supports these arguments:
+     * @param array $args This function supports these arguments:
      *  - subscribe: Favorite text
      *  - unsubscribe: Unfavorite text
@@ -896 +896 @@
      * @return string User favorites link
      */
-    function bbp_get_user_favorites_link( $args = '', $user_id = 0, $wrap = true ) {
+    function bbp_get_user_favorites_link( $args = array(), $user_id = 0, $wrap = true ) {
         if ( ! bbp_is_favorites_active() ) {
             return false;
@@ -1024 +1024 @@
  * @since bbPress (r2668)
  *
- * @param mixed $args See {@link bbp_get_user_subscribe_link()}
+ * @param array $args See {@link bbp_get_user_subscribe_link()}
  * @param int $user_id Optional. User id
  * @param bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
  * @uses bbp_get_user_subscribe_link() To get the subscribe link
  */
-function bbp_user_subscribe_link( $args = '', $user_id = 0, $wrap = true ) {
+function bbp_user_subscribe_link( $args = array(), $user_id = 0, $wrap = true ) {
     echo bbp_get_user_subscribe_link( $args, $user_id, $wrap );
 }
@@ -1037 +1037 @@
      * @since bbPress (r2668)
      *
-     * @param mixed $args This function supports these arguments:
+     * @param array $args This function supports these arguments:
      *  - subscribe: Subscribe text
      *  - unsubscribe: Unsubscribe text
@@ -1062 +1062 @@
      * @return string Permanent link to topic
      */
-    function bbp_get_user_subscribe_link( $args = '', $user_id = 0, $wrap = true ) {
+    function bbp_get_user_subscribe_link( $args = array(), $user_id = 0, $wrap = true ) {
         if ( ! bbp_is_subscriptions_active() ) {
             return;
@@ -1682 +1682 @@
  * @since bbPress (r2875)
  *
- * @param mixed $args Optional. If it is an integer, it is used as post id.
+ * @param array $args Optional. If it is an integer, it is used as post id.
  * @uses bbp_get_author_link() To get the post author link
  */
-function bbp_author_link( $args = '' ) {
+function bbp_author_link( $args = array() ) {
     echo bbp_get_author_link( $args );
 }
@@ -1693 +1693 @@
      * @since bbPress (r2875)
      *
-     * @param mixed $args Optional. If an integer, it is used as reply id.
+     * @param array $args Optional. If an integer, it is used as reply id.
      * @uses bbp_is_topic() To check if it's a topic page
      * @uses bbp_get_topic_author_link() To get the topic author link
@@ -1708 +1708 @@
      * @return string Author link of reply
      */
-    function bbp_get_author_link( $args = '' ) {
+    function bbp_get_author_link( $args = array() ) {
 
         $post_id = is_numeric( $args ) ? (int) $args : 0;
@@ -1797 +1797 @@
  * @return bool
  */
-function bbp_user_can_view_forum( $args = '' ) {
+function bbp_user_can_view_forum( $args = array() ) {
 
     // Parse arguments against default values