/**
* Constructs rewrite matches and queries from permalink structure.
*
- * Runs the action 'generate_rewrite_rules' with the parameter that is an
+ * Runs the action {@see 'generate_rewrite_rules'} with the parameter that is an
* reference to the current WP_Rewrite instance to further manipulate the
- * permalink structures and rewrite rules. Runs the 'rewrite_rules_array'
+ * permalink structures and rewrite rules. Runs the {@see 'rewrite_rules_array'}
* filter on the full rewrite rule array.
*
* There are two ways to manipulate the rewrite rules, one by hooking into
- * the 'generate_rewrite_rules' action and gaining full control of the
+ * the {@see 'generate_rewrite_rules'} action and gaining full control of the
* object or just manipulating the rewrite rule array before it is passed
* from the function.
*
$post_rewrite = $this->generate_rewrite_rules( $this->permalink_structure, EP_PERMALINK );
/**
- * Filter rewrite rules used for "post" archives.
+ * Filters rewrite rules used for "post" archives.
*
* @since 1.5.0
*
$date_rewrite = $this->generate_rewrite_rules($this->get_date_permastruct(), EP_DATE);
/**
- * Filter rewrite rules used for date archives.
+ * Filters rewrite rules used for date archives.
*
* Likely date archives would include /yyyy/, /yyyy/mm/, and /yyyy/mm/dd/.
*
$root_rewrite = $this->generate_rewrite_rules($this->root . '/', EP_ROOT);
/**
- * Filter rewrite rules used for root-level archives.
+ * Filters rewrite rules used for root-level archives.
*
* Likely root-level archives would include pagination rules for the homepage
* as well as site-wide post feeds (e.g. /feed/, and /feed/atom/).
$comments_rewrite = $this->generate_rewrite_rules($this->root . $this->comments_base, EP_COMMENTS, false, true, true, false);
/**
- * Filter rewrite rules used for comment feed archives.
+ * Filters rewrite rules used for comment feed archives.
*
* Likely comments feed archives include /comments/feed/, and /comments/feed/atom/.
*
$search_rewrite = $this->generate_rewrite_rules($search_structure, EP_SEARCH);
/**
- * Filter rewrite rules used for search archives.
+ * Filters rewrite rules used for search archives.
*
* Likely search-related archives include /search/search+query/ as well as
* pagination and feed paths for a search.
$author_rewrite = $this->generate_rewrite_rules($this->get_author_permastruct(), EP_AUTHORS);
/**
- * Filter rewrite rules used for author archives.
+ * Filters rewrite rules used for author archives.
*
* Likely author archives would include /author/author-name/, as well as
* pagination and feed paths for author archives.
$page_rewrite = $this->page_rewrite_rules();
/**
- * Filter rewrite rules used for "page" post type archives.
+ * Filters rewrite rules used for "page" post type archives.
*
* @since 1.5.0
*
}
/**
- * Filter rewrite rules used for individual permastructs.
+ * Filters rewrite rules used for individual permastructs.
*
* The dynamic portion of the hook name, `$permastructname`, refers
* to the name of the registered permastruct, e.g. 'post_tag' (tags),
if ( 'post_tag' == $permastructname ) {
/**
- * Filter rewrite rules used specifically for Tags.
+ * Filters rewrite rules used specifically for Tags.
*
* @since 2.3.0
* @deprecated 3.1.0 Use 'post_tag_rewrite_rules' instead
do_action_ref_array( 'generate_rewrite_rules', array( &$this ) );
/**
- * Filter the full set of generated rewrite rules.
+ * Filters the full set of generated rewrite rules.
*
* @since 1.5.0
*
$rules .= "</IfModule>\n";
/**
- * Filter the list of rewrite rules formatted for output to an .htaccess file.
+ * Filters the list of rewrite rules formatted for output to an .htaccess file.
*
* @since 1.5.0
*
$rules = apply_filters( 'mod_rewrite_rules', $rules );
/**
- * Filter the list of rewrite rules formatted for output to an .htaccess file.
+ * Filters the list of rewrite rules formatted for output to an .htaccess file.
*
* @since 1.5.0
* @deprecated 1.5.0 Use the mod_rewrite_rules filter instead.
}
/**
- * Filter the list of rewrite rules formatted for output to a web.config.
+ * Filters the list of rewrite rules formatted for output to a web.config.
*
* @since 2.8.0
*
* }
*/
public function add_permastruct( $name, $struct, $args = array() ) {
- // Backwards compatibility for the old parameters: $with_front and $ep_mask.
+ // Back-compat for the old parameters: $with_front and $ep_mask.
if ( ! is_array( $args ) )
$args = array( 'with_front' => $args );
if ( func_num_args() == 4 )
$this->wp_rewrite_rules();
/**
- * Filter whether a "hard" rewrite rule flush should be performed when requested.
+ * Filters whether a "hard" rewrite rule flush should be performed when requested.
*
* A "hard" flush updates .htaccess (Apache) or web.config (IIS).
*
* between the current permalink structure and the parameter value. Calls
* WP_Rewrite::init() after the option is updated.
*
- * Fires the 'permalink_structure_changed' action once the init call has
+ * Fires the {@see 'permalink_structure_changed'} action once the init call has
* processed passing the old and new values
*
* @since 1.5.0