Changeset 9594

Timestamp:

03/05/2015 04:48:11 AM (11 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-moderation.php.

See #5940.

File:

• trunk/src/bp-core/bp-core-moderation.php (modified) (5 diffs)

trunk/src/bp-core/bp-core-moderation.php

@@ -65 +65 @@
 function bp_core_check_for_moderation( $user_id = 0, $title = '', $content = '' ) {
 
-        // Allow for moderation check to be skipped
+        /**
+         * Filters whether or not to bypass checking for moderation keys and too many links.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param bool   $value   Whether or not to bypass checking. Default false.
+         * @param int    $user_id Topic of reply author ID.
+         * @param string $title   The title of the content.
+         * @param string $content $the content being posted.
+         */
         if ( apply_filters( 'bp_bypass_check_for_moderation', false, $user_id, $title, $content ) ) {
                 return true;
@@ -112 +121 @@
                 // Allow for bumping the max to include the user's URL
                 if ( ! empty( $_post['url'] ) ) {
+
+                        /**
+                         * Filters the maximum amount of links allowed to include the user's URL.
+                         *
+                         * @since BuddyPress (1.6.0)
+                         *
+                         * @param string $num_links How many links found.
+                         * @param string $value     User's url.
+                         */
                         $num_links = apply_filters( 'comment_max_links_url', $num_links, $_post['url'] );
                 }
@@ -181 +199 @@
 function bp_core_check_for_blacklist( $user_id = 0, $title = '', $content = '' ) {
 
-        // Allow for blacklist check to be skipped
+        /**
+         * Filters whether or not to bypass checking for blocked keys.
+         *
+         * @since BuddyPress (2.2.0)
+         *
+         * @param bool   $value   Whether or not to bypass checking. Default false.
+         * @param int    $user_id Topic of reply author ID.
+         * @param string $title   The title of the content.
+         * @param string $content $the content being posted.
+         */
         if ( apply_filters( 'bp_bypass_check_for_blacklist', false, $user_id, $title, $content ) ) {
                 return true;
@@ -273 +300 @@
         $retval = preg_replace( '/[^0-9a-fA-F:., ]/', '', $_SERVER['REMOTE_ADDR'] );
 
+        /**
+         * Filters the current user's IP address.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param string $retval Current user's IP Address.
+         */
         return apply_filters( 'bp_core_current_user_ip', $retval );
 }
@@ -292 +326 @@
         }
 
+        /**
+         * Filters the current user's user-agent.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param string $retval Current user's user-agent
+         */
         return apply_filters( 'bp_core_current_user_ua', $retval );
 }