sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34712 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-30 02:41:49 +00:00
parent 283c38c022
commit 13aeda2ef7
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/wp-includes/rewrite-functions.php
View File

@ -16,7 +16,8 @@
*
* @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' ) {
global $wp_rewrite;
@ -38,7 +39,7 @@ function add_rewrite_rule( $regex, $redirect, $after = 'bottom' ) {
*
* @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 = '' ) {
// validate the tag's name
@ -61,12 +62,13 @@ function add_rewrite_tag( $tag, $regex, $query = '' ) {
*
* @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() ) {
global $wp_rewrite;