WordPress.org

Make WordPress Core

Changeset 34712


Ignore:
Timestamp:
09/30/2015 02:41:49 AM (4 years ago)
Author:
DrewAPicture
Message:

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

See #32246.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/rewrite-functions.php

    r34708 r34712  
    1717 * @param string       $regex    Regular Expression to match request against.
    1818 * @param string|array $redirect Page to redirect to, or array of query vars and values.
    19  * @param string       $after    Optional, default is 'bottom'. Where to add rule, can also be 'top'.
     19 * @param string       $after    Optional. Location where to insert the new rule. Accepts 'top',
     20 *                               or 'bottom'. Default 'bottom'.
    2021 */
    2122function add_rewrite_rule( $regex, $redirect, $after = 'bottom' ) {
     
    3940 * @param string $tag   Name of the new rewrite tag.
    4041 * @param string $regex Regular expression to substitute the tag for in rewrite rules.
    41  * @param string $query String to append to the rewritten query. Must end in '='. Optional.
     42 * @param string $query Optional. String to append to the rewritten query. Must end in '='. Default empty.
    4243 */
    4344function add_rewrite_tag( $tag, $regex, $query = '' ) {
     
    6263 * @since 3.0.0
    6364 *
     65 * @see WP_Rewrite::add_permastruct()
    6466 * @global WP_Rewrite $wp_rewrite
    6567 *
    6668 * @param string $name   Name for permalink structure.
    6769 * @param string $struct Permalink structure.
    68  * @param array  $args   Optional configuration for building the rules from the permalink structure,
    69  *                       see {@link WP_Rewrite::add_permastruct()} for full details.
     70 * @param array  $args   Optional. Arguments for building the rules from the permalink structure,
     71 *                       see WP_Rewrite::add_permastruct() for full details. Default empty array.
    7072 */
    7173function add_permastruct( $name, $struct, $args = array() ) {
Note: See TracChangeset for help on using the changeset viewer.