Changeset 34712

Timestamp:

09/30/2015 02:41:49 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Mark a few optional parameters as such in wp-includes/rewrite-functions.php.

See #32246.

File:

• trunk/src/wp-includes/rewrite-functions.php (modified) (3 diffs)

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

@@ -17 +17 @@
  * @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, default is 'bottom'. Where to add rule, can also be 'top'.
+ * @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' ) {
@@ -39 +40 @@
  * @param string $tag   Name of the new rewrite tag.
  * @param string $regex Regular expression to substitute the tag for in rewrite rules.
- * @param string $query String to append to the rewritten query. Must end in '='. Optional.
+ * @param string $query Optional. String to append to the rewritten query. Must end in '='. Default empty.
  */
 function add_rewrite_tag( $tag, $regex, $query = '' ) {
@@ -62 +63 @@
  * @since 3.0.0
  *
+ * @see WP_Rewrite::add_permastruct()
  * @global WP_Rewrite $wp_rewrite
  *
  * @param string $name   Name for permalink structure.
  * @param string $struct Permalink structure.
- * @param array  $args   Optional configuration for building the rules from the permalink structure,
- *                       see {@link WP_Rewrite::add_permastruct()} for full details.
+ * @param array  $args   Optional. Arguments for building the rules from the permalink structure,
+ *                       see WP_Rewrite::add_permastruct() for full details. Default empty array.
  */
 function add_permastruct( $name, $struct, $args = array() ) {