Added a function to LoginForm to show the "return to" page.
authorAaron Schulz <aschulz@wikimedia.org>
Mon, 15 Apr 2013 20:22:16 +0000 (13:22 -0700)
committerAaron Schulz <aschulz@wikimedia.org>
Mon, 15 Apr 2013 23:33:50 +0000 (16:33 -0700)
* This can be used be extensions like CentralAuth.

Change-Id: Idd71cac47195402ebffeb7047e91efb200a32b58

includes/specials/SpecialUserlogin.php

index e0ddc96..3f18f95 100644 (file)
@@ -973,6 +973,29 @@ class LoginForm extends SpecialPage {
                );
        }
 
+       /**
+        * Add a "return to" link or redirect to it.
+        * Extensions can use this to reuse the "return to" logic after
+        * inject steps (such as redirection) into the login process.
+        *
+        * @param $type string, one of the following:
+        *    - error: display a return to link ignoring $wgRedirectOnLogin
+        *    - success: display a return to link using $wgRedirectOnLogin if needed
+        *    - successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
+        * @param string $returnTo
+        * @param array|string $returnToQuery
+        * @param bool $stickHTTPs Keep redirect link on HTTPs
+        * @since 1.22
+        */
+       public function showReturnToPage(
+               $type, $returnTo = '', $returnToQuery = '', $stickHTTPs = false
+       ) {
+               $this->mReturnTo = $returnTo;
+               $this->mReturnToQuery = $returnToQuery;
+               $this->mStickHTTPS = $stickHTTPs;
+               $this->executeReturnTo( $type );
+       }
+
        /**
         * Add a "return to" link or redirect to it.
         *