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

Docs: Remove invalid inline `@link` tags from a variety of DocBlocks in `WP_Rewrite`. 

See #34218.

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


git-svn-id: http://core.svn.wordpress.org/trunk@34904 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-10-08 16:47:25 +00:00
parent d1fd329ea2
commit 02645d5711
2 changed files with 38 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
wp-includes/class-wp-rewrite.php
View File

@ -163,8 +163,8 @@ class WP_Rewrite {
* The prefix for all permalink structures. * The prefix for all permalink structures.
* *
* If PATHINFO/index permalinks are in use then the root is the value of * If PATHINFO/index permalinks are in use then the root is the value of
* {@link WP_Rewrite::$index} with a trailing slash appended. Otherwise * `WP_Rewrite::$index` with a trailing slash appended. Otherwise the root
* the root will be empty. * will be empty.
* *
* @see WP_Rewrite::init() * @see WP_Rewrite::init()
* @see WP_Rewrite::using_index_permalinks() * @see WP_Rewrite::using_index_permalinks()
@ -226,7 +226,7 @@ class WP_Rewrite {
* Rules that don't redirect to WordPress' index.php. * Rules that don't redirect to WordPress' index.php.
* *
* These rules are written to the mod_rewrite portion of the .htaccess, * These rules are written to the mod_rewrite portion of the .htaccess,
* and are added by {@link add_external_rule()}. * and are added by add_external_rule().
* *
* @since 2.1.0 * @since 2.1.0
* @access private * @access private
@ -235,7 +235,7 @@ class WP_Rewrite {
var $non_wp_rules = array(); var $non_wp_rules = array();
/** /**
* Extra permalink structures, e.g. categories, added by {@link add_permastruct()}. * Extra permalink structures, e.g. categories, added by add_permastruct().
* *
* @since 2.1.0 * @since 2.1.0
* @access private * @access private
@ -244,7 +244,7 @@ class WP_Rewrite {
var $extra_permastructs = array(); var $extra_permastructs = array();
/** /**
* Endpoints (like /trackback/) added by {@link add_rewrite_endpoint()}. * Endpoints (like /trackback/) added by add_rewrite_endpoint().
* *
* @since 2.1.0 * @since 2.1.0
* @access private * @access private
@ -272,14 +272,14 @@ class WP_Rewrite {
* also match a page name (e.g. %postname% or %author%) then this flag is * also match a page name (e.g. %postname% or %author%) then this flag is
* set to true. Prior to WordPress 3.3 this flag indicated that every page * set to true. Prior to WordPress 3.3 this flag indicated that every page
* would have a set of rules added to the top of the rewrite rules array. * would have a set of rules added to the top of the rewrite rules array.
* Now it tells {@link WP::parse_request()} to check if a URL matching the * Now it tells WP::parse_request() to check if a URL matching the page
* page permastruct is actually a page before accepting it. * permastruct is actually a page before accepting it.
* *
* @link https://core.trac.wordpress.org/ticket/16687
* @see WP_Rewrite::init()
* @since 2.5.0 * @since 2.5.0
* @access public * @access public
* @var bool * @var bool
*
* @see WP_Rewrite::init()
*/ */
public $use_verbose_page_rules = true; public $use_verbose_page_rules = true;
@ -287,10 +287,10 @@ class WP_Rewrite {
* Rewrite tags that can be used in permalink structures. * Rewrite tags that can be used in permalink structures.
* *
* These are translated into the regular expressions stored in * These are translated into the regular expressions stored in
* {@link WP_Rewrite::$rewritereplace} and are rewritten to the * `WP_Rewrite::$rewritereplace` and are rewritten to the query
* query variables listed in {@link WP_Rewrite::$queryreplace}. * variables listed in WP_Rewrite::$queryreplace.
* *
* Additional tags can be added with {@link add_rewrite_tag()}. * Additional tags can be added with add_rewrite_tag().
* *
* @since 1.5.0 * @since 1.5.0
* @access private * @access private
@ -312,7 +312,7 @@ class WP_Rewrite {
/** /**
* Regular expressions to be substituted into rewrite rules in place * Regular expressions to be substituted into rewrite rules in place
* of rewrite tags, see {@link WP_Rewrite::$rewritecode}. * of rewrite tags, see WP_Rewrite::$rewritecode.
* *
* @since 1.5.0 * @since 1.5.0
* @access private * @access private
@ -333,7 +333,7 @@ class WP_Rewrite {
); );
/** /**
* Query variables that rewrite tags map to, see {@link WP_Rewrite::$rewritecode}. * Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode.
* *
* @since 1.5.0 * @since 1.5.0
* @access private * @access private
@ -1138,14 +1138,15 @@ class WP_Rewrite {
/** /**
* Generate Rewrite rules with permalink structure and walking directory only. * Generate Rewrite rules with permalink structure and walking directory only.
* *
* Shorten version of {@link WP_Rewrite::generate_rewrite_rules()} that * Shorten version of WP_Rewrite::generate_rewrite_rules() that allows for shorter
* allows for shorter list of parameters. See the method for longer * list of parameters. See the method for longer description of what generating
* description of what generating rewrite rules does. * rewrite rules does.
* *
* @uses WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
* @since 1.5.0 * @since 1.5.0
* @access public * @access public
* *
* @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
*
* @param string $permalink_structure The permalink structure to generate rules. * @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 * @return array
@ -1363,11 +1364,10 @@ class WP_Rewrite {
/** /**
* Retrieve the rewrite rules. * Retrieve the rewrite rules.
* *
* The difference between this method and {@link * The difference between this method and WP_Rewrite::rewrite_rules() is that
* WP_Rewrite::rewrite_rules()} is that this method stores the rewrite rules * this method stores the rewrite rules in the 'rewrite_rules' option and retrieves
* in the 'rewrite_rules' option and retrieves it. This prevents having to * it. This prevents having to process all of the permalinks to get the rewrite rules
* process all of the permalinks to get the rewrite rules in the form of * in the form of caching.
* caching.
* *
* @since 1.5.0 * @since 1.5.0
* @access public * @access public
@ -1622,14 +1622,14 @@ class WP_Rewrite {
/** /**
* Add a new permalink structure. * Add a new permalink structure.
* *
* A permalink structure (permastruct) is an abstract definition of a set of rewrite rules; it * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules;
* is an easy way of expressing a set of regular expressions that rewrite to a set of query strings. * it is an easy way of expressing a set of regular expressions that rewrite to a set of
* The new permastruct is added to the {@link WP_Rewrite::$extra_permastructs} array. When the * query strings. The new permastruct is added to the WP_Rewrite::$extra_permastructs array.
* rewrite rules are built by {@link WP_Rewrite::rewrite_rules()} all of these extra permastructs * When the rewrite rules are built by WP_Rewrite::rewrite_rules(), all of these extra
* are passed to {@link WP_Rewrite::generate_rewrite_rules()} which transforms them into the * permastructs are passed to WP_Rewrite::generate_rewrite_rules() which transforms them
* regular expressions that many love to hate. * into the regular expressions that many love to hate.
* *
* The $args parameter gives you control over how {@link WP_Rewrite::generate_rewrite_rules()} * The `$args` parameter gives you control over how WP_Rewrite::generate_rewrite_rules()
* works on the new permastruct. * works on the new permastruct.
* *
* @since 2.5.0 * @since 2.5.0
@ -1678,9 +1678,8 @@ class WP_Rewrite {
/** /**
* Remove rewrite rules and then recreate rewrite rules. * Remove rewrite rules and then recreate rewrite rules.
* *
* Calls {@link WP_Rewrite::wp_rewrite_rules()} after removing the * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option.
* 'rewrite_rules' option. If the function named 'save_mod_rewrite_rules' * If the function named 'save_mod_rewrite_rules' exists, it will be called.
* exists, it will be called.
* *
* @since 2.0.1 * @since 2.0.1
* @access public * @access public
@ -1761,7 +1760,7 @@ class WP_Rewrite {
* *
* Will update the 'permalink_structure' option, if there is a difference * Will update the 'permalink_structure' option, if there is a difference
* between the current permalink structure and the parameter value. Calls * between the current permalink structure and the parameter value. Calls
* {@link WP_Rewrite::init()} after the option is updated. * WP_Rewrite::init() after the option is updated.
* *
* Fires the 'permalink_structure_changed' action once the init call has * Fires the 'permalink_structure_changed' action once the init call has
* processed passing the old and new values * processed passing the old and new values
@ -1793,8 +1792,8 @@ class WP_Rewrite {
* Set the category base for the category permalink. * Set the category base for the category permalink.
* *
* Will update the 'category_base' option, if there is a difference between * Will update the 'category_base' option, if there is a difference between
* the current category base and the parameter value. Calls * the current category base and the parameter value. Calls WP_Rewrite::init()
* {@link WP_Rewrite::init()} after the option is updated. * after the option is updated.
* *
* @since 1.5.0 * @since 1.5.0
* @access public * @access public
@ -1812,8 +1811,8 @@ class WP_Rewrite {
* Set the tag base for the tag permalink. * Set the tag base for the tag permalink.
* *
* Will update the 'tag_base' option, if there is a difference between the * Will update the 'tag_base' option, if there is a difference between the
* current tag base and the parameter value. Calls * current tag base and the parameter value. Calls WP_Rewrite::init() after
* {@link WP_Rewrite::init()} after the option is updated. * the option is updated.
* *
* @since 2.3.0 * @since 2.3.0
* @access public * @access public

2
wp-includes/version.php
View File

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