Changeset 37863

Timestamp:

06/26/2016 07:45:31 AM (8 years ago)

Author:

DrewAPicture

Message:

Docs: Add two simple usage examples to the DocBlock for wp_redirect().

See #32246.

File:

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

trunk/src/wp-includes/pluggable.php

@@ -1127 +1127 @@
 /**
  * Redirects to another page.
+ *
+ * Note: wp_redirect() does not exit automatically, and should almost always be
+ * followed by a call to `exit;`:
+ *
+ *     wp_redirect( $url );
+ *     exit;
+ *
+ * Exiting can also be selectively manipulated by using wp_redirect() as a conditional
+ * in conjunction with the {@see 'wp_redirect'} and {@see 'wp_redirect_location'} hooks:
+ *
+ *     if ( wp_redirect( $url ) {
+ *         exit;
+ *     }
  *
  * @since 1.5.1