Changeset 7361 for trunk/src/includes/users/signups.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/users/signups.php (modified) (1 diff)

trunk/src/includes/users/signups.php

@@ -234 +234 @@
     }
 
-    // Filter & return
+    /**
+     * Filters the validated signup role.
+     *
+     * @since 2.6.5
+     *
+     * @param string $retval The valid role ID if validation passes; otherwise, an empty string.
+     * @param string $to_validate The role ID that was validated.
+     */
     return (string) apply_filters( 'bbp_validate_signup_role', $retval, $to_validate );
 }