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

Timestamp:

06/09/2016 10:28:14 PM (9 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-plugin-directory.php (modified) (6 diffs)

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

@@ -359 +359 @@
      * Filter the permalink for terms to be more useful.
      *
-     * @param string   $termlink The generated term link.
-     * @param \WP_Term $term     The term the link is for.
-     */
-    public function term_link( $termlink, $term ) {
+     * @param string   $term_link The generated term link.
+     * @param \WP_Term $term      The term the link is for.
+     * @return string|false
+     */
+    public function term_link( $term_link, $term ) {
         if ( 'plugin_business_model' == $term->taxonomy ) {
             return false;
@@ -371 +372 @@
         }
 
-        return $termlink;
+        return $term_link;
     }
 
@@ -447 +448 @@
      * Returns the requested page's content, translated.
      *
-     * @param string $content
+     * @param string $content Post content.
+     * @param string $section Optional. Which readme section to translate.
      * @return string
      */
@@ -454 +456 @@
             return $content;
         }
-        return Plugin_i18n::instance()->translate( $section, $content );
+        return Plugin_I18n::instance()->translate( $section, $content );
     }
 
@@ -460 +462 @@
      * Returns the requested page's content, translated.
      *
-     * @param string $content
+     * @param string $title
+     * @param int    $post_id
      * @return string
      */
     public function translate_post_title( $title, $post_id ) {
         if ( $post_id === get_post()->ID ) {
-            return Plugin_i18n::instance()->translate( 'title', $title );
+            return Plugin_I18n::instance()->translate( 'title', $title );
         }
         return $title;
@@ -473 +476 @@
      * Returns the requested page's excerpt, translated.
      *
-     * @param string $content
+     * @param string $excerpt
      * @return string
      */
     public function translate_post_excerpt( $excerpt ) {
-        return Plugin_i18n::instance()->translate( 'excerpt', $excerpt );
+        return Plugin_I18n::instance()->translate( 'excerpt', $excerpt );
     }