Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like WP_Rewrite often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use WP_Rewrite, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 25 | class WP_Rewrite { |
||
| 26 | /** |
||
| 27 | * Permalink structure for posts. |
||
| 28 | * |
||
| 29 | * @since 1.5.0 |
||
| 30 | * @var string |
||
| 31 | */ |
||
| 32 | public $permalink_structure; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * Whether to add trailing slashes. |
||
| 36 | * |
||
| 37 | * @since 2.2.0 |
||
| 38 | * @var bool |
||
| 39 | */ |
||
| 40 | public $use_trailing_slashes; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Base for the author permalink structure (example.com/$author_base/authorname). |
||
| 44 | * |
||
| 45 | * @since 1.5.0 |
||
| 46 | * @access private |
||
| 47 | * @var string |
||
| 48 | */ |
||
| 49 | var $author_base = 'author'; |
||
| 50 | |||
| 51 | /** |
||
| 52 | * Permalink structure for author archives. |
||
| 53 | * |
||
| 54 | * @since 1.5.0 |
||
| 55 | * @access private |
||
| 56 | * @var string |
||
| 57 | */ |
||
| 58 | var $author_structure; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Permalink structure for date archives. |
||
| 62 | * |
||
| 63 | * @since 1.5.0 |
||
| 64 | * @access private |
||
| 65 | * @var string |
||
| 66 | */ |
||
| 67 | var $date_structure; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Permalink structure for pages. |
||
| 71 | * |
||
| 72 | * @since 1.5.0 |
||
| 73 | * @access private |
||
| 74 | * @var string |
||
| 75 | */ |
||
| 76 | var $page_structure; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Base of the search permalink structure (example.com/$search_base/query). |
||
| 80 | * |
||
| 81 | * @since 1.5.0 |
||
| 82 | * @access private |
||
| 83 | * @var string |
||
| 84 | */ |
||
| 85 | var $search_base = 'search'; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Permalink structure for searches. |
||
| 89 | * |
||
| 90 | * @since 1.5.0 |
||
| 91 | * @access private |
||
| 92 | * @var string |
||
| 93 | */ |
||
| 94 | var $search_structure; |
||
| 95 | |||
| 96 | /** |
||
| 97 | * Comments permalink base. |
||
| 98 | * |
||
| 99 | * @since 1.5.0 |
||
| 100 | * @access private |
||
| 101 | * @var string |
||
| 102 | */ |
||
| 103 | var $comments_base = 'comments'; |
||
| 104 | |||
| 105 | /** |
||
| 106 | * Pagination permalink base. |
||
| 107 | * |
||
| 108 | * @since 3.1.0 |
||
| 109 | * @var string |
||
| 110 | */ |
||
| 111 | public $pagination_base = 'page'; |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Comments pagination permalink base. |
||
| 115 | * |
||
| 116 | * @since 4.2.0 |
||
| 117 | * @access private |
||
| 118 | * @var string |
||
| 119 | */ |
||
| 120 | var $comments_pagination_base = 'comment-page'; |
||
| 121 | |||
| 122 | /** |
||
| 123 | * Feed permalink base. |
||
| 124 | * |
||
| 125 | * @since 1.5.0 |
||
| 126 | * @access private |
||
| 127 | * @var string |
||
| 128 | */ |
||
| 129 | var $feed_base = 'feed'; |
||
| 130 | |||
| 131 | /** |
||
| 132 | * Comments feed permalink structure. |
||
| 133 | * |
||
| 134 | * @since 1.5.0 |
||
| 135 | * @access private |
||
| 136 | * @var string |
||
| 137 | */ |
||
| 138 | var $comment_feed_structure; |
||
| 139 | |||
| 140 | /** |
||
| 141 | * Feed request permalink structure. |
||
| 142 | * |
||
| 143 | * @since 1.5.0 |
||
| 144 | * @access private |
||
| 145 | * @var string |
||
| 146 | */ |
||
| 147 | var $feed_structure; |
||
| 148 | |||
| 149 | /** |
||
| 150 | * The static portion of the post permalink structure. |
||
| 151 | * |
||
| 152 | * If the permalink structure is "/archive/%post_id%" then the front |
||
| 153 | * is "/archive/". If the permalink structure is "/%year%/%postname%/" |
||
| 154 | * then the front is "/". |
||
| 155 | * |
||
| 156 | * @since 1.5.0 |
||
| 157 | * @access public |
||
| 158 | * @var string |
||
| 159 | * |
||
| 160 | * @see WP_Rewrite::init() |
||
| 161 | */ |
||
| 162 | public $front; |
||
| 163 | |||
| 164 | /** |
||
| 165 | * The prefix for all permalink structures. |
||
| 166 | * |
||
| 167 | * If PATHINFO/index permalinks are in use then the root is the value of |
||
| 168 | * `WP_Rewrite::$index` with a trailing slash appended. Otherwise the root |
||
| 169 | * will be empty. |
||
| 170 | * |
||
| 171 | * @since 1.5.0 |
||
| 172 | * @access public |
||
| 173 | * @var string |
||
| 174 | * |
||
| 175 | * @see WP_Rewrite::init() |
||
| 176 | * @see WP_Rewrite::using_index_permalinks() |
||
| 177 | */ |
||
| 178 | public $root = ''; |
||
| 179 | |||
| 180 | /** |
||
| 181 | * The name of the index file which is the entry point to all requests. |
||
| 182 | * |
||
| 183 | * @since 1.5.0 |
||
| 184 | * @access public |
||
| 185 | * @var string |
||
| 186 | */ |
||
| 187 | public $index = 'index.php'; |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Variable name to use for regex matches in the rewritten query. |
||
| 191 | * |
||
| 192 | * @since 1.5.0 |
||
| 193 | * @access private |
||
| 194 | * @var string |
||
| 195 | */ |
||
| 196 | var $matches = ''; |
||
| 197 | |||
| 198 | /** |
||
| 199 | * Rewrite rules to match against the request to find the redirect or query. |
||
| 200 | * |
||
| 201 | * @since 1.5.0 |
||
| 202 | * @access private |
||
| 203 | * @var array |
||
| 204 | */ |
||
| 205 | var $rules; |
||
| 206 | |||
| 207 | /** |
||
| 208 | * Additional rules added external to the rewrite class. |
||
| 209 | * |
||
| 210 | * Those not generated by the class, see add_rewrite_rule(). |
||
| 211 | * |
||
| 212 | * @since 2.1.0 |
||
| 213 | * @access private |
||
| 214 | * @var array |
||
| 215 | */ |
||
| 216 | var $extra_rules = array(); |
||
| 217 | |||
| 218 | /** |
||
| 219 | * Additional rules that belong at the beginning to match first. |
||
| 220 | * |
||
| 221 | * Those not generated by the class, see add_rewrite_rule(). |
||
| 222 | * |
||
| 223 | * @since 2.3.0 |
||
| 224 | * @access private |
||
| 225 | * @var array |
||
| 226 | */ |
||
| 227 | var $extra_rules_top = array(); |
||
| 228 | |||
| 229 | /** |
||
| 230 | * Rules that don't redirect to WordPress' index.php. |
||
| 231 | * |
||
| 232 | * These rules are written to the mod_rewrite portion of the .htaccess, |
||
| 233 | * and are added by add_external_rule(). |
||
| 234 | * |
||
| 235 | * @since 2.1.0 |
||
| 236 | * @access private |
||
| 237 | * @var array |
||
| 238 | */ |
||
| 239 | var $non_wp_rules = array(); |
||
| 240 | |||
| 241 | /** |
||
| 242 | * Extra permalink structures, e.g. categories, added by add_permastruct(). |
||
| 243 | * |
||
| 244 | * @since 2.1.0 |
||
| 245 | * @access private |
||
| 246 | * @var array |
||
| 247 | */ |
||
| 248 | var $extra_permastructs = array(); |
||
| 249 | |||
| 250 | /** |
||
| 251 | * Endpoints (like /trackback/) added by add_rewrite_endpoint(). |
||
| 252 | * |
||
| 253 | * @since 2.1.0 |
||
| 254 | * @access private |
||
| 255 | * @var array |
||
| 256 | */ |
||
| 257 | var $endpoints; |
||
| 258 | |||
| 259 | /** |
||
| 260 | * Whether to write every mod_rewrite rule for WordPress into the .htaccess file. |
||
| 261 | * |
||
| 262 | * This is off by default, turning it on might print a lot of rewrite rules |
||
| 263 | * to the .htaccess file. |
||
| 264 | * |
||
| 265 | * @since 2.0.0 |
||
| 266 | * @access public |
||
| 267 | * @var bool |
||
| 268 | * |
||
| 269 | * @see WP_Rewrite::mod_rewrite_rules() |
||
| 270 | */ |
||
| 271 | public $use_verbose_rules = false; |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Could post permalinks be confused with those of pages? |
||
| 275 | * |
||
| 276 | * If the first rewrite tag in the post permalink structure is one that could |
||
| 277 | * also match a page name (e.g. %postname% or %author%) then this flag is |
||
| 278 | * set to true. Prior to WordPress 3.3 this flag indicated that every page |
||
| 279 | * would have a set of rules added to the top of the rewrite rules array. |
||
| 280 | * Now it tells WP::parse_request() to check if a URL matching the page |
||
| 281 | * permastruct is actually a page before accepting it. |
||
| 282 | * |
||
| 283 | * @since 2.5.0 |
||
| 284 | * @access public |
||
| 285 | * @var bool |
||
| 286 | * |
||
| 287 | * @see WP_Rewrite::init() |
||
| 288 | */ |
||
| 289 | public $use_verbose_page_rules = true; |
||
| 290 | |||
| 291 | /** |
||
| 292 | * Rewrite tags that can be used in permalink structures. |
||
| 293 | * |
||
| 294 | * These are translated into the regular expressions stored in |
||
| 295 | * `WP_Rewrite::$rewritereplace` and are rewritten to the query |
||
| 296 | * variables listed in WP_Rewrite::$queryreplace. |
||
| 297 | * |
||
| 298 | * Additional tags can be added with add_rewrite_tag(). |
||
| 299 | * |
||
| 300 | * @since 1.5.0 |
||
| 301 | * @access private |
||
| 302 | * @var array |
||
| 303 | */ |
||
| 304 | var $rewritecode = array( |
||
| 305 | '%year%', |
||
| 306 | '%monthnum%', |
||
| 307 | '%day%', |
||
| 308 | '%hour%', |
||
| 309 | '%minute%', |
||
| 310 | '%second%', |
||
| 311 | '%postname%', |
||
| 312 | '%post_id%', |
||
| 313 | '%author%', |
||
| 314 | '%pagename%', |
||
| 315 | '%search%' |
||
| 316 | ); |
||
| 317 | |||
| 318 | /** |
||
| 319 | * Regular expressions to be substituted into rewrite rules in place |
||
| 320 | * of rewrite tags, see WP_Rewrite::$rewritecode. |
||
| 321 | * |
||
| 322 | * @since 1.5.0 |
||
| 323 | * @access private |
||
| 324 | * @var array |
||
| 325 | */ |
||
| 326 | var $rewritereplace = array( |
||
| 327 | '([0-9]{4})', |
||
| 328 | '([0-9]{1,2})', |
||
| 329 | '([0-9]{1,2})', |
||
| 330 | '([0-9]{1,2})', |
||
| 331 | '([0-9]{1,2})', |
||
| 332 | '([0-9]{1,2})', |
||
| 333 | '([^/]+)', |
||
| 334 | '([0-9]+)', |
||
| 335 | '([^/]+)', |
||
| 336 | '([^/]+?)', |
||
| 337 | '(.+)' |
||
| 338 | ); |
||
| 339 | |||
| 340 | /** |
||
| 341 | * Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode. |
||
| 342 | * |
||
| 343 | * @since 1.5.0 |
||
| 344 | * @access private |
||
| 345 | * @var array |
||
| 346 | */ |
||
| 347 | var $queryreplace = array( |
||
| 348 | 'year=', |
||
| 349 | 'monthnum=', |
||
| 350 | 'day=', |
||
| 351 | 'hour=', |
||
| 352 | 'minute=', |
||
| 353 | 'second=', |
||
| 354 | 'name=', |
||
| 355 | 'p=', |
||
| 356 | 'author_name=', |
||
| 357 | 'pagename=', |
||
| 358 | 's=' |
||
| 359 | ); |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Supported default feeds. |
||
| 363 | * |
||
| 364 | * @since 1.5.0 |
||
| 365 | * @var array |
||
| 366 | */ |
||
| 367 | public $feeds = array( 'feed', 'rdf', 'rss', 'rss2', 'atom' ); |
||
| 368 | |||
| 369 | /** |
||
| 370 | * Determines whether permalinks are being used. |
||
| 371 | * |
||
| 372 | * This can be either rewrite module or permalink in the HTTP query string. |
||
| 373 | * |
||
| 374 | * @since 1.5.0 |
||
| 375 | * @access public |
||
| 376 | * |
||
| 377 | * @return bool True, if permalinks are enabled. |
||
| 378 | */ |
||
| 379 | public function using_permalinks() { |
||
| 382 | |||
| 383 | /** |
||
| 384 | * Determines whether permalinks are being used and rewrite module is not enabled. |
||
| 385 | * |
||
| 386 | * Means that permalink links are enabled and index.php is in the URL. |
||
| 387 | * |
||
| 388 | * @since 1.5.0 |
||
| 389 | * @access public |
||
| 390 | * |
||
| 391 | * @return bool Whether permalink links are enabled and index.php is in the URL. |
||
|
|
|||
| 392 | */ |
||
| 393 | public function using_index_permalinks() { |
||
| 401 | |||
| 402 | /** |
||
| 403 | * Determines whether permalinks are being used and rewrite module is enabled. |
||
| 404 | * |
||
| 405 | * Using permalinks and index.php is not in the URL. |
||
| 406 | * |
||
| 407 | * @since 1.5.0 |
||
| 408 | * @access public |
||
| 409 | * |
||
| 410 | * @return bool Whether permalink links are enabled and index.php is NOT in the URL. |
||
| 411 | */ |
||
| 412 | public function using_mod_rewrite_permalinks() { |
||
| 415 | |||
| 416 | /** |
||
| 417 | * Indexes for matches for usage in preg_*() functions. |
||
| 418 | * |
||
| 419 | * The format of the string is, with empty matches property value, '$NUM'. |
||
| 420 | * The 'NUM' will be replaced with the value in the $number parameter. With |
||
| 421 | * the matches property not empty, the value of the returned string will |
||
| 422 | * contain that value of the matches property. The format then will be |
||
| 423 | * '$MATCHES[NUM]', with MATCHES as the value in the property and NUM the |
||
| 424 | * value of the $number parameter. |
||
| 425 | * |
||
| 426 | * @since 1.5.0 |
||
| 427 | * @access public |
||
| 428 | * |
||
| 429 | * @param int $number Index number. |
||
| 430 | * @return string |
||
| 431 | */ |
||
| 432 | public function preg_index($number) { |
||
| 443 | |||
| 444 | /** |
||
| 445 | * Retrieves all page and attachments for pages URIs. |
||
| 446 | * |
||
| 447 | * The attachments are for those that have pages as parents and will be |
||
| 448 | * retrieved. |
||
| 449 | * |
||
| 450 | * @since 2.5.0 |
||
| 451 | * @access public |
||
| 452 | * |
||
| 453 | * @global wpdb $wpdb WordPress database abstraction object. |
||
| 454 | * |
||
| 455 | * @return array Array of page URIs as first element and attachment URIs as second element. |
||
| 456 | */ |
||
| 457 | public function page_uri_index() { |
||
| 490 | |||
| 491 | /** |
||
| 492 | * Retrieves all of the rewrite rules for pages. |
||
| 493 | * |
||
| 494 | * @since 1.5.0 |
||
| 495 | * @access public |
||
| 496 | * |
||
| 497 | * @return array Page rewrite rules. |
||
| 498 | */ |
||
| 499 | public function page_rewrite_rules() { |
||
| 505 | |||
| 506 | /** |
||
| 507 | * Retrieves date permalink structure, with year, month, and day. |
||
| 508 | * |
||
| 509 | * The permalink structure for the date, if not set already depends on the |
||
| 510 | * permalink structure. It can be one of three formats. The first is year, |
||
| 511 | * month, day; the second is day, month, year; and the last format is month, |
||
| 512 | * day, year. These are matched against the permalink structure for which |
||
| 513 | * one is used. If none matches, then the default will be used, which is |
||
| 514 | * year, month, day. |
||
| 515 | * |
||
| 516 | * Prevents post ID and date permalinks from overlapping. In the case of |
||
| 517 | * post_id, the date permalink will be prepended with front permalink with |
||
| 518 | * 'date/' before the actual permalink to form the complete date permalink |
||
| 519 | * structure. |
||
| 520 | * |
||
| 521 | * @since 1.5.0 |
||
| 522 | * @access public |
||
| 523 | * |
||
| 524 | * @return string|false False on no permalink structure. Date permalink structure. |
||
| 525 | */ |
||
| 526 | public function get_date_permastruct() { |
||
| 570 | |||
| 571 | /** |
||
| 572 | * Retrieves the year permalink structure without month and day. |
||
| 573 | * |
||
| 574 | * Gets the date permalink structure and strips out the month and day |
||
| 575 | * permalink structures. |
||
| 576 | * |
||
| 577 | * @since 1.5.0 |
||
| 578 | * @access public |
||
| 579 | * |
||
| 580 | * @return false|string False on failure. Year structure on success. |
||
| 581 | */ |
||
| 582 | public function get_year_permastruct() { |
||
| 594 | |||
| 595 | /** |
||
| 596 | * Retrieves the month permalink structure without day and with year. |
||
| 597 | * |
||
| 598 | * Gets the date permalink structure and strips out the day permalink |
||
| 599 | * structures. Keeps the year permalink structure. |
||
| 600 | * |
||
| 601 | * @since 1.5.0 |
||
| 602 | * @access public |
||
| 603 | * |
||
| 604 | * @return false|string False on failure. Year/Month structure on success. |
||
| 605 | */ |
||
| 606 | public function get_month_permastruct() { |
||
| 617 | |||
| 618 | /** |
||
| 619 | * Retrieves the day permalink structure with month and year. |
||
| 620 | * |
||
| 621 | * Keeps date permalink structure with all year, month, and day. |
||
| 622 | * |
||
| 623 | * @since 1.5.0 |
||
| 624 | * @access public |
||
| 625 | * |
||
| 626 | * @return string|false False on failure. Year/Month/Day structure on success. |
||
| 627 | */ |
||
| 628 | public function get_day_permastruct() { |
||
| 631 | |||
| 632 | /** |
||
| 633 | * Retrieves the permalink structure for categories. |
||
| 634 | * |
||
| 635 | * If the category_base property has no value, then the category structure |
||
| 636 | * will have the front property value, followed by 'category', and finally |
||
| 637 | * '%category%'. If it does, then the root property will be used, along with |
||
| 638 | * the category_base property value. |
||
| 639 | * |
||
| 640 | * @since 1.5.0 |
||
| 641 | * @access public |
||
| 642 | * |
||
| 643 | * @return string|false False on failure. Category permalink structure. |
||
| 644 | */ |
||
| 645 | public function get_category_permastruct() { |
||
| 648 | |||
| 649 | /** |
||
| 650 | * Retrieve the permalink structure for tags. |
||
| 651 | * |
||
| 652 | * If the tag_base property has no value, then the tag structure will have |
||
| 653 | * the front property value, followed by 'tag', and finally '%tag%'. If it |
||
| 654 | * does, then the root property will be used, along with the tag_base |
||
| 655 | * property value. |
||
| 656 | * |
||
| 657 | * @since 2.3.0 |
||
| 658 | * @access public |
||
| 659 | * |
||
| 660 | * @return string|false False on failure. Tag permalink structure. |
||
| 661 | */ |
||
| 662 | public function get_tag_permastruct() { |
||
| 665 | |||
| 666 | /** |
||
| 667 | * Retrieves an extra permalink structure by name. |
||
| 668 | * |
||
| 669 | * @since 2.5.0 |
||
| 670 | * @access public |
||
| 671 | * |
||
| 672 | * @param string $name Permalink structure name. |
||
| 673 | * @return string|false False if not found. Permalink structure string. |
||
| 674 | */ |
||
| 675 | public function get_extra_permastruct($name) { |
||
| 684 | |||
| 685 | /** |
||
| 686 | * Retrieves the author permalink structure. |
||
| 687 | * |
||
| 688 | * The permalink structure is front property, author base, and finally |
||
| 689 | * '/%author%'. Will set the author_structure property and then return it |
||
| 690 | * without attempting to set the value again. |
||
| 691 | * |
||
| 692 | * @since 1.5.0 |
||
| 693 | * @access public |
||
| 694 | * |
||
| 695 | * @return string|false False if not found. Permalink structure string. |
||
| 696 | */ |
||
| 697 | View Code Duplication | public function get_author_permastruct() { |
|
| 710 | |||
| 711 | /** |
||
| 712 | * Retrieves the search permalink structure. |
||
| 713 | * |
||
| 714 | * The permalink structure is root property, search base, and finally |
||
| 715 | * '/%search%'. Will set the search_structure property and then return it |
||
| 716 | * without attempting to set the value again. |
||
| 717 | * |
||
| 718 | * @since 1.5.0 |
||
| 719 | * @access public |
||
| 720 | * |
||
| 721 | * @return string|false False if not found. Permalink structure string. |
||
| 722 | */ |
||
| 723 | View Code Duplication | public function get_search_permastruct() { |
|
| 736 | |||
| 737 | /** |
||
| 738 | * Retrieves the page permalink structure. |
||
| 739 | * |
||
| 740 | * The permalink structure is root property, and '%pagename%'. Will set the |
||
| 741 | * page_structure property and then return it without attempting to set the |
||
| 742 | * value again. |
||
| 743 | * |
||
| 744 | * @since 1.5.0 |
||
| 745 | * @access public |
||
| 746 | * |
||
| 747 | * @return string|false False if not found. Permalink structure string. |
||
| 748 | */ |
||
| 749 | public function get_page_permastruct() { |
||
| 762 | |||
| 763 | /** |
||
| 764 | * Retrieves the feed permalink structure. |
||
| 765 | * |
||
| 766 | * The permalink structure is root property, feed base, and finally |
||
| 767 | * '/%feed%'. Will set the feed_structure property and then return it |
||
| 768 | * without attempting to set the value again. |
||
| 769 | * |
||
| 770 | * @since 1.5.0 |
||
| 771 | * @access public |
||
| 772 | * |
||
| 773 | * @return string|false False if not found. Permalink structure string. |
||
| 774 | */ |
||
| 775 | View Code Duplication | public function get_feed_permastruct() { |
|
| 788 | |||
| 789 | /** |
||
| 790 | * Retrieves the comment feed permalink structure. |
||
| 791 | * |
||
| 792 | * The permalink structure is root property, comment base property, feed |
||
| 793 | * base and finally '/%feed%'. Will set the comment_feed_structure property |
||
| 794 | * and then return it without attempting to set the value again. |
||
| 795 | * |
||
| 796 | * @since 1.5.0 |
||
| 797 | * @access public |
||
| 798 | * |
||
| 799 | * @return string|false False if not found. Permalink structure string. |
||
| 800 | */ |
||
| 801 | View Code Duplication | public function get_comment_feed_permastruct() { |
|
| 814 | |||
| 815 | /** |
||
| 816 | * Adds or updates existing rewrite tags (e.g. %postname%). |
||
| 817 | * |
||
| 818 | * If the tag already exists, replace the existing pattern and query for |
||
| 819 | * that tag, otherwise add the new tag. |
||
| 820 | * |
||
| 821 | * @since 1.5.0 |
||
| 822 | * @access public |
||
| 823 | * |
||
| 824 | * @see WP_Rewrite::$rewritecode |
||
| 825 | * @see WP_Rewrite::$rewritereplace |
||
| 826 | * @see WP_Rewrite::$queryreplace |
||
| 827 | * |
||
| 828 | * @param string $tag Name of the rewrite tag to add or update. |
||
| 829 | * @param string $regex Regular expression to substitute the tag for in rewrite rules. |
||
| 830 | * @param string $query String to append to the rewritten query. Must end in '='. |
||
| 831 | */ |
||
| 832 | public function add_rewrite_tag( $tag, $regex, $query ) { |
||
| 843 | |||
| 844 | |||
| 845 | /** |
||
| 846 | * Removes an existing rewrite tag. |
||
| 847 | * |
||
| 848 | * @since 4.5.0 |
||
| 849 | * @access public |
||
| 850 | * |
||
| 851 | * @see WP_Rewrite::$rewritecode |
||
| 852 | * @see WP_Rewrite::$rewritereplace |
||
| 853 | * @see WP_Rewrite::$queryreplace |
||
| 854 | * |
||
| 855 | * @param string $tag Name of the rewrite tag to remove. |
||
| 856 | */ |
||
| 857 | public function remove_rewrite_tag( $tag ) { |
||
| 858 | $position = array_search( $tag, $this->rewritecode ); |
||
| 859 | if ( false !== $position && null !== $position ) { |
||
| 860 | unset( $this->rewritecode[ $position ] ); |
||
| 861 | unset( $this->rewritereplace[ $position ] ); |
||
| 862 | unset( $this->queryreplace[ $position ] ); |
||
| 863 | } |
||
| 864 | } |
||
| 865 | |||
| 866 | /** |
||
| 867 | * Generates rewrite rules from a permalink structure. |
||
| 868 | * |
||
| 869 | * The main WP_Rewrite function for building the rewrite rule list. The |
||
| 870 | * contents of the function is a mix of black magic and regular expressions, |
||
| 871 | * so best just ignore the contents and move to the parameters. |
||
| 872 | * |
||
| 873 | * @since 1.5.0 |
||
| 874 | * @access public |
||
| 875 | * |
||
| 876 | * @param string $permalink_structure The permalink structure. |
||
| 877 | * @param int $ep_mask Optional. Endpoint mask defining what endpoints are added to the structure. |
||
| 878 | * Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`, |
||
| 879 | * `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`, |
||
| 880 | * `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`. |
||
| 881 | * Default `EP_NONE`. |
||
| 882 | * @param bool $paged Optional. Whether archive pagination rules should be added for the structure. |
||
| 883 | * Default true. |
||
| 884 | * @param bool $feed Optional Whether feed rewrite rules should be added for the structure. |
||
| 885 | * Default true. |
||
| 886 | * @param bool $forcomments Optional. Whether the feed rules should be a query for a comments feed. |
||
| 887 | * Default false. |
||
| 888 | * @param bool $walk_dirs Optional. Whether the 'directories' making up the structure should be walked |
||
| 889 | * over and rewrite rules built for each in-turn. Default true. |
||
| 890 | * @param bool $endpoints Optional. Whether endpoints should be applied to the generated rewrite rules. |
||
| 891 | * Default true. |
||
| 892 | * @return array Rewrite rule list. |
||
| 893 | */ |
||
| 894 | public function generate_rewrite_rules($permalink_structure, $ep_mask = EP_NONE, $paged = true, $feed = true, $forcomments = false, $walk_dirs = true, $endpoints = true) { |
||
| 1231 | |||
| 1232 | /** |
||
| 1233 | * Generates rewrite rules with permalink structure and walking directory only. |
||
| 1234 | * |
||
| 1235 | * Shorten version of WP_Rewrite::generate_rewrite_rules() that allows for shorter |
||
| 1236 | * list of parameters. See the method for longer description of what generating |
||
| 1237 | * rewrite rules does. |
||
| 1238 | * |
||
| 1239 | * @since 1.5.0 |
||
| 1240 | * @access public |
||
| 1241 | * |
||
| 1242 | * @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters. |
||
| 1243 | * |
||
| 1244 | * @param string $permalink_structure The permalink structure to generate rules. |
||
| 1245 | * @param bool $walk_dirs Optional, default is false. Whether to create list of directories to walk over. |
||
| 1246 | * @return array |
||
| 1247 | */ |
||
| 1248 | public function generate_rewrite_rule($permalink_structure, $walk_dirs = false) { |
||
| 1251 | |||
| 1252 | /** |
||
| 1253 | * Constructs rewrite matches and queries from permalink structure. |
||
| 1254 | * |
||
| 1255 | * Runs the action {@see 'generate_rewrite_rules'} with the parameter that is an |
||
| 1256 | * reference to the current WP_Rewrite instance to further manipulate the |
||
| 1257 | * permalink structures and rewrite rules. Runs the {@see 'rewrite_rules_array'} |
||
| 1258 | * filter on the full rewrite rule array. |
||
| 1259 | * |
||
| 1260 | * There are two ways to manipulate the rewrite rules, one by hooking into |
||
| 1261 | * the {@see 'generate_rewrite_rules'} action and gaining full control of the |
||
| 1262 | * object or just manipulating the rewrite rule array before it is passed |
||
| 1263 | * from the function. |
||
| 1264 | * |
||
| 1265 | * @since 1.5.0 |
||
| 1266 | * @access public |
||
| 1267 | * |
||
| 1268 | * @return array An associate array of matches and queries. |
||
| 1269 | */ |
||
| 1270 | public function rewrite_rules() { |
||
| 1459 | |||
| 1460 | /** |
||
| 1461 | * Retrieves the rewrite rules. |
||
| 1462 | * |
||
| 1463 | * The difference between this method and WP_Rewrite::rewrite_rules() is that |
||
| 1464 | * this method stores the rewrite rules in the 'rewrite_rules' option and retrieves |
||
| 1465 | * it. This prevents having to process all of the permalinks to get the rewrite rules |
||
| 1466 | * in the form of caching. |
||
| 1467 | * |
||
| 1468 | * @since 1.5.0 |
||
| 1469 | * @access public |
||
| 1470 | * |
||
| 1471 | * @return array Rewrite rules. |
||
| 1472 | */ |
||
| 1473 | public function wp_rewrite_rules() { |
||
| 1487 | |||
| 1488 | /** |
||
| 1489 | * Retrieves mod_rewrite-formatted rewrite rules to write to .htaccess. |
||
| 1490 | * |
||
| 1491 | * Does not actually write to the .htaccess file, but creates the rules for |
||
| 1492 | * the process that will. |
||
| 1493 | * |
||
| 1494 | * Will add the non_wp_rules property rules to the .htaccess file before |
||
| 1495 | * the WordPress rewrite rules one. |
||
| 1496 | * |
||
| 1497 | * @since 1.5.0 |
||
| 1498 | * @access public |
||
| 1499 | * |
||
| 1500 | * @return string |
||
| 1501 | */ |
||
| 1502 | public function mod_rewrite_rules() { |
||
| 1575 | |||
| 1576 | /** |
||
| 1577 | * Retrieves IIS7 URL Rewrite formatted rewrite rules to write to web.config file. |
||
| 1578 | * |
||
| 1579 | * Does not actually write to the web.config file, but creates the rules for |
||
| 1580 | * the process that will. |
||
| 1581 | * |
||
| 1582 | * @since 2.8.0 |
||
| 1583 | * @access public |
||
| 1584 | * |
||
| 1585 | * @param bool $add_parent_tags Optional. Whether to add parent tags to the rewrite rule sets. |
||
| 1586 | * Default false. |
||
| 1587 | * @return string IIS7 URL rewrite rule sets. |
||
| 1588 | */ |
||
| 1589 | public function iis7_url_rewrite_rules( $add_parent_tags = false ) { |
||
| 1627 | |||
| 1628 | /** |
||
| 1629 | * Adds a rewrite rule that transforms a URL structure to a set of query vars. |
||
| 1630 | * |
||
| 1631 | * Any value in the $after parameter that isn't 'bottom' will result in the rule |
||
| 1632 | * being placed at the top of the rewrite rules. |
||
| 1633 | * |
||
| 1634 | * @since 2.1.0 |
||
| 1635 | * @since 4.4.0 Array support was added to the `$query` parameter. |
||
| 1636 | * @access public |
||
| 1637 | * |
||
| 1638 | * @param string $regex Regular expression to match request against. |
||
| 1639 | * @param string|array $query The corresponding query vars for this rewrite rule. |
||
| 1640 | * @param string $after Optional. Priority of the new rule. Accepts 'top' |
||
| 1641 | * or 'bottom'. Default 'bottom'. |
||
| 1642 | */ |
||
| 1643 | public function add_rule( $regex, $query, $after = 'bottom' ) { |
||
| 1665 | |||
| 1666 | /** |
||
| 1667 | * Adds a rewrite rule that doesn't correspond to index.php. |
||
| 1668 | * |
||
| 1669 | * @since 2.1.0 |
||
| 1670 | * @access public |
||
| 1671 | * |
||
| 1672 | * @param string $regex Regular expression to match request against. |
||
| 1673 | * @param string $query The corresponding query vars for this rewrite rule. |
||
| 1674 | */ |
||
| 1675 | public function add_external_rule( $regex, $query ) { |
||
| 1678 | |||
| 1679 | /** |
||
| 1680 | * Adds an endpoint, like /trackback/. |
||
| 1681 | * |
||
| 1682 | * @since 2.1.0 |
||
| 1683 | * @since 3.9.0 $query_var parameter added. |
||
| 1684 | * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`. |
||
| 1685 | * @access public |
||
| 1686 | * |
||
| 1687 | * @see add_rewrite_endpoint() for full documentation. |
||
| 1688 | * @global WP $wp |
||
| 1689 | * |
||
| 1690 | * @param string $name Name of the endpoint. |
||
| 1691 | * @param int $places Endpoint mask describing the places the endpoint should be added. |
||
| 1692 | * @param string|bool $query_var Optional. Name of the corresponding query variable. Pass `false` to |
||
| 1693 | * skip registering a query_var for this endpoint. Defaults to the |
||
| 1694 | * value of `$name`. |
||
| 1695 | */ |
||
| 1696 | public function add_endpoint( $name, $places, $query_var = true ) { |
||
| 1709 | |||
| 1710 | /** |
||
| 1711 | * Adds a new permalink structure. |
||
| 1712 | * |
||
| 1713 | * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules; |
||
| 1714 | * it is an easy way of expressing a set of regular expressions that rewrite to a set of |
||
| 1715 | * query strings. The new permastruct is added to the WP_Rewrite::$extra_permastructs array. |
||
| 1716 | * |
||
| 1717 | * When the rewrite rules are built by WP_Rewrite::rewrite_rules(), all of these extra |
||
| 1718 | * permastructs are passed to WP_Rewrite::generate_rewrite_rules() which transforms them |
||
| 1719 | * into the regular expressions that many love to hate. |
||
| 1720 | * |
||
| 1721 | * The `$args` parameter gives you control over how WP_Rewrite::generate_rewrite_rules() |
||
| 1722 | * works on the new permastruct. |
||
| 1723 | * |
||
| 1724 | * @since 2.5.0 |
||
| 1725 | * @access public |
||
| 1726 | * |
||
| 1727 | * @param string $name Name for permalink structure. |
||
| 1728 | * @param string $struct Permalink structure (e.g. category/%category%) |
||
| 1729 | * @param array $args { |
||
| 1730 | * Optional. Arguments for building rewrite rules based on the permalink structure. |
||
| 1731 | * Default empty array. |
||
| 1732 | * |
||
| 1733 | * @type bool $with_front Whether the structure should be prepended with `WP_Rewrite::$front`. |
||
| 1734 | * Default true. |
||
| 1735 | * @type int $ep_mask The endpoint mask defining which endpoints are added to the structure. |
||
| 1736 | * Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`, |
||
| 1737 | * `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`, |
||
| 1738 | * `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`. |
||
| 1739 | * Default `EP_NONE`. |
||
| 1740 | * @type bool $paged Whether archive pagination rules should be added for the structure. |
||
| 1741 | * Default true. |
||
| 1742 | * @type bool $feed Whether feed rewrite rules should be added for the structure. Default true. |
||
| 1743 | * @type bool $forcomments Whether the feed rules should be a query for a comments feed. Default false. |
||
| 1744 | * @type bool $walk_dirs Whether the 'directories' making up the structure should be walked over |
||
| 1745 | * and rewrite rules built for each in-turn. Default true. |
||
| 1746 | * @type bool $endpoints Whether endpoints should be applied to the generated rules. Default true. |
||
| 1747 | * } |
||
| 1748 | */ |
||
| 1749 | public function add_permastruct( $name, $struct, $args = array() ) { |
||
| 1776 | |||
| 1777 | /** |
||
| 1778 | * Removes a permalink structure. |
||
| 1779 | * |
||
| 1780 | * @since 4.5.0 |
||
| 1781 | * @access public |
||
| 1782 | * |
||
| 1783 | * @param string $name Name for permalink structure. |
||
| 1784 | */ |
||
| 1785 | public function remove_permastruct( $name ) { |
||
| 1786 | unset( $this->extra_permastructs[ $name ] ); |
||
| 1787 | } |
||
| 1788 | |||
| 1789 | /** |
||
| 1790 | * Removes rewrite rules and then recreate rewrite rules. |
||
| 1791 | * |
||
| 1792 | * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option. |
||
| 1793 | * If the function named 'save_mod_rewrite_rules' exists, it will be called. |
||
| 1794 | * |
||
| 1795 | * @since 2.0.1 |
||
| 1796 | * @access public |
||
| 1797 | * |
||
| 1798 | * @staticvar bool $do_hard_later |
||
| 1799 | * |
||
| 1800 | * @param bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard). |
||
| 1801 | */ |
||
| 1802 | public function flush_rules( $hard = true ) { |
||
| 1837 | |||
| 1838 | /** |
||
| 1839 | * Sets up the object's properties. |
||
| 1840 | * |
||
| 1841 | * The 'use_verbose_page_rules' object property will be set to true if the |
||
| 1842 | * permalink structure begins with one of the following: '%postname%', '%category%', |
||
| 1843 | * '%tag%', or '%author%'. |
||
| 1844 | * |
||
| 1845 | * @since 1.5.0 |
||
| 1846 | * @access public |
||
| 1847 | */ |
||
| 1848 | public function init() { |
||
| 1871 | |||
| 1872 | /** |
||
| 1873 | * Sets the main permalink structure for the site. |
||
| 1874 | * |
||
| 1875 | * Will update the 'permalink_structure' option, if there is a difference |
||
| 1876 | * between the current permalink structure and the parameter value. Calls |
||
| 1877 | * WP_Rewrite::init() after the option is updated. |
||
| 1878 | * |
||
| 1879 | * Fires the {@see 'permalink_structure_changed'} action once the init call has |
||
| 1880 | * processed passing the old and new values |
||
| 1881 | * |
||
| 1882 | * @since 1.5.0 |
||
| 1883 | * @access public |
||
| 1884 | * |
||
| 1885 | * @param string $permalink_structure Permalink structure. |
||
| 1886 | */ |
||
| 1887 | public function set_permalink_structure($permalink_structure) { |
||
| 1905 | |||
| 1906 | /** |
||
| 1907 | * Sets the category base for the category permalink. |
||
| 1908 | * |
||
| 1909 | * Will update the 'category_base' option, if there is a difference between |
||
| 1910 | * the current category base and the parameter value. Calls WP_Rewrite::init() |
||
| 1911 | * after the option is updated. |
||
| 1912 | * |
||
| 1913 | * @since 1.5.0 |
||
| 1914 | * @access public |
||
| 1915 | * |
||
| 1916 | * @param string $category_base Category permalink structure base. |
||
| 1917 | */ |
||
| 1918 | public function set_category_base($category_base) { |
||
| 1924 | |||
| 1925 | /** |
||
| 1926 | * Sets the tag base for the tag permalink. |
||
| 1927 | * |
||
| 1928 | * Will update the 'tag_base' option, if there is a difference between the |
||
| 1929 | * current tag base and the parameter value. Calls WP_Rewrite::init() after |
||
| 1930 | * the option is updated. |
||
| 1931 | * |
||
| 1932 | * @since 2.3.0 |
||
| 1933 | * @access public |
||
| 1934 | * |
||
| 1935 | * @param string $tag_base Tag permalink structure base. |
||
| 1936 | */ |
||
| 1937 | public function set_tag_base( $tag_base ) { |
||
| 1943 | |||
| 1944 | /** |
||
| 1945 | * Constructor - Calls init(), which runs setup. |
||
| 1946 | * |
||
| 1947 | * @since 1.5.0 |
||
| 1948 | * @access public |
||
| 1949 | * |
||
| 1950 | */ |
||
| 1951 | public function __construct() { |
||
| 1954 | } |
||
| 1955 |
This check compares the return type specified in the
@returnannotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.