Changeset 7361 for trunk/src/includes/admin/tools/converter.php

Timestamp:

11/16/2025 11:04:14 PM (3 months ago)

Author:

johnjamesjacoby

Message:

Tools - Code Improvement: Document some filters.

This commit improves the code documentation of several filters across the codebase.

Props johnjamesjacoby, narenin, sirlouen.

In trunk, for 2.7.

See #3110.

File:

• trunk/src/includes/admin/tools/converter.php (modified) (2 diffs)

trunk/src/includes/admin/tools/converter.php

@@ -51 +51 @@
     }
 
-    // Filter & return
+    /**
+     * Filters the array of available converters.
+     *
+     * @since 2.6.0 bbPress (r6447)
+     *
+     * @param array $files Array of available converters with names as keys and file paths as values.
+     */
     return (array) apply_filters( 'bbp_get_converters', $files );
 }
@@ -96 +102 @@
     }
 
-    // Filter & return
+    /**
+     * Filters the newly created converter object.
+     *
+     * @since 2.0.0
+     *
+     * @param mixed  $converter The converter object if it exists, null otherwise.
+     * @param string $platform  Name of the platform class used for conversion.
+     */
     return apply_filters( 'bbp_new_converter', $converter, $platform );
 }