Changeset 11527

Timestamp:

02/06/2022 02:41:22 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Support Forums: Improve consistency of some DocBlocks and comments in the User_Notes class.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php (modified) (7 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php

@@ -22 +22 @@
                 add_action( 'wp_enqueue_scripts',                   array( $this, 'enqueue_scripts' ) );
 
-                add_action( 'bbp_post_request',                     array( $this, 'add_user_note_request' ), 0 ); // Low priority to get below bbp_edit_user_handler()
+                add_action( 'bbp_post_request',                     array( $this, 'add_user_note_request' ), 0 ); // Low priority to get below bbp_edit_user_handler().
                 add_action( 'bbp_get_request',                      array( $this, 'delete_user_note_request' ) );
 
@@ -88 +88 @@
          * Saves a note to a users meta data.
          * 
-         * @param int    $user_id   The User ID.
+         * @param int    $user_id   The user ID.
          * @param string $note_text The note text to add.
          * @param int    $post_id   The support thread this text is related to. Optional.
@@ -210 +210 @@
          * Retrieves all notes for a particular user.
          *
-         * @param int $user_id User ID. Defaults to the current post author.
-         * @param bool $display_add_note_form Whether to show the Add New Note form.
+         * @param int  $user_id               User ID. Defaults to the current post author.
+         * @param bool $display_add_note_form Whether to show the Add New Note form. Default true.
          * @return array {
          *     Array of user notes.
@@ -256 +256 @@
                         $note_meta = array(
                                 'author' => sprintf(
-                                        /* translators: 1: user note author's display name, 2: link to post, 3: date, 4: time */
+                                        /* translators: 1: User note author's display name, 2: Link to post, 3: Date, 4: Time. */
                                         __( 'By %1$s on <a href="%2$s">%3$s at %4$s</a>', 'wporg-forums' ),
                                         sprintf( '<a href="%s">%s</a>',
@@ -263 +263 @@
                                         ),
                                         esc_url( $post_permalink ),
-                                        /* translators: localized date format, see https://www.php.net/date */
+                                        /* translators: Localized date format, see https://www.php.net/date */
                                         mysql2date( __( 'F j, Y', 'wporg-forums' ), $note->date ),
-                                        /* translators: localized time format, see https://www.php.net/date */
+                                        /* translators: Localized time format, see https://www.php.net/date */
                                         mysql2date( __( 'g:i a', 'wporg-forums' ), $note->date )
                                 )
@@ -341 +341 @@
          * in the note adding/editing form with the current post ID and permalink.
          *
-         * @param int $user_id User ID. Default 0.
-         * @param bool $display_add_note_form Whether to show the add new note form. Default true.
+         * @param int  $user_id               User ID. Default 0.
+         * @param bool $display_add_note_form Whether to show the Add New Note form. Default true.
          * @return string User notes output.
          */
@@ -479 +479 @@
                         esc_attr( $post_id ),
                         esc_html(
-                                /* translators: %d: user notes count */
+                                /* translators: %d: User notes count. */
                                 sprintf( __( 'User Notes (%d)', 'wporg-forums' ),
                                         $this->get_user_notes( $user_id )->count