WordPress.org
Get WordPress

Make WordPress Core

Changeset 34944


Ignore:
Timestamp:
10/08/2015 05:11:52 PM (11 years ago)
Author:
DrewAPicture
Message:

Docs: Fix third-person singular verbs in DocBlock summaries throughout WP_Rewrite.

See #34218.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-rewrite.php

    r34941 r34944  
    368368
    369369        /**
    370          * Whether permalinks are being used.
     370         * Determines whether permalinks are being used.
    371371         *
    372372         * This can be either rewrite module or permalink in the HTTP query string.
    … …  
    382382
    383383        /**
    384          * Whether permalinks are being used and rewrite module is not enabled.
     384         * Determins whether permalinks are being used and rewrite module is not enabled.
    385385         *
    386386         * Means that permalink links are enabled and index.php is in the URL.
    … …  
    389389         * @access public
    390390         *
    391          * @return bool
     391         * @return bool Whether permalink links are enabled and index.php is in the URL.
    392392         */
    393393        public function using_index_permalinks() {
    … …  
    400400
    401401        /**
    402          * Whether permalinks are being used and rewrite module is enabled.
     402         * Determines whether permalinks are being used and rewrite module is enabled.
    403403         *
    404404         * Using permalinks and index.php is not in the URL.
    … …  
    407407         * @access public
    408408         *
    409          * @return bool
     409         * @return bool Whether permalink links are enabled and index.php is NOT in the URL.
    410410         */
    411411        public function using_mod_rewrite_permalinks() {
    … …  
    414414
    415415        /**
    416          * Index for matches for usage in preg_*() functions.
     416         * Indexes for matches for usage in preg_*() functions.
    417417         *
    418418         * The format of the string is, with empty matches property value, '$NUM'.
    … …  
    442442
    443443        /**
    444          * Retrieve all page and attachments for pages URIs.
     444         * Retrieves all page and attachments for pages URIs.
    445445         *
    446446         * The attachments are for those that have pages as parents and will be
    … …  
    450450         * @access public
    451451         *
    452          * @global wpdb $wpdb
     452         * @global wpdb $wpdb WordPress database abstraction object.
    453453         *
    454454         * @return array Array of page URIs as first element and attachment URIs as second element.
    … …  
    489489
    490490        /**
    491          * Retrieve all of the rewrite rules for pages.
    492          *
    493          * @since 1.5.0
    494          * @access public
    495          *
    496          * @return array
     491         * Retrieves all of the rewrite rules for pages.
     492         *
     493         * @since 1.5.0
     494         * @access public
     495         *
     496         * @return array Page rewrite rules.
    497497         */
    498498        public function page_rewrite_rules() {
    … …  
    504504
    505505        /**
    506          * Retrieve date permalink structure, with year, month, and day.
     506         * Retrieves date permalink structure, with year, month, and day.
    507507         *
    508508         * The permalink structure for the date, if not set already depends on the
    … …  
    567567
    568568        /**
    569          * Retrieve the year permalink structure without month and day.
     569         * Retrieves the year permalink structure without month and day.
    570570         *
    571571         * Gets the date permalink structure and strips out the month and day
    … …  
    591591
    592592        /**
    593          * Retrieve the month permalink structure without day and with year.
     593         * Retrieves the month permalink structure without day and with year.
    594594         *
    595595         * Gets the date permalink structure and strips out the day permalink
    … …  
    614614
    615615        /**
    616          * Retrieve the day permalink structure with month and year.
     616         * Retrieves the day permalink structure with month and year.
    617617         *
    618618         * Keeps date permalink structure with all year, month, and day.
    … …  
    628628
    629629        /**
    630          * Retrieve the permalink structure for categories.
     630         * Retrieves the permalink structure for categories.
    631631         *
    632632         * If the category_base property has no value, then the category structure
    … …  
    662662
    663663        /**
    664          * Retrieve extra permalink structure by name.
     664         * Retrieves an extra permalink structure by name.
    665665         *
    666666         * @since 2.5.0
    … …  
    681681
    682682        /**
    683          * Retrieve the author permalink structure.
     683         * Retrieves the author permalink structure.
    684684         *
    685685         * The permalink structure is front property, author base, and finally
    … …  
    707707
    708708        /**
    709          * Retrieve the search permalink structure.
     709         * Retrieves the search permalink structure.
    710710         *
    711711         * The permalink structure is root property, search base, and finally
    … …  
    733733
    734734        /**
    735          * Retrieve the page permalink structure.
     735         * Retrieves the page permalink structure.
    736736         *
    737737         * The permalink structure is root property, and '%pagename%'. Will set the
    … …  
    759759
    760760        /**
    761          * Retrieve the feed permalink structure.
     761         * Retrieves the feed permalink structure.
    762762         *
    763763         * The permalink structure is root property, feed base, and finally
    … …  
    785785
    786786        /**
    787          * Retrieve the comment feed permalink structure.
     787         * Retrieves the comment feed permalink structure.
    788788         *
    789789         * The permalink structure is root property, comment base property, feed
    … …  
    811811
    812812        /**
    813          * Add or update existing rewrite tags (e.g. %postname%).
     813         * Adds or updates existing rewrite tags (e.g. %postname%).
    814814         *
    815815         * If the tag already exists, replace the existing pattern and query for
    … …  
    840840
    841841        /**
    842          * Generate rewrite rules from a permalink structure.
     842         * Generates rewrite rules from a permalink structure.
    843843         *
    844844         * The main WP_Rewrite function for building the rewrite rule list. The
    … …  
    11431143
    11441144        /**
    1145          * Generate Rewrite rules with permalink structure and walking directory only.
     1145         * Generates rewrite rules with permalink structure and walking directory only.
    11461146         *
    11471147         * Shorten version of WP_Rewrite::generate_rewrite_rules() that allows for shorter
    … …  
    11631163
    11641164        /**
    1165          * Construct rewrite matches and queries from permalink structure.
     1165         * Constructs rewrite matches and queries from permalink structure.
    11661166         *
    11671167         * Runs the action 'generate_rewrite_rules' with the parameter that is an
    … …  
    13691369
    13701370        /**
    1371          * Retrieve the rewrite rules.
     1371         * Retrieves the rewrite rules.
    13721372         *
    13731373         * The difference between this method and WP_Rewrite::rewrite_rules() is that
    … …  
    13931393
    13941394        /**
    1395          * Retrieve mod_rewrite formatted rewrite rules to write to .htaccess.
     1395         * Retrieves mod_rewrite-formatted rewrite rules to write to .htaccess.
    13961396         *
    13971397         * Does not actually write to the .htaccess file, but creates the rules for
    … …  
    14921492
    14931493        /**
    1494          * Retrieve IIS7 URL Rewrite formatted rewrite rules to write to web.config file.
     1494         * Retrieves IIS7 URL Rewrite formatted rewrite rules to write to web.config file.
    14951495         *
    14961496         * Does not actually write to the web.config file, but creates the rules for
    … …  
    15421542
    15431543        /**
    1544          * Add a straight rewrite rule.
     1544         * Adds a straight rewrite rule.
    15451545         *
    15461546         * Any value in the $after parameter that isn't 'bottom' will be placed at
    … …  
    15801580
    15811581        /**
    1582          * Add a rule that doesn't redirect to index.php.
     1582         * Adds a rule that doesn't redirect to index.php.
    15831583         *
    15841584         * Can redirect to any place.
    … …  
    15951595
    15961596        /**
    1597          * Add an endpoint, like /trackback/.
     1597         * Adds an endpoint, like /trackback/.
    15981598         *
    15991599         * @since 2.1.0
    … …  
    16261626
    16271627        /**
    1628          * Add a new permalink structure.
     1628         * Adds a new permalink structure.
    16291629         *
    16301630         * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules;
    … …  
    16821682
    16831683        /**
    1684          * Remove rewrite rules and then recreate rewrite rules.
     1684         * Removes rewrite rules and then recreate rewrite rules.
    16851685         *
    16861686         * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option.
    … …  
    17621762
    17631763        /**
    1764          * Set the main permalink structure for the blog.
     1764         * Sets the main permalink structure for the site.
    17651765         *
    17661766         * Will update the 'permalink_structure' option, if there is a difference
    … …  
    17951795
    17961796        /**
    1797          * Set the category base for the category permalink.
     1797         * Sets the category base for the category permalink.
    17981798         *
    17991799         * Will update the 'category_base' option, if there is a difference between
    … …  
    18141814
    18151815        /**
    1816          * Set the tag base for the tag permalink.
     1816         * Sets the tag base for the tag permalink.
    18171817         *
    18181818         * Will update the 'tag_base' option, if there is a difference between the
Note: See TracChangeset for help on using the changeset viewer.