Changeset 7361 for trunk/src/includes/replies/capabilities.php

Timestamp:

11/16/2025 11:04:14 PM (10 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/replies/capabilities.php (modified) (2 diffs)

trunk/src/includes/replies/capabilities.php

@@ -19 +19 @@
 function bbp_get_reply_caps() {
 
-        // Filter & return
+        /**
+         * Filters the reply capabilities.
+         *
+         * @since 2.0.0
+         *
+         * @param array $caps An array of reply capabilities with keys mapping to WordPress capabilities.
+         */
         return (array) apply_filters( 'bbp_get_reply_caps', array(
                 'edit_posts'          => 'edit_replies',
@@ -237 +243 @@
         }
 
-        // Filter & return
+        /**
+         * Filters the Reply meta capabilities.
+         *
+         * @since 2.2.0 bbPress (r4242)
+         *
+         * @param array  $caps    The current capabilities being checked.
+         * @param string $cap     The capability being checked.
+         * @param int    $user_id The ID of the user whose capabilities are being checked.
+         * @param array  $args    Additional arguments provided for the capability check.
+         */
         return (array) apply_filters( 'bbp_map_reply_meta_caps', $caps, $cap, $user_id, $args );
 }