Changeset 3326 for sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php

Timestamp:

06/09/2016 10:28:14 PM (10 years ago)

Author:

obenland

Message:

Plugin Directory: Docs cleanup.

For a more at ease IDE.

See #1584.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php

@@ -12 +12 @@
          * Returns a string representing the number of active installs for an item.
          *
-         * @param bool $full whether to include "actuve installs" suffix. Default: true.
-         * @return string "1+ million" or "1+ milllion active installs" depending on $full.
+         * @param bool              $full Whether to include "active installs" suffix. Default: true.
+         * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
+         * @return string "1+ million" or "1+ million active installs" depending on $full.
          */
         static function active_installs( $full = true, $post = null ) {
@@ -67 +68 @@
          * Displays a plugin's rating with the amount of ratings it has received.
          *
-         * @param \WP_Post|int $post
+         * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
          * @return string
          */
-        public static function get_star_rating( $post = 0 ) {
+        public static function get_star_rating( $post = null ) {
                 $post = get_post( $post );
 
@@ -86 +87 @@
 
         /**
+         * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
          * @return array
          */