Changeset 43555 for trunk/tests/phpunit/includes/functions.php

Timestamp:

08/02/2018 10:35:10 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Build/Test Tools: Add documentation for tests_add_filter(), _test_filter_build_unique_id(), _delete_all_data(), _delete_all_posts().

Props andizer.
Fixes #44703.

File:

• trunk/tests/phpunit/includes/functions.php (modified) (5 diffs)

trunk/tests/phpunit/includes/functions.php

@@ -17 +17 @@
 }
 
-// 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;
@@ -33 +41 @@
 }
 
+/**
+ * Generates a unique function 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 string Unique function ID.
+ */
 function _test_filter_build_unique_id( $tag, $function, $priority ) {
     if ( is_string( $function ) ) {
@@ -39 +55 @@
 
     if ( is_object( $function ) ) {
-        // Closures are currently implemented as objects
+        // Closures are currently implemented as objects.
         $function = array( $function, '' );
     } else {
@@ -48 +64 @@
         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.
+ */
 function _delete_all_data() {
     global $wpdb;
@@ -80 +99 @@
 }
 
+/**
+ * Deletes all posts from the database.
+ */
 function _delete_all_posts() {
     global $wpdb;