WordPress.org

Make WordPress Core

Changeset 34939


Ignore:
Timestamp:
10/08/2015 04:46:16 PM (5 years ago)
Author:
DrewAPicture
Message:

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

See #34218.

File:
1 edited

Legend:

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

    r34938 r34939  
    164164     *
    165165     * If PATHINFO/index permalinks are in use then the root is the value of
    166      * {@link WP_Rewrite::$index} with a trailing slash appended. Otherwise
    167      * the root will be empty.
     166     * `WP_Rewrite::$index` with a trailing slash appended. Otherwise the root
     167     * will be empty.
    168168     *
    169169     * @see WP_Rewrite::init()
     
    227227     *
    228228     * These rules are written to the mod_rewrite portion of the .htaccess,
    229      * and are added by {@link add_external_rule()}.
     229     * and are added by add_external_rule().
    230230     *
    231231     * @since 2.1.0
     
    236236
    237237    /**
    238      * Extra permalink structures, e.g. categories, added by {@link add_permastruct()}.
     238     * Extra permalink structures, e.g. categories, added by add_permastruct().
    239239     *
    240240     * @since 2.1.0
     
    245245
    246246    /**
    247      * Endpoints (like /trackback/) added by {@link add_rewrite_endpoint()}.
     247     * Endpoints (like /trackback/) added by add_rewrite_endpoint().
    248248     *
    249249     * @since 2.1.0
     
    273273     * set to true. Prior to WordPress 3.3 this flag indicated that every page
    274274     * would have a set of rules added to the top of the rewrite rules array.
    275      * Now it tells {@link WP::parse_request()} to check if a URL matching the
    276      * page permastruct is actually a page before accepting it.
    277      *
    278      * @link https://core.trac.wordpress.org/ticket/16687
     275     * Now it tells WP::parse_request() to check if a URL matching the page
     276     * permastruct is actually a page before accepting it.
     277     *
     278     * @since 2.5.0
     279     * @access public
     280     * @var bool
     281     *
    279282     * @see WP_Rewrite::init()
    280      * @since 2.5.0
    281      * @access public
    282      * @var bool
    283283     */
    284284    public $use_verbose_page_rules = true;
     
    288288     *
    289289     * These are translated into the regular expressions stored in
    290      * {@link WP_Rewrite::$rewritereplace} and are rewritten to the
    291      * query variables listed in {@link WP_Rewrite::$queryreplace}.
    292      *
    293      * Additional tags can be added with {@link add_rewrite_tag()}.
     290     * `WP_Rewrite::$rewritereplace` and are rewritten to the query
     291     * variables listed in WP_Rewrite::$queryreplace.
     292     *
     293     * Additional tags can be added with add_rewrite_tag().
    294294     *
    295295     * @since 1.5.0
     
    313313    /**
    314314     * Regular expressions to be substituted into rewrite rules in place
    315      * of rewrite tags, see {@link WP_Rewrite::$rewritecode}.
     315     * of rewrite tags, see WP_Rewrite::$rewritecode.
    316316     *
    317317     * @since 1.5.0
     
    334334
    335335    /**
    336      * Query variables that rewrite tags map to, see {@link WP_Rewrite::$rewritecode}.
     336     * Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode.
    337337     *
    338338     * @since 1.5.0
     
    11391139     * Generate Rewrite rules with permalink structure and walking directory only.
    11401140     *
    1141      * Shorten version of {@link WP_Rewrite::generate_rewrite_rules()} that
    1142      * allows for shorter list of parameters. See the method for longer
    1143      * description of what generating rewrite rules does.
    1144      *
    1145      * @uses WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
    1146      * @since 1.5.0
    1147      * @access public
     1141     * Shorten version of WP_Rewrite::generate_rewrite_rules() that allows for shorter
     1142     * list of parameters. See the method for longer description of what generating
     1143     * rewrite rules does.
     1144     *
     1145     * @since 1.5.0
     1146     * @access public
     1147     *
     1148     * @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
    11481149     *
    11491150     * @param string $permalink_structure The permalink structure to generate rules.
     
    13641365     * Retrieve the rewrite rules.
    13651366     *
    1366      * The difference between this method and {@link
    1367      * WP_Rewrite::rewrite_rules()} is that this method stores the rewrite rules
    1368      * in the 'rewrite_rules' option and retrieves it. This prevents having to
    1369      * process all of the permalinks to get the rewrite rules in the form of
    1370      * caching.
     1367     * The difference between this method and WP_Rewrite::rewrite_rules() is that
     1368     * this method stores the rewrite rules in the 'rewrite_rules' option and retrieves
     1369     * it. This prevents having to process all of the permalinks to get the rewrite rules
     1370     * in the form of caching.
    13711371     *
    13721372     * @since 1.5.0
     
    16231623     * Add a new permalink structure.
    16241624     *
    1625      * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules; it
    1626      * is an easy way of expressing a set of regular expressions that rewrite to a set of query strings.
    1627      * The new permastruct is added to the {@link WP_Rewrite::$extra_permastructs} array. When the
    1628      * rewrite rules are built by {@link WP_Rewrite::rewrite_rules()} all of these extra permastructs
    1629      * are passed to {@link WP_Rewrite::generate_rewrite_rules()} which transforms them into the
    1630      * regular expressions that many love to hate.
    1631      *
    1632      * The $args parameter gives you control over how {@link WP_Rewrite::generate_rewrite_rules()}
     1625     * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules;
     1626     * it is an easy way of expressing a set of regular expressions that rewrite to a set of
     1627     * query strings. The new permastruct is added to the WP_Rewrite::$extra_permastructs array.
     1628     * When the rewrite rules are built by WP_Rewrite::rewrite_rules(), all of these extra
     1629     * permastructs are passed to WP_Rewrite::generate_rewrite_rules() which transforms them
     1630     * into the regular expressions that many love to hate.
     1631     *
     1632     * The `$args` parameter gives you control over how WP_Rewrite::generate_rewrite_rules()
    16331633     * works on the new permastruct.
    16341634     *
     
    16791679     * Remove rewrite rules and then recreate rewrite rules.
    16801680     *
    1681      * Calls {@link WP_Rewrite::wp_rewrite_rules()} after removing the
    1682      * 'rewrite_rules' option. If the function named 'save_mod_rewrite_rules'
    1683      * exists, it will be called.
     1681     * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option.
     1682     * If the function named 'save_mod_rewrite_rules' exists, it will be called.
    16841683     *
    16851684     * @since 2.0.1
     
    17621761     * Will update the 'permalink_structure' option, if there is a difference
    17631762     * between the current permalink structure and the parameter value. Calls
    1764      * {@link WP_Rewrite::init()} after the option is updated.
     1763     * WP_Rewrite::init() after the option is updated.
    17651764     *
    17661765     * Fires the 'permalink_structure_changed' action once the init call has
     
    17941793     *
    17951794     * Will update the 'category_base' option, if there is a difference between
    1796      * the current category base and the parameter value. Calls
    1797      * {@link WP_Rewrite::init()} after the option is updated.
     1795     * the current category base and the parameter value. Calls WP_Rewrite::init()
     1796     * after the option is updated.
    17981797     *
    17991798     * @since 1.5.0
     
    18131812     *
    18141813     * Will update the 'tag_base' option, if there is a difference between the
    1815      * current tag base and the parameter value. Calls
    1816      * {@link WP_Rewrite::init()} after the option is updated.
     1814     * current tag base and the parameter value. Calls WP_Rewrite::init() after
     1815     * the option is updated.
    18171816     *
    18181817     * @since 2.3.0
Note: See TracChangeset for help on using the changeset viewer.