Changeset 5303 for sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php

Timestamp:

04/09/2017 10:57:04 PM (9 years ago)

Author:

coffee2code

Message:

Support Forums, User Badges: Fix @return docs for get_author_badge() and get_moderator_badge().

Props SergeyBiryukov.
Fixes #2707.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-bbp-user-badges/inc/class-plugin.php

@@ -284 +284 @@
      *                          'topic' or 'reply'.
      * @param int    $item_id   The ID of the item getting badge assigned.
-     * @return array|false      Associative array with keys 'type', 'slug', and
-     *                          'user_nicename' if author merits a badge, else null.
+     * @return array|false      Associative array with keys 'type', 'label', and
+     *                          'help' if author merits a badge, else false.
      */
     protected function get_author_badge( $item_type, $item_id ) {
@@ -322 +322 @@
      * @access protected
      *
-     * @return array|false Associative array with keys 'type', 'slug', and
-     *                     'user_login' if author merits a badge, else false.
+     * @return array|false Associative array with keys 'type', 'label', and
+     *                     'help' if author merits a badge, else false.
      */
     protected function get_moderator_badge() {