Ticket #44703: 44703.diff

tests/phpunit/includes/functions.php

@@ -16 +16 @@
         unset( $_SERVER['HTTPS'] );
 }
 
-// For adding hooks before loading WP
+/**
+ * Adds hooks before loading WP.
+ *
+ * @param string       $tag             The name for the filter to add.
+ * @param Object|array $function_to_add The function/callback to execute on call.
+ * @param int          $priority        The priority.
+ * @param int          $accepted_args   The amount of accepted arguments.
+ *
+ * @return bool Always true.
+ */
 function tests_add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
         global $wp_filter;
 
@@ -32 +41 @@
         return true;
 }
 
+/**
+ * Generates an unique id based on the given arguments.
+ *
+ * @param string       $tag      Unused. The name of the filter to build id for.
+ * @param Object|array $function The function to generate id for.
+ * @param int          $priority Unused. The priority.
+ *
+ * @return array|string
+ */
 function _test_filter_build_unique_id( $tag, $function, $priority ) {
         if ( is_string( $function ) ) {
                 return $function;
@@ -38 +56 @@
         }
 
         if ( is_object( $function ) ) {
-                // Closures are currently implemented as objects
+                // Closures are currently implemented as objects.
                 $function = array( $function, '' );
         } else {
                 $function = (array) $function;
@@ -47 +65 @@
         if ( is_object( $function[0] ) ) {
                 return spl_object_hash( $function[0] ) . $function[1];
         } elseif ( is_string( $function[0] ) ) {
-                // Static Calling
+                // Static Calling.
                 return $function[0] . $function[1];
         }
 }
 
+/**
+ * Deletes all data from the database
+ *
+ * @return void
+ */
 function _delete_all_data() {
         global $wpdb;
 
@@ -79 +102 @@
         $wpdb->query( "DELETE FROM {$wpdb->usermeta} WHERE user_id != 1" );
 }
 
+/**
+ * Deletes all the posts from the database.
+ *
+ * @return void
+ */
 function _delete_all_posts() {
         global $wpdb;