From 4a04259070e5a2c8bca4f3e6054941b41d2c2e8c Mon Sep 17 00:00:00 2001 From: "C. Scott Ananian" Date: Tue, 23 Nov 2021 15:50:01 -0500 Subject: [PATCH] Rename variables to disambiguate OutputPageParserOutput hook It can be difficult to distinguish between ParserOutput and OutputPage values, since both are often named $out or $output. Use more distinctive variable names to make it easier to read the code (and use code search) for uses of the OutputPageParserOutput hook, where both types are present in close proximity. See T293860 for an instance of this confusion biting us in production, and I386e99df01f889a80de26e861142bdb606aa649d for a related tidying-up in Wikibase. Change-Id: I0ccb7484eb3b2e2ae6a5a85c3e08d7d48b1e6146 --- includes/Hook/OutputPageParserOutputHook.php | 6 +++--- includes/HookContainer/HookRunner.php | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/includes/Hook/OutputPageParserOutputHook.php b/includes/Hook/OutputPageParserOutputHook.php index 618b8fd4d56..3d534dd9bda 100644 --- a/includes/Hook/OutputPageParserOutputHook.php +++ b/includes/Hook/OutputPageParserOutputHook.php @@ -18,9 +18,9 @@ interface OutputPageParserOutputHook { * * @since 1.35 * - * @param OutputPage $out - * @param ParserOutput $parserOutput ParserOutput instance being added in $out + * @param OutputPage $outputPage + * @param ParserOutput $parserOutput ParserOutput instance being added in $outputPage * @return void This hook must not abort, it must return no value */ - public function onOutputPageParserOutput( $out, $parserOutput ): void; + public function onOutputPageParserOutput( $outputPage, $parserOutput ): void; } diff --git a/includes/HookContainer/HookRunner.php b/includes/HookContainer/HookRunner.php index 53db73fae3f..fc4646e790b 100644 --- a/includes/HookContainer/HookRunner.php +++ b/includes/HookContainer/HookRunner.php @@ -2669,10 +2669,10 @@ class HookRunner implements ); } - public function onOutputPageParserOutput( $out, $parserOutput ): void { + public function onOutputPageParserOutput( $outputPage, $parserOutput ): void { $this->container->run( 'OutputPageParserOutput', - [ $out, $parserOutput ], + [ $outputPage, $parserOutput ], [ 'abortable' => false ] ); }