Changeset 58224 for trunk/src/wp-login.php

Timestamp:

05/28/2024 11:11:19 AM (5 months ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify that the $wp_error parameter of login_header() is nullable.

Follow-up to [7991], [25701], [28792], [43457], [58209], [58220].

See #60668, #60699.

File:

• trunk/src/wp-login.php (modified) (1 diff)

trunk/src/wp-login.php

@@ -34 +34 @@
  * @global string      $action        The action that brought the visitor to the login page.
  *
- * @param null|string $title    Optional. WordPress login Page title to display in the `<title>` element.
- *                              Default null, which displays 'Log In'.
- * @param string      $message  Optional. Message to display in header. Default empty.
- * @param WP_Error    $wp_error Optional. The error to pass. Default is a WP_Error instance.
+ * @param string|null   $title    Optional. WordPress login page title to display in the `<title>` element.
+ *                                Defaults to 'Log In'.
+ * @param string        $message  Optional. Message to display in header. Default empty.
+ * @param WP_Error|null $wp_error Optional. The error to pass. Defaults to a WP_Error instance.
  */
 function login_header( $title = null, $message = '', $wp_error = null ) {