Make WordPress Core

Changeset 8899


Ignore:
Timestamp:
09/16/2008 12:35:56 AM (18 years ago)
Author:
ryan
Message:

phpdoc for rewrite.php from jacobsantos. see #7660

File:
1 edited

Legend:

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

    r8793 r8899  
    88
    99/**
    10  * add_rewrite_rule() - Add a straight rewrite rule
    11  *
    12  * {@internal Missing Long Description}}
    13  *
     10 * Add a straight rewrite rule.
     11 *
     12 * @see WP_Rewrite::add_rule() for long description.
    1413 * @since 2.1.0
    1514 *
    16  * @param unknown_type $regex
    17  * @param unknown_type $redirect
    18  * @param unknown_type $after
     15 * @param string $regex Regular Expression to match request against.
     16 * @param string $redirect Page to redirect to.
     17 * @param string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'.
    1918 */
    2019function add_rewrite_rule($regex, $redirect, $after = 'bottom') {
     
    2423
    2524/**
    26  * add_rewrite_tag() - Add a new tag (like %postname%)
    27  *
    28  * Warning: you must call this on init or earlier, otherwise
    29  * the query var addition stuff won't work
     25 * Add a new tag (like %postname%).
     26 *
     27 * Warning: you must call this on init or earlier, otherwise the query var
     28 * addition stuff won't work.
    3029 *
    3130 * @since 2.1.0
    3231 *
    33  * @param unknown_type $tagname
    34  * @param unknown_type $regex
     32 * @param string $tagname
     33 * @param string $regex
    3534 */
    3635function add_rewrite_tag($tagname, $regex) {
     
    4847
    4948/**
    50  * add_feed() - Add a new feed type like /atom1/
    51  *
    52  * {@internal Missing Long Description}}
     49 * Add a new feed type like /atom1/.
    5350 *
    5451 * @since 2.1.0
    5552 *
    56  * @param unknown_type $feedname
    57  * @param unknown_type $function
    58  * @return unknown
     53 * @param string $feedname
     54 * @param callback $function Callback to run on feed display.
     55 * @return string Feed action name.
    5956 */
    6057function add_feed($feedname, $function) {
     
    7168
    7269/**
    73  * {@internal Missing Description}}
     70 * Endpoint Mask for Permalink.
    7471 *
    7572 * @since 2.1.0
     
    7875
    7976/**
    80  * {@internal Missing Description}}
     77 * Endpoint Mask for Attachment.
    8178 *
    8279 * @since 2.1.0
     
    8582
    8683/**
    87  * {@internal Missing Description}}
     84 * Endpoint Mask for date.
    8885 *
    8986 * @since 2.1.0
     
    9289
    9390/**
    94  * {@internal Missing Description}}
     91 * Endpoint Mask for year
    9592 *
    9693 * @since 2.1.0
     
    9996
    10097/**
    101  * {@internal Missing Description}}
     98 * Endpoint Mask for month.
    10299 *
    103100 * @since 2.1.0
     
    106103
    107104/**
    108  * {@internal Missing Description}}
     105 * Endpoint Mask for day.
    109106 *
    110107 * @since 2.1.0
     
    113110
    114111/**
    115  * {@internal Missing Description}}
     112 * Endpoint Mask for root.
    116113 *
    117114 * @since 2.1.0
     
    120117
    121118/**
    122  * {@internal Missing Description}}
     119 * Endpoint Mask for comments.
    123120 *
    124121 * @since 2.1.0
     
    127124
    128125/**
    129  * {@internal Missing Description}}
     126 * Endpoint Mask for searches.
    130127 *
    131128 * @since 2.1.0
     
    134131
    135132/**
    136  * {@internal Missing Description}}
     133 * Endpoint Mask for categories.
    137134 *
    138135 * @since 2.1.0
     
    141138
    142139/**
    143  * {@internal Missing Description}}
     140 * Endpoint Mask for tags.
    144141 *
    145142 * @since 2.3.0
     
    148145
    149146/**
    150  * {@internal Missing Description}}
     147 * Endpoint Mask for authors.
    151148 *
    152149 * @since 2.1.0
     
    155152
    156153/**
    157  * {@internal Missing Description}}
     154 * Endpoint Mask for pages.
    158155 *
    159156 * @since 2.1.0
     
    163160//pseudo-places
    164161/**
    165  * {@internal Missing Description}}
     162 * Endpoint Mask for default, which is nothing.
    166163 *
    167164 * @since 2.1.0
     
    170167
    171168/**
    172  * {@internal Missing Description}}
     169 * Endpoint Mask for everything.
    173170 *
    174171 * @since 2.1.0
     
    177174
    178175/**
    179  * add_rewrite_endpoint() - Add an endpoint, like /trackback/
    180  *
    181  * {@internal Missing Long Description}}
     176 * Add an endpoint, like /trackback/.
     177 *
     178 * The endpoints are added to the end of the request. So a request matching
     179 * "/2008/10/14/my_post/myep/", the endpoint will be "/myep/".
    182180 *
    183181 * @since 2.1.0
     182 * @see WP_Rewrite::add_endpoint() Parameters and more description.
     183 * @uses $wp_rewrite
    184184 *
    185185 * @param unknown_type $name
     
    192192
    193193/**
    194   * _wp_filter_taxonomy_base() - filter the URL base for taxonomies, to remove any manually prepended /index.php/
    195   * @param string $base the taxonomy base that we're going to filter
     194  * Filter the URL base for taxonomies.
     195  *
     196  * To remove any manually prepended /index.php/.
     197  *
     198  * @access private
     199  * @since unknown (2.3.0?)
     200  * @author Mark Jaquith
     201  *
     202  * @param string $base The taxonomy base that we're going to filter
    196203  * @return string
    197   * @author Mark Jaquith
    198204  */
    199205function _wp_filter_taxonomy_base( $base ) {
     
    205211}
    206212
    207 // examine a url (supposedly from this blog) and try to
    208 // determine the post ID it represents.
    209 /**
    210  * url_to_postid() - Examine a url and try to determine the post ID it represents
    211  *
    212  * {@internal Missing Long Description}}
     213/**
     214 * Examine a url and try to determine the post ID it represents.
    213215 *
    214216 * Checks are supposedly from the hosted site blog.
     
    216218 * @since 1.0.0
    217219 *
    218  * @param unknown_type $url
    219  * @return unknown
     220 * @param string $url Permalink to check.
     221 * @return int Post ID, or 0 on failure.
    220222 */
    221223function url_to_postid($url) {
     
    316318
    317319/**
    318  * {@internal Missing Short Description}}
    319  *
    320  * {@internal Missing Long Description}}
     320 * WordPress Rewrite Component.
     321 *
     322 * The WordPress Rewrite class writes the rewrite module rules to the .htaccess
     323 * file. It also handles parsing the request to get the correct setup for the
     324 * WordPress Query class.
     325 *
     326 * The Rewrite along with WP class function as a front controller for WordPress.
     327 * You can add rules to trigger your page view and processing using this
     328 * component. The full functionality of a front controller does not exist,
     329 * meaning you can't define how the template files load based on the rewrite
     330 * rules.
    321331 *
    322332 * @since 1.5.0
     
    324334class WP_Rewrite {
    325335        /**
     336         * Default permalink structure for WordPress.
     337         *
     338         * @since 1.5.0
     339         * @access private
     340         * @var string
     341         */
     342        var $permalink_structure;
     343
     344        /**
     345         * Whether to add trailing slashes.
     346         *
     347         * @since 2.2.0
     348         * @access private
     349         * @var bool
     350         */
     351        var $use_trailing_slashes;
     352
     353        /**
     354         * Customized or default category permalink base ( example.com/xx/tagname ).
     355         *
     356         * @since 1.5.0
     357         * @access private
     358         * @var string
     359         */
     360        var $category_base;
     361
     362        /**
     363         * Customized or default tag permalink base ( example.com/xx/tagname ).
     364         *
     365         * @since 2.3.0
     366         * @access private
     367         * @var string
     368         */
     369        var $tag_base;
     370
     371        /**
     372         * Permalink request structure for categories.
     373         *
     374         * @since 1.5.0
     375         * @access private
     376         * @var string
     377         */
     378        var $category_structure;
     379
     380        /**
     381         * Permalink request structure for tags.
     382         *
     383         * @since 2.3.0
     384         * @access private
     385         * @var string
     386         */
     387        var $tag_structure;
     388
     389        /**
     390         * Permalink author request base ( example.com/author/authorname ).
     391         *
     392         * @since 1.5.0
     393         * @access private
     394         * @var string
     395         */
     396        var $author_base = 'author';
     397
     398        /**
     399         * Permalink request structure for author pages.
     400         *
     401         * @since 1.5.0
     402         * @access private
     403         * @var string
     404         */
     405        var $author_structure;
     406
     407        /**
     408         * Permalink request structure for dates.
     409         *
     410         * @since 1.5.0
     411         * @access private
     412         * @var string
     413         */
     414        var $date_structure;
     415
     416        /**
     417         * Permalink request structure for pages.
     418         *
     419         * @since 1.5.0
     420         * @access private
     421         * @var string
     422         */
     423        var $page_structure;
     424
     425        /**
     426         * Search permalink base ( example.com/search/query ).
     427         *
     428         * @since 1.5.0
     429         * @access private
     430         * @var string
     431         */
     432        var $search_base = 'search';
     433
     434        /**
     435         * Permalink request structure for searches.
     436         *
     437         * @since 1.5.0
     438         * @access private
     439         * @var string
     440         */
     441        var $search_structure;
     442
     443        /**
     444         * Comments permalink base.
     445         *
     446         * @since 1.5.0
     447         * @access private
     448         * @var string
     449         */
     450        var $comments_base = 'comments';
     451
     452        /**
     453         * Feed permalink base.
     454         *
     455         * @since 1.5.0
     456         * @access private
     457         * @var string
     458         */
     459        var $feed_base = 'feed';
     460
     461        /**
     462         * Comments feed request structure permalink.
     463         *
     464         * @since 1.5.0
     465         * @access private
     466         * @var string
     467         */
     468        var $comments_feed_structure;
     469
     470        /**
     471         * Feed request structure permalink.
     472         *
     473         * @since 1.5.0
     474         * @access private
     475         * @var string
     476         */
     477        var $feed_structure;
     478
     479        /**
     480         * Front URL path.
     481         *
     482         * The difference between the root property is that WordPress might be
     483         * located at example/WordPress/index.php, if permalinks are turned off. The
     484         * index.php will be the front portion. If permalinks are turned on, this
     485         * will most likely be empty or not set.
     486         *
     487         * @since 1.5.0
     488         * @access private
     489         * @var string
     490         */
     491        var $front;
     492
     493        /**
     494         * Root URL path to WordPress (without domain).
     495         *
     496         * The difference between front property is that WordPress might be located
     497         * at example.com/WordPress/. The root is the 'WordPress/' portion.
     498         *
     499         * @since 1.5.0
     500         * @access private
     501         * @var string
     502         */
     503        var $root = '';
     504
     505        /**
     506         * Permalink to the home page.
     507         *
     508         * @since 1.5.0
     509         * @access public
     510         * @var string
     511         */
     512        var $index = 'index.php';
     513
     514        /**
    326515         * {@internal Missing Description}}
    327516         *
    328517         * @since 1.5.0
    329518         * @access private
    330          * @var unknown_type
    331          */
    332         var $permalink_structure;
     519         * @var string
     520         */
     521        var $matches = '';
     522
     523        /**
     524         * Rewrite rules to match against the request to find the redirect or query.
     525         *
     526         * @since 1.5.0
     527         * @access private
     528         * @var array
     529         */
     530        var $rules;
     531
     532        /**
     533         * Additional rules added external to the rewrite class.
     534         *
     535         * Those not generated by the class, see add_rewrite_rule().
     536         *
     537         * @since 2.1.0
     538         * @access private
     539         * @var array
     540         */
     541        var $extra_rules = array(); //
     542
     543        /**
     544         * Additional rules that belong at the beginning to match first.
     545         *
     546         * Those not generated by the class, see add_rewrite_rule().
     547         *
     548         * @since 2.3.0
     549         * @access private
     550         * @var array
     551         */
     552        var $extra_rules_top = array(); //
     553
     554        /**
     555         * Rules that don't redirect to WP's index.php
     556         *
     557         * @since 2.1.0
     558         * @access private
     559         * @var array
     560         */
     561        var $non_wp_rules = array(); //
    333562
    334563        /**
    335564         * {@internal Missing Description}}
    336565         *
    337          * @since 2.2.0
    338          * @access private
    339          * @var bool
    340          */
    341         var $use_trailing_slashes;
    342 
    343         /**
    344          * {@internal Missing Description}}
    345          *
    346          * @since 1.5.0
    347          * @access private
    348          * @var unknown_type
    349          */
    350         var $category_base;
    351 
    352         /**
    353          * {@internal Missing Description}}
    354          *
    355          * @since 2.3.0
    356          * @access private
    357          * @var unknown_type
    358          */
    359         var $tag_base;
    360 
    361         /**
    362          * {@internal Missing Description}}
    363          *
    364          * @since 1.5.0
    365          * @access private
    366          * @var unknown_type
    367          */
    368         var $category_structure;
    369 
    370         /**
    371          * {@internal Missing Description}}
    372          *
    373          * @since 2.3.0
    374          * @access private
    375          * @var unknown_type
    376          */
    377         var $tag_structure;
    378 
    379         /**
    380          * {@internal Missing Description}}
    381          *
    382          * @since 1.5.0
    383          * @access private
    384          * @var string
    385          */
    386         var $author_base = 'author';
    387 
    388         /**
    389          * {@internal Missing Description}}
    390          *
    391          * @since 1.5.0
    392          * @access private
    393          * @var unknown_type
    394          */
    395         var $author_structure;
    396 
    397         /**
    398          * {@internal Missing Description}}
    399          *
    400          * @since 1.5.0
    401          * @access private
    402          * @var unknown_type
    403          */
    404         var $date_structure;
    405 
    406         /**
    407          * {@internal Missing Description}}
    408          *
    409          * @since 1.5.0
    410          * @access private
    411          * @var unknown_type
    412          */
    413         var $page_structure;
    414 
    415         /**
    416          * {@internal Missing Description}}
    417          *
    418          * @since 1.5.0
    419          * @access private
    420          * @var string
    421          */
    422         var $search_base = 'search';
    423 
    424         /**
    425          * {@internal Missing Description}}
    426          *
    427          * @since 1.5.0
    428          * @access private
    429          * @var unknown_type
    430          */
    431         var $search_structure;
    432 
    433         /**
    434          * {@internal Missing Description}}
    435          *
    436          * @since 1.5.0
    437          * @access private
    438          * @var string
    439          */
    440         var $comments_base = 'comments';
    441 
    442         /**
    443          * {@internal Missing Description}}
    444          *
    445          * @since 1.5.0
    446          * @access private
    447          * @var string
    448          */
    449         var $feed_base = 'feed';
    450 
    451         /**
    452          * {@internal Missing Description}}
    453          *
    454          * @since 1.5.0
    455          * @access private
    456          * @var string
    457          */
    458         var $comments_feed_structure;
    459 
    460         /**
    461          * {@internal Missing Description}}
    462          *
    463          * @since 1.5.0
    464          * @access private
    465          * @var string
    466          */
    467         var $feed_structure;
    468 
    469         /**
    470          * {@internal Missing Description}}
    471          *
    472          * @since 1.5.0
    473          * @access private
    474          * @var unknown_type
    475          */
    476         var $front;
    477 
    478         /**
    479          * {@internal Missing Description}}
    480          *
    481          * @since 1.5.0
    482          * @access
    483          * @var unknown_type
    484          */
    485         var $root = '';
    486 
    487         /**
    488          * {@internal Missing Description}}
    489          *
    490          * @since 1.5.0
    491          * @access public
    492          * @var string
    493          */
    494         var $index = 'index.php';
    495 
    496         /**
    497          * {@internal Missing Description}}
    498          *
    499          * @since 1.5.0
    500          * @access private
    501          * @var unknown_type
    502          */
    503         var $matches = '';
    504 
    505         /**
    506          * {@internal Missing Description}}
    507          *
    508          * @since 1.5.0
     566         * @since 2.1.0
    509567         * @access private
    510568         * @var array
    511569         */
    512         var $rules;
    513 
    514         /**
    515          * {@internal Missing Description}}
    516          *
    517          * Those not generated by the class, see add_rewrite_rule()
    518          *
    519          * @since 2.1.0
     570        var $extra_permastructs = array();
     571
     572        /**
     573         * Endpoints permalinks
     574         *
     575         * @since unknown
    520576         * @access private
    521577         * @var array
    522578         */
    523         var $extra_rules = array(); //
    524 
    525         /**
    526          * {@internal Missing Description}}
    527          *
    528          * Those not generated by the class, see add_rewrite_rule()
    529          *
    530          * @since 2.3.0
    531          * @access private
    532          * @var array
    533          */
    534         var $extra_rules_top = array(); //
    535 
    536         /**
    537          * Rules that don't redirect to WP's index.php
    538          *
    539          * @since 2.1.0
    540          * @access private
    541          * @var array
    542          */
    543         var $non_wp_rules = array(); //
    544 
    545         /**
    546          * {@internal Missing Description}}
    547          *
    548          * @since 2.1.0
    549          * @access private
    550          * @var unknown_type
    551          */
    552         var $extra_permastructs = array();
    553579        var $endpoints;
    554580
     
    644670
    645671        /**
    646          * {@internal Missing Description}}
     672         * Supported default feeds.
    647673         *
    648674         * @since 1.5.0
     
    653679
    654680        /**
    655          * {@internal Missing Short Description}}
    656          *
    657          * {@internal Missing Long Description}}
    658          *
    659          * @since 1.5.0
    660          * @access public
    661          *
    662          * @return unknown
     681         * Whether permalinks are being used.
     682         *
     683         * This can be either rewrite module or permalink in the HTTP query string.
     684         *
     685         * @since 1.5.0
     686         * @access public
     687         *
     688         * @return bool True, if permalinks are enabled.
    663689         */
    664690        function using_permalinks() {
     
    670696
    671697        /**
    672          * {@internal Missing Short Description}}
    673          *
    674          * {@internal Missing Long Description}}
    675          *
    676          * @since 1.5.0
    677          * @access public
    678          *
    679          * @return unknown
     698         * Whether permalinks are being used and rewrite module is not enabled.
     699         *
     700         * Means that permalink links are enabled and index.php is in the URL.
     701         *
     702         * @since 1.5.0
     703         * @access public
     704         *
     705         * @return bool
    680706         */
    681707        function using_index_permalinks() {
     
    693719
    694720        /**
    695          * {@internal Missing Short Description}}
    696          *
    697          * {@internal Missing Long Description}}
    698          *
    699          * @since 1.5.0
    700          * @access public
    701          *
    702          * @return unknown
     721         * Whether permalinks are being used and rewrite module is enabled.
     722         *
     723         * Using permalinks and index.php is not in the URL.
     724         *
     725         * @since 1.5.0
     726         * @access public
     727         *
     728         * @return bool
    703729         */
    704730        function using_mod_rewrite_permalinks() {
     
    717743         * @access public
    718744         *
    719          * @param unknown_type $number
    720          * @return unknown
     745         * @param int $number Index number.
     746         * @return string
    721747         */
    722748        function preg_index($number) {
     
    816842
    817843        /**
    818          * {@internal Missing Short Description}}
    819          *
    820          * {@internal Missing Long Description}}
    821          *
    822          * @since 1.5.0
    823          * @access public
    824          *
    825          * @return unknown
     844         * Retrieve date permalink structure, with year, month, and day.
     845         *
     846         * The permalink structure for the date, if not set already depends on the
     847         * permalink structure. It can be one of three formats. The first is year,
     848         * month, day; the second is day, month, year; and the last format is month,
     849         * day, year. These are matched against the permalink structure for which
     850         * one is used. If none matches, then the default will be used, which is
     851         * year, month, day.
     852         *
     853         * Prevents post ID and date permalinks from overlapping. In the case of
     854         * post_id, the date permalink will be prepended with front permalink with
     855         * 'date/' before the actual permalink to form the complete date permalink
     856         * structure.
     857         *
     858         * @since 1.5.0
     859         * @access public
     860         *
     861         * @return bool|string False on no permalink structure. Date permalink structure.
    826862         */
    827863        function get_date_permastruct() {
     
    870906
    871907        /**
    872          * {@internal Missing Short Description}}
    873          *
    874          * {@internal Missing Long Description}}
    875          *
    876          * @since 1.5.0
    877          * @access public
    878          *
    879          * @return unknown
     908         * Retrieve the year permalink structure without month and day.
     909         *
     910         * Gets the date permalink structure and strips out the month and day
     911         * permalink structures.
     912         *
     913         * @since 1.5.0
     914         * @access public
     915         *
     916         * @return bool|string False on failure. Year structure on success.
    880917         */
    881918        function get_year_permastruct() {
     
    895932
    896933        /**
    897          * {@internal Missing Short Description}}
    898          *
    899          * {@internal Missing Long Description}}
    900          *
    901          * @since 1.5.0
    902          * @access public
    903          *
    904          * @return unknown
     934         * Retrieve the month permalink structure without day and with year.
     935         *
     936         * Gets the date permalink structure and strips out the day permalink
     937         * structures. Keeps the year permalink structure.
     938         *
     939         * @since 1.5.0
     940         * @access public
     941         *
     942         * @return bool|string False on failure. Year/Month structure on success.
    905943         */
    906944        function get_month_permastruct() {
     
    919957
    920958        /**
    921          * {@internal Missing Short Description}}
    922          *
    923          * {@internal Missing Long Description}}
    924          *
    925          * @since 1.5.0
    926          * @access public
    927          *
    928          * @return unknown
     959         * Retrieve the day permalink structure with month and year.
     960         *
     961         * Keeps date permalink structure with all year, month, and day.
     962         *
     963         * @since 1.5.0
     964         * @access public
     965         *
     966         * @return bool|string False on failure. Year/Month/Day structure on success.
    929967         */
    930968        function get_day_permastruct() {
     
    933971
    934972        /**
    935          * {@internal Missing Short Description}}
     973         * Retrieve the permalink structure for categories.
    936974         *
    937975         * {@internal Missing Long Description}}
     
    940978         * @access public
    941979         *
    942          * @return unknown
     980         * @return bool|string False on failure. Category permalink structure.
    943981         */
    944982        function get_category_permastruct() {
     
    9631001
    9641002        /**
    965          * {@internal Missing Short Description}}
     1003         * Retrieve the permalink structure for tags.
    9661004         *
    9671005         * {@internal Missing Long Description}}
     
    9701008         * @access public
    9711009         *
    972          * @return unknown
     1010         * @return bool|string False on failure. Tag permalink structure.
    9731011         */
    9741012        function get_tag_permastruct() {
     
    9921030        }
    9931031
     1032        /**
     1033         * Retrieve extra permalink structure by name.
     1034         *
     1035         * @since unknown
     1036         * @access public
     1037         *
     1038         * @param string $name Permalink structure name.
     1039         * @return string|bool False if not found. Permalink structure string.
     1040         */
    9941041        function get_extra_permastruct($name) {
    9951042                if ( isset($this->extra_permastructs[$name]) )
     
    9991046
    10001047        /**
    1001          * {@internal Missing Short Description}}
    1002          *
    1003          * {@internal Missing Long Description}}
    1004          *
    1005          * @since 1.5.0
    1006          * @access public
    1007          *
    1008          * @return unknown
     1048         * Retrieve the author permalink structure.
     1049         *
     1050         * The permalink structure is front property, author base, and finally
     1051         * '/%author%'. Will set the author_structure property and then return it
     1052         * without attempting to set the value again.
     1053         *
     1054         * @since 1.5.0
     1055         * @access public
     1056         *
     1057         * @return string|bool False if not found. Permalink structure string.
    10091058         */
    10101059        function get_author_permastruct() {
     
    10241073
    10251074        /**
    1026          * {@internal Missing Short Description}}
    1027          *
    1028          * {@internal Missing Long Description}}
    1029          *
    1030          * @since 1.5.0
    1031          * @access public
    1032          *
    1033          * @return unknown
     1075         * Retrieve the search permalink structure.
     1076         *
     1077         * The permalink structure is root property, search base, and finally
     1078         * '/%search%'. Will set the search_structure property and then return it
     1079         * without attempting to set the value again.
     1080         *
     1081         * @since 1.5.0
     1082         * @access public
     1083         *
     1084         * @return string|bool False if not found. Permalink structure string.
    10341085         */
    10351086        function get_search_permastruct() {
     
    10491100
    10501101        /**
    1051          * {@internal Missing Short Description}}
    1052          *
    1053          * {@internal Missing Long Description}}
    1054          *
    1055          * @since 1.5.0
    1056          * @access public
    1057          *
    1058          * @return unknown
     1102         * Retrieve the page permalink structure.
     1103         *
     1104         * The permalink structure is root property, and '%pagename%'. Will set the
     1105         * page_structure property and then return it without attempting to set the
     1106         * value again.
     1107         *
     1108         * @since 1.5.0
     1109         * @access public
     1110         *
     1111         * @return string|bool False if not found. Permalink structure string.
    10591112         */
    10601113        function get_page_permastruct() {
     
    10741127
    10751128        /**
    1076          * {@internal Missing Short Description}}
    1077          *
    1078          * {@internal Missing Long Description}}
    1079          *
    1080          * @since 1.5.0
    1081          * @access public
    1082          *
    1083          * @return unknown
     1129         * Retrieve the feed permalink structure.
     1130         *
     1131         * The permalink structure is root property, feed base, and finally
     1132         * '/%feed%'. Will set the feed_structure property and then return it
     1133         * without attempting to set the value again.
     1134         *
     1135         * @since 1.5.0
     1136         * @access public
     1137         *
     1138         * @return string|bool False if not found. Permalink structure string.
    10841139         */
    10851140        function get_feed_permastruct() {
     
    10991154
    11001155        /**
    1101          * {@internal Missing Short Description}}
    1102          *
    1103          * {@internal Missing Long Description}}
    1104          *
    1105          * @since 1.5.0
    1106          * @access public
    1107          *
    1108          * @return unknown
     1156         * Retrieve the comment feed permalink structure.
     1157         *
     1158         * The permalink structure is root property, comment base property, feed
     1159         * base and finally '/%feed%'. Will set the comment_feed_structure property
     1160         * and then return it without attempting to set the value again.
     1161         *
     1162         * @since 1.5.0
     1163         * @access public
     1164         *
     1165         * @return string|bool False if not found. Permalink structure string.
    11091166         */
    11101167        function get_comment_feed_permastruct() {
     
    11511208
    11521209        /**
    1153          * Generate the rules from permalink structure
     1210         * Generate the rules from permalink structure.
    11541211         *
    11551212         * {@internal Missing Long Description}}
     
    16411698        }
    16421699
     1700        /**
     1701         * {@internal Missing Short Description}}
     1702         *
     1703         * {@internal Missing Long Description}}
     1704         *
     1705         * @since unknown
     1706         * @access public
     1707         *
     1708         * @param unknown_type $name
     1709         * @param unknown_type $struct
     1710         * @param unknown_type $with_front
     1711         */
    16431712        function add_permastruct($name, $struct, $with_front = true) {
    16441713                if ( $with_front )
     
    16481717
    16491718        /**
    1650          * {@internal Missing Short Description}}
    1651          *
    1652          * {@internal Missing Long Description}}
     1719         * Remove rewrite rules and then recreate rewrite rules.
     1720         *
     1721         * Calls {@link WP_Rewrite::wp_rewrite_rules()} after removing the
     1722         * 'rewrite_rules' option. If the function named 'save_mod_rewrite_rules'
     1723         * exists, it will be called.
    16531724         *
    16541725         * @since 2.0.1
     
    17031774
    17041775        /**
    1705          * {@internal Missing Short Description}}
    1706          *
    1707          * {@internal Missing Long Description}}
    1708          *
    1709          * @since 1.5.0
    1710          * @access public
    1711          *
    1712          * @param unknown_type $permalink_structure
     1776         * Set the main permalink structure for the blog.
     1777         *
     1778         * Will update the 'permalink_structure' option, if there is a difference
     1779         * between the current permalink structure and the parameter value. Calls
     1780         * {@link WP_Rewrite::init()} after the option is updated.
     1781         *
     1782         * @since 1.5.0
     1783         * @access public
     1784         *
     1785         * @param string $permalink_structure Permalink structure.
    17131786         */
    17141787        function set_permalink_structure($permalink_structure) {
     
    17201793
    17211794        /**
    1722          * {@internal Missing Short Description}}
    1723          *
    1724          * {@internal Missing Long Description}}
    1725          *
    1726          * @since 1.5.0
    1727          * @access public
    1728          *
    1729          * @param unknown_type $category_base
     1795         * Set the category base for the category permalink.
     1796         *
     1797         * Will update the 'category_base' option, if there is a difference between
     1798         * the current category base and the parameter value. Calls
     1799         * {@link WP_Rewrite::init()} after the option is updated.
     1800         *
     1801         * @since 1.5.0
     1802         * @access public
     1803         *
     1804         * @param string $category_base Category permalink structure base.
    17301805         */
    17311806        function set_category_base($category_base) {
     
    17371812
    17381813        /**
    1739          * {@internal Missing Short Description}}
    1740          *
    1741          * {@internal Missing Long Description}}
     1814         * Set the tag base for the tag permalink.
     1815         *
     1816         * Will update the 'tag_base' option, if there is a difference between the
     1817         * current tag base and the parameter value. Calls
     1818         * {@link WP_Rewrite::init()} after the option is updated.
    17421819         *
    17431820         * @since 2.3.0
    17441821         * @access public
    17451822         *
    1746          * @param unknown_type $tag_base
     1823         * @param string $tag_base Tag permalink structure base.
    17471824         */
    17481825        function set_tag_base( $tag_base ) {
     
    17541831
    17551832        /**
    1756          * {@internal Missing Short Description}}
    1757          *
    1758          * {@internal Missing Long Description}}
     1833         * PHP4 Constructor - Calls init(), which runs setup.
    17591834         *
    17601835         * @since 1.5.0
Note: See TracChangeset for help on using the changeset viewer.