Opt to display errors which occur during finalize action

Author: westonruter

src/wp-includes/template.php

@@ -1031,29 +1031,6 @@ static function ( int $level, string $message, ?string $file = null, ?int $line
 		$did_just_catch_exception = false;
 	}
 
-	if ( $display_errors ) {
-		foreach ( $error_log as $error ) {
-			switch ( $error['level'] ) {
-				case E_USER_NOTICE:
-					$type = 'Notice';
-					break;
-				case E_USER_DEPRECATED:
-					$type = 'Deprecated';
-					break;
-				case E_USER_WARNING:
-					$type = 'Warning';
-					break;
-				default:
-					$type = 'Error';
-			}
-			$format = "<br />\n<b>%s</b>: %s in <b>%s</b> on line <b>%d</b><br />";
-			if ( ! ini_get( 'html_errors' ) ) {
-				$format = strip_tags( $format );
-			}
-			$filtered_output .= sprintf( $format, $type, $error['message'], $error['file'], $error['line'] );
-		}
-	}
-
 	try {
 		/**
 		 * Fires after the template enhancement output buffer has been finalized.
@@ -1074,11 +1051,6 @@ static function ( int $level, string $message, ?string $file = null, ?int $line
 		 * added to the action must not attempt to start their own output buffers. Otherwise, PHP will raise a fatal
 		 * error: "Cannot use output buffering in output buffering display handlers."
 		 *
-		 * If any errors are occur in callbacks for this action (e.g. deprecations, notices, warnings, exceptions),
-		 * there will be no error message printed even if `display_errors` is enabled. This is because the output has
-		 * already been finalized. The error will be emitted to the error log, however, as long as the error reporting
-		 * level is configured.
-		 *
 		 * @since 6.9.0
 		 *
 		 * @param string $output Finalized output buffer.
@@ -1098,9 +1070,32 @@ static function ( int $level, string $message, ?string $file = null, ?int $line
 		$did_just_catch_exception = false;
 	}
 
+	// Append any errors to be displayed before returning flushing the buffer.
 	if ( $display_errors ) {
+		foreach ( $error_log as $error ) {
+			switch ( $error['level'] ) {
+				case E_USER_NOTICE:
+					$type = 'Notice';
+					break;
+				case E_USER_DEPRECATED:
+					$type = 'Deprecated';
+					break;
+				case E_USER_WARNING:
+					$type = 'Warning';
+					break;
+				default:
+					$type = 'Error';
+			}
+			$format = "<br />\n<b>%s</b>: %s in <b>%s</b> on line <b>%d</b><br />";
+			if ( ! ini_get( 'html_errors' ) ) {
+				$format = strip_tags( $format );
+			}
+			$filtered_output .= sprintf( $format, $type, $error['message'], $error['file'], $error['line'] );
+		}
+
 		ini_set( 'display_errors', 1 );
 	}
+
 	restore_error_handler();
 
 	return $filtered_output;

tests/phpunit/tests/template.php

@@ -1011,6 +1011,7 @@ public function data_provider_to_test_wp_finalize_template_enhancement_output_bu
 				),
 				'expected_displayed_errors' => array(
 					'<b>Deprecated</b>: You are history during filter. in <b>__FILE__</b> on line <b>__LINE__</b>',
+					'<b>Deprecated</b>: You are history during action. in <b>__FILE__</b> on line <b>__LINE__</b>',
 				),
 			),
 			'notice'                  => array(
@@ -1028,6 +1029,7 @@ public function data_provider_to_test_wp_finalize_template_enhancement_output_bu
 				),
 				'expected_displayed_errors' => array(
 					'<b>Notice</b>: POSTED: No trespassing during filter. in <b>__FILE__</b> on line <b>__LINE__</b>',
+					'<b>Notice</b>: POSTED: No trespassing during action. in <b>__FILE__</b> on line <b>__LINE__</b>',
 				),
 			),
 			'warning'                 => array(
@@ -1045,6 +1047,7 @@ public function data_provider_to_test_wp_finalize_template_enhancement_output_bu
 				),
 				'expected_displayed_errors' => array(
 					'<b>Warning</b>: AVISO: Piso mojado durante filtro. in <b>__FILE__</b> on line <b>__LINE__</b>',
+					'<b>Warning</b>: AVISO: Piso mojado durante acción. in <b>__FILE__</b> on line <b>__LINE__</b>',
 				),
 			),
 			'error'                   => array(
@@ -1062,6 +1065,7 @@ public function data_provider_to_test_wp_finalize_template_enhancement_output_bu
 				),
 				'expected_displayed_errors' => array(
 					'<b>Error</b>: Uncaught exception "Exception" thrown: User error triggered: ERROR: Can this mistake be rectified during filter? in <b>__FILE__</b> on line <b>__LINE__</b>',
+					'<b>Error</b>: Uncaught exception "Exception" thrown: User error triggered: ERROR: Can this mistake be rectified during action? in <b>__FILE__</b> on line <b>__LINE__</b>',
 				),
 			),
 			'exception'               => array(
@@ -1079,6 +1083,7 @@ public function data_provider_to_test_wp_finalize_template_enhancement_output_bu
 				),
 				'expected_displayed_errors' => array(
 					'<b>Error</b>: Uncaught exception "Exception" thrown: I take exception to this filter! in <b>__FILE__</b> on line <b>__LINE__</b>',
+					'<b>Error</b>: Uncaught exception "Exception" thrown: I take exception to this action! in <b>__FILE__</b> on line <b>__LINE__</b>',
 				),
 			),
 			'multiple_non_errors'     => array(
@@ -1106,6 +1111,9 @@ public function data_provider_to_test_wp_finalize_template_enhancement_output_bu
 					'<b>Deprecated</b>: You are history during filter. in <b>__FILE__</b> on line <b>__LINE__</b>',
 					'<b>Notice</b>: POSTED: No trespassing during filter. in <b>__FILE__</b> on line <b>__LINE__</b>',
 					'<b>Warning</b>: AVISO: Piso mojado durante filtro. in <b>__FILE__</b> on line <b>__LINE__</b>',
+					'<b>Deprecated</b>: You are history during action. in <b>__FILE__</b> on line <b>__LINE__</b>',
+					'<b>Notice</b>: POSTED: No trespassing during action. in <b>__FILE__</b> on line <b>__LINE__</b>',
+					'<b>Warning</b>: AVISO: Piso mojado durante acción. in <b>__FILE__</b> on line <b>__LINE__</b>',
 				),
 			),
 			'deprecated_without_html' => array(
@@ -1142,6 +1150,7 @@ public function data_provider_to_test_wp_finalize_template_enhancement_output_bu
 				),
 				'expected_displayed_errors' => array(
 					'<b>Warning</b>: AVISO: Piso mojado durante filtro. in <b>__FILE__ : eval()\'d code</b> on line <b>__LINE__</b>',
+					'<b>Warning</b>: AVISO: Piso mojado durante acción. in <b>__FILE__ : eval()\'d code</b> on line <b>__LINE__</b>',
 				),
 			),
 		);