Changeset 37753

Timestamp:

06/20/2016 08:47:20 AM (8 years ago)

Author:

DrewAPicture

Message:

Docs: Clarify documentation for wp_logout_url() and wp_login_url() and corresponding hooks to highlight whether HTML-encoded or un-encoded values should be expected.

The return from wp_logout_url() is HTML-encoded due to its value passing through wp_nonce_url() and thus esc_html(). Adversely wp_login_url() passes through no such escaping and therefore should not be expected to return an HTML-encoded value.

Props akibjorklund for the initial patch.
Fixes #34352.

File:

• trunk/src/wp-includes/general-template.php (modified) (5 diffs)

trunk/src/wp-includes/general-template.php

@@ -290 +290 @@
 
 /**
- * Returns the Log Out URL.
+ * Retrieves the logout URL.
  *
  * Returns the URL that allows the user to log out of the site.
@@ -297 +297 @@
  *
  * @param string $redirect Path to redirect to on logout.
- * @return string A log out URL.
+ * @return string The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url().
  */
 function wp_logout_url($redirect = '') {
@@ -313 +313 @@
      * @since 2.8.0
      *
-     * @param string $logout_url The Log Out URL.
+     * @param string $logout_url The HTML-encoded logout URL.
      * @param string $redirect   Path to redirect to on logout.
      */
@@ -320 +320 @@
 
 /**
- * Returns the URL that allows the user to log in to the site.
+ * Retrieves the login URL.
  *
  * @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.
+ * @param string $redirect     Path to redirect to on log in.
+ * @param bool   $force_reauth Whether to force reauthorization, even if a cookie is present.
+ *                             Default false.
+ * @return string The login URL. Not HTML-encoded.
  */
 function wp_login_url($redirect = '', $force_reauth = false) {
@@ -343 +344 @@
      * @since 4.2.0 The `$force_reauth` parameter was added.
      *
-     * @param string $login_url    The login URL.
+     * @param string $login_url    The login URL. Not HTML-encoded.
      * @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.