Changeset 5278 for trunk/bp-core/bp-core-moderation.php

Timestamp:

11/05/2011 09:31:05 PM (13 years ago)

Author:

djpaul

Message:

Tidy up phpdoc and use bp_get_option for BuddyPress options in bp-core-moderation

File:

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

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

@@ -1 +1 @@
 <?php
-
 /**
  * BuddyPress Moderation Functions
@@ -20 +19 @@
  * of time.
  *
- * @since BuddyPress (1.6)
- *
  * @param int $user_id User id to check for flood
- * @uses get_option() To get the throttle time
+ * @return bool True if there is no flooding, true if there is
+ * @since 1.6
+ * @uses current_user_can() To check if the current user can throttle
+ * @uses bp_get_option() To get the throttle time
  * @uses get_transient() To get the last posted transient of the ip
  * @uses get_user_meta() To get the last posted meta of the user
- * @uses current_user_can() To check if the current user can throttle
- * @return bool True if there is no flooding, true if there is
  */
 function bp_core_check_for_flood( $user_id = 0 ) {
 
     // Option disabled. No flood checks.
-    if ( !$throttle_time = get_option( '_bp_throttle_time' ) )
+    if ( !$throttle_time = bp_get_option( '_bp_throttle_time' ) )
         return true;
 
@@ -49 +47 @@
  * Check for moderation keys and too many links
  *
- * @since BuddyPress (1.6)
- *
  * @param int $user_id Topic or reply author ID
  * @param string $title The title of the content
  * @param string $content The content being posted
+ * @return bool True if test is passed, false if fail
+ * @since 1.6
+ * @uses bp_current_author_ip() To get current user IP address
+ * @uses bp_current_author_ua() To get current user agent
  * @uses is_super_admin() Allow super admins to bypass blacklist
- * @uses bbp_current_author_ip() To get current user IP address
- * @uses bbp_current_author_ua() To get current user agent
- * @return bool True if test is passed, false if fail
  */
 function bp_core_check_for_moderation( $user_id = 0, $title = '', $content = '' ) {
@@ -156 +153 @@
  * Checks for blocked keys
  *
- * @since bbPress (r3446)
- *
  * @param int $user_id Topic or reply author ID
  * @param string $title The title of the content
  * @param string $content The content being posted
- * @uses is_super_admin() Allow super admins to bypass blacklist
+ * @return bool True if test is passed, false if fail
  * @uses bp_current_author_ip() To get current user IP address
  * @uses bp_current_author_ua() To get current user agent
- * @return bool True if test is passed, false if fail
+ * @uses is_super_admin() Allow super admins to bypass blacklist
+ * @since 1.6
  */
 function bp_core_check_for_blacklist( $user_id = 0, $title = '', $content = '' ) {
@@ -222 +218 @@
         if ( empty( $word ) ) { continue; }
 
-        // Do some escaping magic so that '#' chars in the
-        // spam words don't break things:
+        // Do some escaping magic so that '#' chars in the spam words don't break things:
         $word    = preg_quote( $word, '#' );
         $pattern = "#$word#i";
@@ -246 +241 @@
  * Get the current-user IP address
  *
- * @since BuddyPress (1.6)
- *
  * @return string
+ * @since 1.6
  */
 function bp_core_current_user_ip() {
@@ -259 +253 @@
  * Get the current-user user-agent
  *
- * @since BuddyPress (1.6)
- *
  * @return string
+ * @since 1.6
  */
 function bp_core_current_user_ua() {
@@ -273 +266 @@
     return apply_filters( 'bp_core_current_user_ua', $retval );
 }
-
 ?>