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

Timestamp:

04/11/2019 05:29:20 PM (5 years ago)

Author:

johnbillion

Message:

Build/Test tools: Add some docs to the test functions.

Props andizer

Fixes #46501

File:

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

trunk/tests/phpunit/includes/functions.php

@@ -3 +3 @@
 /**
  * Retrieves PHPUnit runner version.
+ *
+ * @return double The version number.
  */
 function tests_get_phpunit_version() {
@@ -135 +137 @@
 }
 
+/**
+ * Handles the WP die handler by outputting the given values as text.
+ *
+ * @param string $message The message.
+ * @param string $title   The title.
+ * @param array  $args    Array with arguments.
+ */
 function _wp_die_handler( $message, $title = '', $args = array() ) {
     if ( ! $GLOBALS['_wp_die_disabled'] ) {
@@ -143 +152 @@
 }
 
+/**
+ * Disables the WP die handler.
+ */
 function _disable_wp_die() {
     $GLOBALS['_wp_die_disabled'] = true;
 }
 
+/**
+ * Enables the WP die handler.
+ */
 function _enable_wp_die() {
     $GLOBALS['_wp_die_disabled'] = false;
 }
 
+/**
+ * Returns the die handler.
+ *
+ * @return string The die handler.
+ */
 function _wp_die_handler_filter() {
     return '_wp_die_handler';
 }
 
+/**
+ * Returns the die handler.
+ *
+ * @return string The die handler.
+ */
 function _wp_die_handler_filter_exit() {
     return '_wp_die_handler_exit';
 }
 
+/**
+ * Dies without an exit.
+ *
+ * @param string $message The message.
+ * @param string $title   The title.
+ * @param array  $args    Array with arguments.
+ */
 function _wp_die_handler_txt( $message, $title, $args ) {
     echo "\nwp_die called\n";
@@ -171 +203 @@
 }
 
+/**
+ * Dies with an exit.
+ *
+ * @param string $message The message.
+ * @param string $title   The title.
+ * @param array  $args    Array with arguments.
+ */
 function _wp_die_handler_exit( $message, $title, $args ) {
     echo "\nwp_die called\n";
@@ -198 +237 @@
 /**
  * Helper used with the `upload_dir` filter to remove the /year/month sub directories from the uploads path and URL.
+ *
+ * @return array The altered array.
  */
 function _upload_dir_no_subdir( $uploads ) {
@@ -211 +252 @@
 /**
  * Helper used with the `upload_dir` filter to set https upload URL.
+ *
+ * @return array The altered array.
  */
 function _upload_dir_https( $uploads ) {
@@ -221 +264 @@
 /**
  * Use the Spy_REST_Server class for the REST server.
+ *
+ * @return string The server class name.
  */
 function _wp_rest_server_class_filter() {