Ticket #34352: 34352.diff

src/wp-includes/general-template.php

@@ -293 +293 @@
 }
 
 /**
- * Returns the Log Out URL.
+ * Returns the HTML encoded Log Out URL.
  *
  * Returns the URL that allows the user to log out of the site.
  *
@@ -300 +300 @@
  * @since 2.7.0
  *
  * @param string $redirect Path to redirect to on logout.
- * @return string A log out URL.
+ * @return string An HTML encoded log out URL.
  */
 function wp_logout_url($redirect = '') {
         $args = array( 'action' => 'logout' );
@@ -316 +316 @@
          *
          * @since 2.8.0
          *
-         * @param string $logout_url The Log Out URL.
+         * @param string $logout_url The HTML encoded Log Out URL.
          * @param string $redirect   Path to redirect to on logout.
          */
         return apply_filters( 'logout_url', $logout_url, $redirect );
@@ -323 +323 @@
 }
 
 /**
- * Returns the URL that allows the user to log in to the site.
+ * Returns the non-HTML encoded URL that allows the user to log in to the site.
  *
  * @since 2.7.0
  *
  * @param string $redirect     Path to redirect to on login.
  * @param bool   $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.
- * @return string A log in URL.
+ * @return string A log in URL, not HTML encoded.
  */
 function wp_login_url($redirect = '', $force_reauth = false) {
         $login_url = site_url('wp-login.php', 'login');
@@ -346 +346 @@
          * @since 2.8.0
          * @since 4.2.0 The `$force_reauth` parameter was added.
          *
-         * @param string $login_url    The login URL.
+         * @param string $login_url    The non-HTML encoded login URL.
          * @param string $redirect     The path to redirect to on login, if supplied.
          * @param bool   $force_reauth Whether to force reauthorization, even if a cookie is present.
          */