| [ Index ] |
PHP Cross Reference of WordPress |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * WordPress Rewrite API 4 * 5 * @package WordPress 6 * @subpackage Rewrite 7 */ 8 9 /** 10 * Endpoint mask that matches nothing. 11 * 12 * @since 2.1.0 13 */ 14 define( 'EP_NONE', 0 ); 15 16 /** 17 * Endpoint mask that matches post permalinks. 18 * 19 * @since 2.1.0 20 */ 21 define( 'EP_PERMALINK', 1 ); 22 23 /** 24 * Endpoint mask that matches attachment permalinks. 25 * 26 * @since 2.1.0 27 */ 28 define( 'EP_ATTACHMENT', 2 ); 29 30 /** 31 * Endpoint mask that matches any date archives. 32 * 33 * @since 2.1.0 34 */ 35 define( 'EP_DATE', 4 ); 36 37 /** 38 * Endpoint mask that matches yearly archives. 39 * 40 * @since 2.1.0 41 */ 42 define( 'EP_YEAR', 8 ); 43 44 /** 45 * Endpoint mask that matches monthly archives. 46 * 47 * @since 2.1.0 48 */ 49 define( 'EP_MONTH', 16 ); 50 51 /** 52 * Endpoint mask that matches daily archives. 53 * 54 * @since 2.1.0 55 */ 56 define( 'EP_DAY', 32 ); 57 58 /** 59 * Endpoint mask that matches the site root. 60 * 61 * @since 2.1.0 62 */ 63 define( 'EP_ROOT', 64 ); 64 65 /** 66 * Endpoint mask that matches comment feeds. 67 * 68 * @since 2.1.0 69 */ 70 define( 'EP_COMMENTS', 128 ); 71 72 /** 73 * Endpoint mask that matches searches. 74 * 75 * Note that this only matches a search at a "pretty" URL such as 76 * `/search/my-search-term`, not `?s=my-search-term`. 77 * 78 * @since 2.1.0 79 */ 80 define( 'EP_SEARCH', 256 ); 81 82 /** 83 * Endpoint mask that matches category archives. 84 * 85 * @since 2.1.0 86 */ 87 define( 'EP_CATEGORIES', 512 ); 88 89 /** 90 * Endpoint mask that matches tag archives. 91 * 92 * @since 2.3.0 93 */ 94 define( 'EP_TAGS', 1024 ); 95 96 /** 97 * Endpoint mask that matches author archives. 98 * 99 * @since 2.1.0 100 */ 101 define( 'EP_AUTHORS', 2048 ); 102 103 /** 104 * Endpoint mask that matches pages. 105 * 106 * @since 2.1.0 107 */ 108 define( 'EP_PAGES', 4096 ); 109 110 /** 111 * Endpoint mask that matches all archive views. 112 * 113 * @since 3.7.0 114 */ 115 define( 'EP_ALL_ARCHIVES', EP_DATE | EP_YEAR | EP_MONTH | EP_DAY | EP_CATEGORIES | EP_TAGS | EP_AUTHORS ); 116 117 /** 118 * Endpoint mask that matches everything. 119 * 120 * @since 2.1.0 121 */ 122 define( 'EP_ALL', EP_PERMALINK | EP_ATTACHMENT | EP_ROOT | EP_COMMENTS | EP_SEARCH | EP_PAGES | EP_ALL_ARCHIVES ); 123 124 /** 125 * Adds a rewrite rule that transforms a URL structure to a set of query vars. 126 * 127 * Any value in the $after parameter that isn't 'bottom' will result in the rule 128 * being placed at the top of the rewrite rules. 129 * 130 * @since 2.1.0 131 * @since 4.4.0 Array support was added to the `$query` parameter. 132 * 133 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 134 * 135 * @param string $regex Regular expression to match request against. 136 * @param string|array $query The corresponding query vars for this rewrite rule. 137 * @param string $after Optional. Priority of the new rule. Accepts 'top' 138 * or 'bottom'. Default 'bottom'. 139 */ 140 function add_rewrite_rule( $regex, $query, $after = 'bottom' ) { 141 global $wp_rewrite; 142 143 $wp_rewrite->add_rule( $regex, $query, $after ); 144 } 145 146 /** 147 * Adds a new rewrite tag (like %postname%). 148 * 149 * The `$query` parameter is optional. If it is omitted you must ensure that you call 150 * this on, or before, the {@see 'init'} hook. This is because `$query` defaults to 151 * `$tag=`, and for this to work a new query var has to be added. 152 * 153 * @since 2.1.0 154 * 155 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 156 * @global WP $wp Current WordPress environment instance. 157 * 158 * @param string $tag Name of the new rewrite tag. 159 * @param string $regex Regular expression to substitute the tag for in rewrite rules. 160 * @param string $query Optional. String to append to the rewritten query. Must end in '='. Default empty. 161 */ 162 function add_rewrite_tag( $tag, $regex, $query = '' ) { 163 // Validate the tag's name. 164 if ( strlen( $tag ) < 3 || '%' !== $tag[0] || '%' !== $tag[ strlen( $tag ) - 1 ] ) { 165 return; 166 } 167 168 global $wp_rewrite, $wp; 169 170 if ( empty( $query ) ) { 171 $qv = trim( $tag, '%' ); 172 $wp->add_query_var( $qv ); 173 $query = $qv . '='; 174 } 175 176 $wp_rewrite->add_rewrite_tag( $tag, $regex, $query ); 177 } 178 179 /** 180 * Removes an existing rewrite tag (like %postname%). 181 * 182 * @since 4.5.0 183 * 184 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 185 * 186 * @param string $tag Name of the rewrite tag. 187 */ 188 function remove_rewrite_tag( $tag ) { 189 global $wp_rewrite; 190 $wp_rewrite->remove_rewrite_tag( $tag ); 191 } 192 193 /** 194 * Adds a permalink structure. 195 * 196 * @since 3.0.0 197 * 198 * @see WP_Rewrite::add_permastruct() 199 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 200 * 201 * @param string $name Name for permalink structure. 202 * @param string $struct Permalink structure. 203 * @param array $args Optional. Arguments for building the rules from the permalink structure, 204 * see WP_Rewrite::add_permastruct() for full details. Default empty array. 205 */ 206 function add_permastruct( $name, $struct, $args = array() ) { 207 global $wp_rewrite; 208 209 // Back-compat for the old parameters: $with_front and $ep_mask. 210 if ( ! is_array( $args ) ) { 211 $args = array( 'with_front' => $args ); 212 } 213 if ( func_num_args() == 4 ) { 214 $args['ep_mask'] = func_get_arg( 3 ); 215 } 216 217 $wp_rewrite->add_permastruct( $name, $struct, $args ); 218 } 219 220 /** 221 * Removes a permalink structure. 222 * 223 * Can only be used to remove permastructs that were added using add_permastruct(). 224 * Built-in permastructs cannot be removed. 225 * 226 * @since 4.5.0 227 * 228 * @see WP_Rewrite::remove_permastruct() 229 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 230 * 231 * @param string $name Name for permalink structure. 232 */ 233 function remove_permastruct( $name ) { 234 global $wp_rewrite; 235 236 $wp_rewrite->remove_permastruct( $name ); 237 } 238 239 /** 240 * Adds a new feed type like /atom1/. 241 * 242 * @since 2.1.0 243 * 244 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 245 * 246 * @param string $feedname Feed name. 247 * @param callable $function Callback to run on feed display. 248 * @return string Feed action name. 249 */ 250 function add_feed( $feedname, $function ) { 251 global $wp_rewrite; 252 253 if ( ! in_array( $feedname, $wp_rewrite->feeds, true ) ) { 254 $wp_rewrite->feeds[] = $feedname; 255 } 256 257 $hook = 'do_feed_' . $feedname; 258 259 // Remove default function hook. 260 remove_action( $hook, $hook ); 261 262 add_action( $hook, $function, 10, 2 ); 263 264 return $hook; 265 } 266 267 /** 268 * Removes rewrite rules and then recreate rewrite rules. 269 * 270 * @since 3.0.0 271 * 272 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 273 * 274 * @param bool $hard Whether to update .htaccess (hard flush) or just update 275 * rewrite_rules option (soft flush). Default is true (hard). 276 */ 277 function flush_rewrite_rules( $hard = true ) { 278 global $wp_rewrite; 279 280 if ( is_callable( array( $wp_rewrite, 'flush_rules' ) ) ) { 281 $wp_rewrite->flush_rules( $hard ); 282 } 283 } 284 285 /** 286 * Adds an endpoint, like /trackback/. 287 * 288 * Adding an endpoint creates extra rewrite rules for each of the matching 289 * places specified by the provided bitmask. For example: 290 * 291 * add_rewrite_endpoint( 'json', EP_PERMALINK | EP_PAGES ); 292 * 293 * will add a new rewrite rule ending with "json(/(.*))?/?$" for every permastruct 294 * that describes a permalink (post) or page. This is rewritten to "json=$match" 295 * where $match is the part of the URL matched by the endpoint regex (e.g. "foo" in 296 * "[permalink]/json/foo/"). 297 * 298 * A new query var with the same name as the endpoint will also be created. 299 * 300 * When specifying $places ensure that you are using the EP_* constants (or a 301 * combination of them using the bitwise OR operator) as their values are not 302 * guaranteed to remain static (especially `EP_ALL`). 303 * 304 * Be sure to flush the rewrite rules - see flush_rewrite_rules() - when your plugin gets 305 * activated and deactivated. 306 * 307 * @since 2.1.0 308 * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`. 309 * 310 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 311 * 312 * @param string $name Name of the endpoint. 313 * @param int $places Endpoint mask describing the places the endpoint should be added. 314 * Accepts a mask of: 315 * - `EP_ALL` 316 * - `EP_NONE` 317 * - `EP_ALL_ARCHIVES` 318 * - `EP_ATTACHMENT` 319 * - `EP_AUTHORS` 320 * - `EP_CATEGORIES` 321 * - `EP_COMMENTS` 322 * - `EP_DATE` 323 * - `EP_DAY` 324 * - `EP_MONTH` 325 * - `EP_PAGES` 326 * - `EP_PERMALINK` 327 * - `EP_ROOT` 328 * - `EP_SEARCH` 329 * - `EP_TAGS` 330 * - `EP_YEAR` 331 * @param string|bool $query_var Name of the corresponding query variable. Pass `false` to skip registering a query_var 332 * for this endpoint. Defaults to the value of `$name`. 333 */ 334 function add_rewrite_endpoint( $name, $places, $query_var = true ) { 335 global $wp_rewrite; 336 $wp_rewrite->add_endpoint( $name, $places, $query_var ); 337 } 338 339 /** 340 * Filters the URL base for taxonomies. 341 * 342 * To remove any manually prepended /index.php/. 343 * 344 * @access private 345 * @since 2.6.0 346 * 347 * @param string $base The taxonomy base that we're going to filter 348 * @return string 349 */ 350 function _wp_filter_taxonomy_base( $base ) { 351 if ( ! empty( $base ) ) { 352 $base = preg_replace( '|^/index\.php/|', '', $base ); 353 $base = trim( $base, '/' ); 354 } 355 return $base; 356 } 357 358 359 /** 360 * Resolves numeric slugs that collide with date permalinks. 361 * 362 * Permalinks of posts with numeric slugs can sometimes look to WP_Query::parse_query() 363 * like a date archive, as when your permalink structure is `/%year%/%postname%/` and 364 * a post with post_name '05' has the URL `/2015/05/`. 365 * 366 * This function detects conflicts of this type and resolves them in favor of the 367 * post permalink. 368 * 369 * Note that, since 4.3.0, wp_unique_post_slug() prevents the creation of post slugs 370 * that would result in a date archive conflict. The resolution performed in this 371 * function is primarily for legacy content, as well as cases when the admin has changed 372 * the site's permalink structure in a way that introduces URL conflicts. 373 * 374 * @since 4.3.0 375 * 376 * @param array $query_vars Optional. Query variables for setting up the loop, as determined in 377 * WP::parse_request(). Default empty array. 378 * @return array Returns the original array of query vars, with date/post conflicts resolved. 379 */ 380 function wp_resolve_numeric_slug_conflicts( $query_vars = array() ) { 381 if ( ! isset( $query_vars['year'] ) && ! isset( $query_vars['monthnum'] ) && ! isset( $query_vars['day'] ) ) { 382 return $query_vars; 383 } 384 385 // Identify the 'postname' position in the permastruct array. 386 $permastructs = array_values( array_filter( explode( '/', get_option( 'permalink_structure' ) ) ) ); 387 $postname_index = array_search( '%postname%', $permastructs, true ); 388 389 if ( false === $postname_index ) { 390 return $query_vars; 391 } 392 393 /* 394 * A numeric slug could be confused with a year, month, or day, depending on position. To account for 395 * the possibility of post pagination (eg 2015/2 for the second page of a post called '2015'), our 396 * `is_*` checks are generous: check for year-slug clashes when `is_year` *or* `is_month`, and check 397 * for month-slug clashes when `is_month` *or* `is_day`. 398 */ 399 $compare = ''; 400 if ( 0 === $postname_index && ( isset( $query_vars['year'] ) || isset( $query_vars['monthnum'] ) ) ) { 401 $compare = 'year'; 402 } elseif ( $postname_index && '%year%' === $permastructs[ $postname_index - 1 ] && ( isset( $query_vars['monthnum'] ) || isset( $query_vars['day'] ) ) ) { 403 $compare = 'monthnum'; 404 } elseif ( $postname_index && '%monthnum%' === $permastructs[ $postname_index - 1 ] && isset( $query_vars['day'] ) ) { 405 $compare = 'day'; 406 } 407 408 if ( ! $compare ) { 409 return $query_vars; 410 } 411 412 // This is the potentially clashing slug. 413 $value = $query_vars[ $compare ]; 414 415 $post = get_page_by_path( $value, OBJECT, 'post' ); 416 if ( ! ( $post instanceof WP_Post ) ) { 417 return $query_vars; 418 } 419 420 // If the date of the post doesn't match the date specified in the URL, resolve to the date archive. 421 if ( preg_match( '/^([0-9]{4})\-([0-9]{2})/', $post->post_date, $matches ) && isset( $query_vars['year'] ) && ( 'monthnum' === $compare || 'day' === $compare ) ) { 422 // $matches[1] is the year the post was published. 423 if ( (int) $query_vars['year'] !== (int) $matches[1] ) { 424 return $query_vars; 425 } 426 427 // $matches[2] is the month the post was published. 428 if ( 'day' === $compare && isset( $query_vars['monthnum'] ) && (int) $query_vars['monthnum'] !== (int) $matches[2] ) { 429 return $query_vars; 430 } 431 } 432 433 /* 434 * If the located post contains nextpage pagination, then the URL chunk following postname may be 435 * intended as the page number. Verify that it's a valid page before resolving to it. 436 */ 437 $maybe_page = ''; 438 if ( 'year' === $compare && isset( $query_vars['monthnum'] ) ) { 439 $maybe_page = $query_vars['monthnum']; 440 } elseif ( 'monthnum' === $compare && isset( $query_vars['day'] ) ) { 441 $maybe_page = $query_vars['day']; 442 } 443 // Bug found in #11694 - 'page' was returning '/4'. 444 $maybe_page = (int) trim( $maybe_page, '/' ); 445 446 $post_page_count = substr_count( $post->post_content, '<!--nextpage-->' ) + 1; 447 448 // If the post doesn't have multiple pages, but a 'page' candidate is found, resolve to the date archive. 449 if ( 1 === $post_page_count && $maybe_page ) { 450 return $query_vars; 451 } 452 453 // If the post has multiple pages and the 'page' number isn't valid, resolve to the date archive. 454 if ( $post_page_count > 1 && $maybe_page > $post_page_count ) { 455 return $query_vars; 456 } 457 458 // If we've gotten to this point, we have a slug/date clash. First, adjust for nextpage. 459 if ( '' !== $maybe_page ) { 460 $query_vars['page'] = (int) $maybe_page; 461 } 462 463 // Next, unset autodetected date-related query vars. 464 unset( $query_vars['year'] ); 465 unset( $query_vars['monthnum'] ); 466 unset( $query_vars['day'] ); 467 468 // Then, set the identified post. 469 $query_vars['name'] = $post->post_name; 470 471 // Finally, return the modified query vars. 472 return $query_vars; 473 } 474 475 /** 476 * Examines a URL and try to determine the post ID it represents. 477 * 478 * Checks are supposedly from the hosted site blog. 479 * 480 * @since 1.0.0 481 * 482 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 483 * @global WP $wp Current WordPress environment instance. 484 * 485 * @param string $url Permalink to check. 486 * @return int Post ID, or 0 on failure. 487 */ 488 function url_to_postid( $url ) { 489 global $wp_rewrite; 490 491 /** 492 * Filters the URL to derive the post ID from. 493 * 494 * @since 2.2.0 495 * 496 * @param string $url The URL to derive the post ID from. 497 */ 498 $url = apply_filters( 'url_to_postid', $url ); 499 500 $url_host = str_replace( 'www.', '', parse_url( $url, PHP_URL_HOST ) ); 501 $home_url_host = str_replace( 'www.', '', parse_url( home_url(), PHP_URL_HOST ) ); 502 503 // Bail early if the URL does not belong to this site. 504 if ( $url_host && $url_host !== $home_url_host ) { 505 return 0; 506 } 507 508 // First, check to see if there is a 'p=N' or 'page_id=N' to match against. 509 if ( preg_match( '#[?&](p|page_id|attachment_id)=(\d+)#', $url, $values ) ) { 510 $id = absint( $values[2] ); 511 if ( $id ) { 512 return $id; 513 } 514 } 515 516 // Get rid of the #anchor. 517 $url_split = explode( '#', $url ); 518 $url = $url_split[0]; 519 520 // Get rid of URL ?query=string. 521 $url_split = explode( '?', $url ); 522 $url = $url_split[0]; 523 524 // Set the correct URL scheme. 525 $scheme = parse_url( home_url(), PHP_URL_SCHEME ); 526 $url = set_url_scheme( $url, $scheme ); 527 528 // Add 'www.' if it is absent and should be there. 529 if ( false !== strpos( home_url(), '://www.' ) && false === strpos( $url, '://www.' ) ) { 530 $url = str_replace( '://', '://www.', $url ); 531 } 532 533 // Strip 'www.' if it is present and shouldn't be. 534 if ( false === strpos( home_url(), '://www.' ) ) { 535 $url = str_replace( '://www.', '://', $url ); 536 } 537 538 if ( trim( $url, '/' ) === home_url() && 'page' === get_option( 'show_on_front' ) ) { 539 $page_on_front = get_option( 'page_on_front' ); 540 541 if ( $page_on_front && get_post( $page_on_front ) instanceof WP_Post ) { 542 return (int) $page_on_front; 543 } 544 } 545 546 // Check to see if we are using rewrite rules. 547 $rewrite = $wp_rewrite->wp_rewrite_rules(); 548 549 // Not using rewrite rules, and 'p=N' and 'page_id=N' methods failed, so we're out of options. 550 if ( empty( $rewrite ) ) { 551 return 0; 552 } 553 554 // Strip 'index.php/' if we're not using path info permalinks. 555 if ( ! $wp_rewrite->using_index_permalinks() ) { 556 $url = str_replace( $wp_rewrite->index . '/', '', $url ); 557 } 558 559 if ( false !== strpos( trailingslashit( $url ), home_url( '/' ) ) ) { 560 // Chop off http://domain.com/[path]. 561 $url = str_replace( home_url(), '', $url ); 562 } else { 563 // Chop off /path/to/blog. 564 $home_path = parse_url( home_url( '/' ) ); 565 $home_path = isset( $home_path['path'] ) ? $home_path['path'] : ''; 566 $url = preg_replace( sprintf( '#^%s#', preg_quote( $home_path ) ), '', trailingslashit( $url ) ); 567 } 568 569 // Trim leading and lagging slashes. 570 $url = trim( $url, '/' ); 571 572 $request = $url; 573 $post_type_query_vars = array(); 574 575 foreach ( get_post_types( array(), 'objects' ) as $post_type => $t ) { 576 if ( ! empty( $t->query_var ) ) { 577 $post_type_query_vars[ $t->query_var ] = $post_type; 578 } 579 } 580 581 // Look for matches. 582 $request_match = $request; 583 foreach ( (array) $rewrite as $match => $query ) { 584 585 // If the requesting file is the anchor of the match, 586 // prepend it to the path info. 587 if ( ! empty( $url ) && ( $url != $request ) && ( strpos( $match, $url ) === 0 ) ) { 588 $request_match = $url . '/' . $request; 589 } 590 591 if ( preg_match( "#^$match#", $request_match, $matches ) ) { 592 593 if ( $wp_rewrite->use_verbose_page_rules && preg_match( '/pagename=\$matches\[([0-9]+)\]/', $query, $varmatch ) ) { 594 // This is a verbose page match, let's check to be sure about it. 595 $page = get_page_by_path( $matches[ $varmatch[1] ] ); 596 if ( ! $page ) { 597 continue; 598 } 599 600 $post_status_obj = get_post_status_object( $page->post_status ); 601 if ( ! $post_status_obj->public && ! $post_status_obj->protected 602 && ! $post_status_obj->private && $post_status_obj->exclude_from_search ) { 603 continue; 604 } 605 } 606 607 // Got a match. 608 // Trim the query of everything up to the '?'. 609 $query = preg_replace( '!^.+\?!', '', $query ); 610 611 // Substitute the substring matches into the query. 612 $query = addslashes( WP_MatchesMapRegex::apply( $query, $matches ) ); 613 614 // Filter out non-public query vars. 615 global $wp; 616 parse_str( $query, $query_vars ); 617 $query = array(); 618 foreach ( (array) $query_vars as $key => $value ) { 619 if ( in_array( (string) $key, $wp->public_query_vars, true ) ) { 620 $query[ $key ] = $value; 621 if ( isset( $post_type_query_vars[ $key ] ) ) { 622 $query['post_type'] = $post_type_query_vars[ $key ]; 623 $query['name'] = $value; 624 } 625 } 626 } 627 628 // Resolve conflicts between posts with numeric slugs and date archive queries. 629 $query = wp_resolve_numeric_slug_conflicts( $query ); 630 631 // Do the query. 632 $query = new WP_Query( $query ); 633 if ( ! empty( $query->posts ) && $query->is_singular ) { 634 return $query->post->ID; 635 } else { 636 return 0; 637 } 638 } 639 } 640 return 0; 641 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Sat Apr 20 01:00:03 2024 | Cross-referenced by PHPXref 0.7.1 |