Changeset 9848

Timestamp:

05/07/2015 12:53:06 AM (11 years ago)

Author:

tw2113

Message:

Fixes documentation changes for some filters.

Props ecehren.

See #5940, #5941, #5943.

Location:

trunk/src

Files:

• bp-core/bp-core-filters.php (modified) (1 diff)
• bp-forums/bp-forums-template.php (modified) (2 diffs)
• bp-groups/bp-groups-template.php (modified) (2 diffs)

trunk/src/bp-core/bp-core-filters.php

@@ -802 +802 @@
 
         /**
-         * @param  string the BuddyPress page title
-         * @param  string $title the original WordPress page title
-         * @param  string $sep the title parts separator
+         * Filters the page title for BuddyPress pages.
+         *
+         * @since  BuddyPress (1.5.0)
+         *
+         * @param  string $new_title   The BuddyPress page title.
+         * @param  string $title       The original WordPress page title.
+         * @param  string $sep         The title parts separator.
          * @param  string $seplocation Location of the separator (left or right).
          */

trunk/src/bp-forums/bp-forums-template.php

@@ -1890 +1890 @@
                  * @since BuddyPress (1.5.0)
                  *
-                 * @param string $value    Pagination count for the current topic list.
+                 * @param string $message  Pagination count for the current topic list.
                  * @param string $from_num Low end count in the view.
                  * @param string $to_num   High end count in the view.
@@ -2640 +2640 @@
          * @since BuddyPress (1.0.0)
          *
-         * @param string $value    Pagination count for the current topic page.
+         * @param string $message  Pagination count for the current topic page.
          * @param string $from_num Low end count in the view.
          * @param string $to_num   High end count in the view.

trunk/src/bp-groups/bp-groups-template.php

@@ -1811 +1811 @@
                  * @since BuddyPress (1.5.0)
                  *
-                 * @param string $value    "Viewing x-y of z groups" text.
+                 * @param string $message  "Viewing x-y of z groups" text.
                  * @param string $from_num Total amount for the low value in the range.
                  * @param string $to_num   Total amount for the high value in the range.
@@ -5268 +5268 @@
                  * @since BuddyPress (2.0.0)
                  *
-                 * @param string $value Pagination count text for group membership requests.
+                 * @param string $message  Pagination count text for group membership requests.
+                 * @param string $from_num Total amount for the low value in the range.
+                 * @param string $to_num   Total amount for the high value in the range.
+                 * @param string $total    Total amount of members found.
                  */
                 return apply_filters( 'bp_get_group_requests_pagination_count', $message, $from_num, $to_num, $total );