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

Timestamp:

11/29/2019 09:40:58 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct @param type for the function parameter in tests_add_filter() and _test_filter_build_unique_id().

Synchronize documentation for add_filter(), tests_add_filter(), _wp_filter_build_unique_id(), _test_filter_build_unique_id().

Add a note that $tag and $priority are no longer used in _wp_filter_build_unique_id() since [46220], and the function always returns a string now.

Props donmhico, remcotolsma, SergeyBiryukov.
Fixes #47407. See #48303.

File:

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

trunk/tests/phpunit/includes/functions.php

@@ -39 +39 @@
  * 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.
+ * @see add_filter()
+ *
+ * @param string   $tag             The name of the filter to hook the $function_to_add callback to.
+ * @param callable $function_to_add The callback to be run when the filter is applied.
+ * @param int      $priority        Optional. Used to specify the order in which the functions
+ *                                  associated with a particular action are executed.
+ *                                  Lower numbers correspond with earlier execution,
+ *                                  and functions with the same priority are executed
+ *                                  in the order in which they were added to the action. Default 10.
+ * @param int      $accepted_args   Optional. The number of arguments the function accepts. Default 1.
+ * @return true
  */
 function tests_add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
@@ -51 +57 @@
         add_filter( $tag, $function_to_add, $priority, $accepted_args );
     } else {
-        $idx                                    = _test_filter_build_unique_id( $tag, $function_to_add, $priority );
+        $idx = _test_filter_build_unique_id( $tag, $function_to_add, $priority );
+
         $wp_filter[ $tag ][ $priority ][ $idx ] = array(
             'function'      => $function_to_add,
@@ -63 +70 @@
  * 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.
+ * @see _wp_filter_build_unique_id()
+ *
+ * @param string   $tag      Unused. The name of the filter to build ID for.
+ * @param callable $function The function to generate ID for.
+ * @param int      $priority Unused. The order in which the functions
+ *                           associated with a particular action are executed.
+ * @return string Unique function ID for usage as array key.
  */
 function _test_filter_build_unique_id( $tag, $function, $priority ) {
@@ -81 +91 @@
 
     if ( is_object( $function[0] ) ) {
+        // Object class calling.
         return spl_object_hash( $function[0] ) . $function[1];
     } elseif ( is_string( $function[0] ) ) {
-        // Static Calling.
+        // Static calling.
         return $function[0] . $function[1];
     }