Changeset 34946 for trunk/src/wp-includes/rewrite-functions.php

Timestamp:

10/08/2015 05:27:05 PM (5 years ago)

Author:

johnbillion

Message:

Improve the parameter names and inline documentation for add_rewrite_rule(), WP_Rewrite::add_rule(), and WP_Rewrite::add_external_rule().

Fixes #34197

File:

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

trunk/src/wp-includes/rewrite-functions.php

@@ -8 +8 @@
 
 /**
- * Adds a straight rewrite rule.
+ * Adds a rewrite rule that transforms a URL structure to a set of query vars.
+ *
+ * Any value in the $after parameter that isn't 'bottom' will result in the rule
+ * being placed at the top of the rewrite rules.
  *
  * @since 2.1.0
- * @since 4.4.0 Array support was added to the `$redirect` parameter.
+ * @since 4.4.0 Array support was added to the `$query` parameter.
  *
  * @global WP_Rewrite $wp_rewrite WordPress Rewrite Component.
  *
- * @param string       $regex    Regular Expression to match request against.
- * @param string|array $redirect Page to redirect to, or array of query vars and values.
- * @param string       $after    Optional. Location where to insert the new rule. Accepts 'top',
- *                               or 'bottom'. Default 'bottom'.
- */
-function add_rewrite_rule( $regex, $redirect, $after = 'bottom' ) {
-    global $wp_rewrite;
-
-    $wp_rewrite->add_rule( $regex, $redirect, $after );
+ * @param string       $regex Regular expression to match request against.
+ * @param string|array $query The corresponding query vars for this rewrite rule.
+ * @param string       $after Optional. Priority of the new rule. Accepts 'top'
+ *                            or 'bottom'. Default 'bottom'.
+ */
+function add_rewrite_rule( $regex, $query, $after = 'bottom' ) {
+    global $wp_rewrite;
+
+    $wp_rewrite->add_rule( $regex, $query, $after );
 }