Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add missing doc blocks to `rewrite.php`. 

Clarify `@return` values where necessary.
`add_permastruct()` doesn't need to return.
`->using_index_permalinks()` and `->using_mod_rewrite_permalinks()` can just return their conditions, instead of if/else true/false.
`->mod_rewrite_rules()` and `->iis7_url_rewrite_rules()` don't need to set a variable that is immediately returned.
 
See #32444.

Built from https://develop.svn.wordpress.org/trunk@32622


git-svn-id: http://core.svn.wordpress.org/trunk@32592 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2015-05-27 19:23:26 +00:00
parent 5ee54c05ac
commit 274daa059a
2 changed files with 57 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
wp-includes/rewrite.php
View File

@ -9,12 +9,13 @@
/**
* Add a straight rewrite rule.
*
* @see WP_Rewrite::add_rule() for long description.
* @since 2.1.0
*
* @param string $regex Regular Expression to match request against.
* @global WP_Rewrite $wp_rewrite
*
* @param string $regex Regular Expression to match request against.
* @param string $redirect Page to redirect to.
* @param string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'.
* @param string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'.
*/
function add_rewrite_rule($regex, $redirect, $after = 'bottom') {
global $wp_rewrite;
@ -28,10 +29,12 @@ function add_rewrite_rule($regex, $redirect, $after = 'bottom') {
* you call this on, or before, the 'init' hook. This is because $query defaults
* to "$tag=", and for this to work a new query var has to be added.
*
* @see WP_Rewrite::add_rewrite_tag()
* @since 2.1.0
*
* @param string $tag Name of the new rewrite tag.
* @global WP_Rewrite $wp_rewrite
* @global WP $wp
*
* @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.
*/
@ -54,13 +57,14 @@ function add_rewrite_tag( $tag, $regex, $query = '' ) {
/**
* Add permalink structure.
*
* @see WP_Rewrite::add_permastruct()
* @since 3.0.0
*
* @param string $name Name for permalink structure.
* @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 configuration for building the rules from the permalink structure,
* see {@link WP_Rewrite::add_permastruct()} for full details.
*/
function add_permastruct( $name, $struct, $args = array() ) {
global $wp_rewrite;
@ -71,7 +75,7 @@ function add_permastruct( $name, $struct, $args = array() ) {
if ( func_num_args() == 4 )
$args['ep_mask'] = func_get_arg( 3 );
return $wp_rewrite->add_permastruct( $name, $struct, $args );
$wp_rewrite->add_permastruct( $name, $struct, $args );
}
/**
@ -79,7 +83,9 @@ function add_permastruct( $name, $struct, $args = array() ) {
*
* @since 2.1.0
*
* @param string $feedname
* @global WP_Rewrite $wp_rewrite
*
* @param string $feedname
* @param callback $function Callback to run on feed display.
* @return string Feed action name.
*/
@ -97,11 +103,12 @@ function add_feed($feedname, $function) {
/**
* Remove rewrite rules and then recreate rewrite rules.
*
* @see WP_Rewrite::flush_rules()
* @since 3.0.0
*
* @global WP_Rewrite $wp_rewrite
*
* @param bool $hard Whether to update .htaccess (hard flush) or just update
* rewrite_rules transient (soft flush). Default is true (hard).
* rewrite_rules transient (soft flush). Default is true (hard).
*/
function flush_rewrite_rules( $hard = true ) {
global $wp_rewrite;
@ -245,8 +252,7 @@ define( 'EP_ALL', EP_PERMALINK | EP_ATTACHMENT | EP_ROOT | EP_COMMENTS | EP_SEAR
* @since 2.1.0
* @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
*
* @see WP_Rewrite::add_endpoint()
* @global object $wp_rewrite
* @global WP_Rewrite $wp_rewrite
*
* @param string $name Name of the endpoint.
* @param int $places Endpoint mask describing the places the endpoint should be added.
@ -284,10 +290,13 @@ function _wp_filter_taxonomy_base( $base ) {
*
* @since 1.0.0
*
* @global WP_Rewrite $wp_rewrite
* @global WP $wp
*
* @param string $url Permalink to check.
* @return int Post ID, or 0 on failure.
*/
function url_to_postid($url) {
function url_to_postid( $url ) {
global $wp_rewrite;
/**
@ -782,14 +791,11 @@ class WP_Rewrite {
* @return bool
*/
public function using_index_permalinks() {
if ( empty($this->permalink_structure) )
if ( empty( $this->permalink_structure ) ) {
return false;
}
// If the index is not in the permalink, we're using mod_rewrite.
if ( preg_match('#^/*' . $this->index . '#', $this->permalink_structure) )
return true;
return false;
return preg_match( '#^/*' . $this->index . '#', $this->permalink_structure );
}
/**
@ -803,10 +809,7 @@ class WP_Rewrite {
* @return bool
*/
public function using_mod_rewrite_permalinks() {
if ( $this->using_permalinks() && ! $this->using_index_permalinks() )
return true;
else
return false;
return $this->using_permalinks() && ! $this->using_index_permalinks();
}
/**
@ -846,6 +849,8 @@ class WP_Rewrite {
* @since 2.5.0
* @access public
*
* @global wpdb $wpdb
*
* @return array Array of page URIs as first element and attachment URIs as second element.
*/
public function page_uri_index() {
@ -979,7 +984,6 @@ class WP_Rewrite {
$structure = str_replace('%monthnum%', '', $structure);
$structure = str_replace('%day%', '', $structure);
$structure = preg_replace('#/+#', '/', $structure);
return $structure;
@ -1003,7 +1007,6 @@ class WP_Rewrite {
return false;
$structure = str_replace('%day%', '', $structure);
$structure = preg_replace('#/+#', '/', $structure);
return $structure;
@ -1034,7 +1037,7 @@ class WP_Rewrite {
* @since 1.5.0
* @access public
*
* @return bool|string False on failure. Category permalink structure.
* @return string|false False on failure. Category permalink structure.
*/
public function get_category_permastruct() {
return $this->get_extra_permastruct('category');
@ -1051,7 +1054,7 @@ class WP_Rewrite {
* @since 2.3.0
* @access public
*
* @return bool|string False on failure. Tag permalink structure.
* @return string|false False on failure. Tag permalink structure.
*/
public function get_tag_permastruct() {
return $this->get_extra_permastruct('post_tag');
@ -1064,7 +1067,7 @@ class WP_Rewrite {
* @access public
*
* @param string $name Permalink structure name.
* @return string|bool False if not found. Permalink structure string.
* @return string|false False if not found. Permalink structure string.
*/
public function get_extra_permastruct($name) {
if ( empty($this->permalink_structure) )
@ -1190,7 +1193,7 @@ class WP_Rewrite {
* @since 1.5.0
* @access public
*
* @return string|bool False if not found. Permalink structure string.
* @return string|false False if not found. Permalink structure string.
*/
public function get_comment_feed_permastruct() {
if ( isset($this->comment_feed_structure) )
@ -1218,7 +1221,7 @@ class WP_Rewrite {
* @since 1.5.0
* @access public
*
* @param string $tag Name of the rewrite tag to add or update.
* @param string $tag Name of the rewrite tag to add or update.
* @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 '='.
*/
@ -1245,13 +1248,13 @@ class WP_Rewrite {
* @access public
*
* @param string $permalink_structure The permalink structure.
* @param int $ep_mask Endpoint mask defining what endpoints are added to the structure. Default is EP_NONE.
* @param bool $paged Should archive pagination rules be added for the structure? Default is true.
* @param bool $feed Should feed rewrite rules be added for the structure? Default is true.
* @param bool $forcomments Should the feed rules be a query for a comments feed? Default is false.
* @param bool $walk_dirs Should the 'directories' making up the structure be walked over and rewrite rules
* built for each in turn? Default is true.
* @param bool $endpoints Should endpoints be applied to the generated rewrite rules? Default is true.
* @param int $ep_mask Endpoint mask defining what endpoints are added to the structure. Default is EP_NONE.
* @param bool $paged Should archive pagination rules be added for the structure? Default is true.
* @param bool $feed Should feed rewrite rules be added for the structure? Default is true.
* @param bool $forcomments Should the feed rules be a query for a comments feed? Default is false.
* @param bool $walk_dirs Should the 'directories' making up the structure be walked over and rewrite rules
* built for each in turn? Default is true.
* @param bool $endpoints Should endpoints be applied to the generated rewrite rules? Default is true.
* @return array Rewrite rule list.
*/
public function generate_rewrite_rules($permalink_structure, $ep_mask = EP_NONE, $paged = true, $feed = true, $forcomments = false, $walk_dirs = true, $endpoints = true) {
@ -1522,7 +1525,7 @@ class WP_Rewrite {
* @access public
*
* @param string $permalink_structure The permalink structure to generate rules.
* @param bool $walk_dirs Optional, default is false. Whether to create list of directories to walk over.
* @param bool $walk_dirs Optional, default is false. Whether to create list of directories to walk over.
* @return array
*/
public function generate_rewrite_rule($permalink_structure, $walk_dirs = false) {
@ -1856,9 +1859,7 @@ class WP_Rewrite {
*
* @param string $rules mod_rewrite Rewrite rules formatted for .htaccess.
*/
$rules = apply_filters( 'rewrite_rules', $rules ); // Deprecated
return $rules;
return apply_filters( 'rewrite_rules', $rules );
}
/**
@ -1873,7 +1874,6 @@ class WP_Rewrite {
* @return string
*/
public function iis7_url_rewrite_rules( $add_parent_tags = false ) {
if ( ! $this->using_permalinks() )
return '';
$rules = '';
@ -1909,9 +1909,7 @@ class WP_Rewrite {
*
* @param string $rules Rewrite rules formatted for IIS web.config.
*/
$rules = apply_filters( 'iis7_url_rewrite_rules', $rules );
return $rules;
return apply_filters( 'iis7_url_rewrite_rules', $rules );
}
/**
@ -1923,9 +1921,9 @@ class WP_Rewrite {
* @since 2.1.0
* @access public
*
* @param string $regex Regular expression to match against request.
* @param string $regex Regular expression to match against request.
* @param string $redirect URL regex redirects to when regex matches request.
* @param string $after Optional, default is bottom. Location to place rule.
* @param string $after Optional, default is bottom. Location to place rule.
*/
public function add_rule($regex, $redirect, $after = 'bottom') {
//get everything up to the first ?
@ -1950,7 +1948,7 @@ class WP_Rewrite {
* @since 2.1.0
* @access public
*
* @param string $regex Regular expression to match against request.
* @param string $regex Regular expression to match against request.
* @param string $redirect URL regex redirects to when regex matches request.
*/
public function add_external_rule($regex, $redirect) {
@ -1966,7 +1964,8 @@ class WP_Rewrite {
* @access public
*
* @see add_rewrite_endpoint() for full documentation.
* @uses WP::add_query_var()
*
* @global WP $wp
*
* @param string $name Name of the endpoint.
* @param int $places Endpoint mask describing the places the endpoint should be added.
@ -2003,9 +2002,9 @@ class WP_Rewrite {
* @since 2.5.0
* @access public
*
* @param string $name Name for permalink structure.
* @param string $name Name for permalink structure.
* @param string $struct Permalink structure (e.g. category/%category%)
* @param array $args Optional configuration for building the rules from the permalink structure:
* @param array $args Optional configuration for building the rules from the permalink structure:
* - with_front (bool) - Should the structure be prepended with WP_Rewrite::$front? Default is true.
* - ep_mask (int) - Endpoint mask defining what endpoints are added to the structure. Default is EP_NONE.
* - paged (bool) - Should archive pagination rules be added for the structure? Default is true.
@ -2052,6 +2051,9 @@ class WP_Rewrite {
*
* @since 2.0.1
* @access public
*
* @staticvar bool $do_hard_later
*
* @param bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard).
*/
public function flush_rules( $hard = true ) {

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.3-alpha-32621';
$wp_version = '4.3-alpha-32622';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.