enmi-conf.org: comparison wp/wp-includes/class-wp-rewrite.php

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 * meaning you can't define how the template files load based on the rewrite
 * rules.
 *
 * @since 1.5.0
 */
+#[AllowDynamicProperties]
 class WP_Rewrite {
 	/**
 	 * Permalink structure for posts.
 	 *
 	 * @since 1.5.0
 	/**
 	 * Rewrite rules to match against the request to find the redirect or query.
 	 *
 	 * @since 1.5.0
-	 * @var array
+	 * @var string[]
 	 */
 	public $rules;
 	/**
 	 * Additional rules added external to the rewrite class.
 	 *
 	 * Those not generated by the class, see add_rewrite_rule().
 	 *
 	 * @since 2.1.0
-	 * @var array
+	 * @var string[]
 	 */
 	public $extra_rules = array();
 	/**
 	 * Additional rules that belong at the beginning to match first.
 	 *
 	 * Those not generated by the class, see add_rewrite_rule().
 	 *
 	 * @since 2.3.0
-	 * @var array
+	 * @var string[]
 	 */
 	public $extra_rules_top = array();
 	/**
 	 * Rules that don't redirect to WordPress' index.php.
 	 *
 	 * These rules are written to the mod_rewrite portion of the .htaccess,
 	 * and are added by add_external_rule().
 	 *
 	 * @since 2.1.0
-	 * @var array
+	 * @var string[]
 	 */
 	public $non_wp_rules = array();
 	/**
 	 * Extra permalink structures, e.g. categories, added by add_permastruct().
 	 *
 	 * @since 2.1.0
-	 * @var array
+	 * @var array[]
 	 */
 	public $extra_permastructs = array();
 	/**
 	 * Endpoints (like /trackback/) added by add_rewrite_endpoint().
 	 *
 	 * @since 2.1.0
-	 * @var array
+	 * @var array[]
 	 */
 	public $endpoints;
 	/**
 	 * Whether to write every mod_rewrite rule for WordPress into the .htaccess file.
 		return "$match_prefix$number$match_suffix";
 	}
 	/**
-	 * Retrieves all page and attachments for pages URIs.
+	 * Retrieves all pages and attachments for pages URIs.
 	 *
 	 * The attachments are for those that have pages as parents and will be
 	 * retrieved.
 	 *
 	 * @since 2.5.0
 		$this->date_structure = '';
 		$date_endian          = '';
 		foreach ( $endians as $endian ) {
-			if ( false !== strpos( $this->permalink_structure, $endian ) ) {
+			if ( str_contains( $this->permalink_structure, $endian ) ) {
 				$date_endian = $endian;
 				break;
 			}
 		}
 		foreach ( (array) $tokens[0] as $token ) {
 			if ( '%post_id%' === $token && ( $tok_index <= 3 ) ) {
 				$front = $front . 'date/';
 				break;
 			}
-			$tok_index++;
+			++$tok_index;
 		}
 		$this->date_structure = $front . $date_endian;
 		return $this->date_structure;
 	public function get_category_permastruct() {
 		return $this->get_extra_permastruct( 'category' );
 	}
 	/**
-	 * Retrieve the permalink structure for tags.
+	 * Retrieves the permalink structure for tags.
 	 *
 	 * If the tag_base property has no value, then the tag structure will have
 	 * the front property value, followed by 'tag', and finally '%tag%'. If it
 	 * does, then the root property will be used, along with the tag_base
 	 * property value.
 	 *                                    - `EP_TAGS`
 	 *                                    - `EP_YEAR`
 	 *                                    Default `EP_NONE`.
 	 * @param bool   $paged               Optional. Whether archive pagination rules should be added for the structure.
 	 *                                    Default true.
-	 * @param bool   $feed                Optional Whether feed rewrite rules should be added for the structure.
+	 * @param bool   $feed                Optional. Whether feed rewrite rules should be added for the structure.
 	 *                                    Default true.
 	 * @param bool   $forcomments         Optional. Whether the feed rules should be a query for a comments feed.
 	 *                                    Default false.
 	 * @param bool   $walk_dirs           Optional. Whether the 'directories' making up the structure should be walked
 	 *                                    over and rewrite rules built for each in-turn. Default true.
 				 * Check to see if this dir is permalink-level: i.e. the structure specifies an
 				 * individual post. Do this by checking it contains at least one of 1) post name,
 				 * 2) post ID, 3) page name, 4) timestamp (year, month, day, hour, second and
 				 * minute all present). Set these flags now as we need them for the endpoints.
 				 */
-				if ( strpos( $struct, '%postname%' ) !== false
+				if ( str_contains( $struct, '%postname%' )
-						|| strpos( $struct, '%post_id%' ) !== false
+					|| str_contains( $struct, '%post_id%' )
-						|| strpos( $struct, '%pagename%' ) !== false
+					|| str_contains( $struct, '%pagename%' )
-						|| ( strpos( $struct, '%year%' ) !== false && strpos( $struct, '%monthnum%' ) !== false && strpos( $struct, '%day%' ) !== false && strpos( $struct, '%hour%' ) !== false && strpos( $struct, '%minute%' ) !== false && strpos( $struct, '%second%' ) !== false )
+					|| ( str_contains( $struct, '%year%' )
-						) {
+						&& str_contains( $struct, '%monthnum%' )
+						&& str_contains( $struct, '%day%' )
+						&& str_contains( $struct, '%hour%' )
+						&& str_contains( $struct, '%minute%' )
+						&& str_contains( $struct, '%second%' ) )
+				) {
 					$post = true;
-					if ( strpos( $struct, '%pagename%' ) !== false ) {
+					if ( str_contains( $struct, '%pagename%' ) ) {
 						$page = true;
 					}
 				}
 				if ( ! $post ) {
 					// For custom post types, we need to add on endpoints as well.
 					foreach ( get_post_types( array( '_builtin' => false ) ) as $ptype ) {
-						if ( strpos( $struct, "%$ptype%" ) !== false ) {
+						if ( str_contains( $struct, "%$ptype%" ) ) {
 							$post = true;
 							// This is for page style attachment URLs.
 							$page = is_post_type_hierarchical( $ptype );
 							break;
 	 * @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
 	 *
 	 * @param string $permalink_structure The permalink structure to generate rules.
 	 * @param bool   $walk_dirs           Optional. Whether to create list of directories to walk over.
 	 *                                    Default false.
-	 * @return array
+	 * @return array An array of rewrite rules keyed by their regex pattern.
 	 */
 	public function generate_rewrite_rule( $permalink_structure, $walk_dirs = false ) {
 		return $this->generate_rewrite_rules( $permalink_structure, EP_NONE, false, false, false, $walk_dirs );
 	}
 		$page_rewrite = apply_filters( 'page_rewrite_rules', $page_rewrite );
 		// Extra permastructs.
 		foreach ( $this->extra_permastructs as $permastructname => $struct ) {
 			if ( is_array( $struct ) ) {
-				if ( count( $struct ) == 2 ) {
+				if ( count( $struct ) === 2 ) {
 					$rules = $this->generate_rewrite_rules( $struct[0], $struct[1] );
 				} else {
 					$rules = $this->generate_rewrite_rules( $struct['struct'], $struct['ep_mask'], $struct['paged'], $struct['feed'], $struct['forcomments'], $struct['walk_dirs'], $struct['endpoints'] );
 				}
 			} else {
 	 * @return string[] Array of rewrite rules keyed by their regex pattern.
 	 */
 	public function wp_rewrite_rules() {
 		$this->rules = get_option( 'rewrite_rules' );
 		if ( empty( $this->rules ) ) {
-			$this->matches = 'matches';
+			$this->refresh_rewrite_rules();
-			$this->rewrite_rules();
+		}
-			if ( ! did_action( 'wp_loaded' ) ) {
-				add_action( 'wp_loaded', array( $this, 'flush_rules' ) );
+		return $this->rules;
-				return $this->rules;
+	}
-			}
+	/**
+	 * Refreshes the rewrite rules, saving the fresh value to the database.
+	 * If the `wp_loaded` action has not occurred yet, will postpone saving to the database.
+	 *
+	 * @since 6.4.0
+	 */
+	private function refresh_rewrite_rules() {
+		$this->rules   = '';
+		$this->matches = 'matches';
+		$this->rewrite_rules();
+		if ( ! did_action( 'wp_loaded' ) ) {
+			/*
+			 * Is not safe to save the results right now, as the rules may be partial.
+			 * Need to give all rules the chance to register.
+			 */
+			add_action( 'wp_loaded', array( $this, 'flush_rules' ) );
+		} else {
 			update_option( 'rewrite_rules', $this->rules );
 		}
-		return $this->rules;
 	}
 	/**
 	 * Retrieves mod_rewrite-formatted rewrite rules to write to .htaccess.
 	 *
 			foreach ( (array) $rewrite as $match => $query ) {
 				// Apache 1.3 does not support the reluctant (non-greedy) modifier.
 				$match = str_replace( '.+?', '.+', $match );
-				if ( strpos( $query, $this->index ) !== false ) {
+				if ( str_contains( $query, $this->index ) ) {
 					$rules .= 'RewriteRule ^' . $match . ' ' . $home_root . $query . " [QSA,L]\n";
 				} else {
 					$rules .= 'RewriteRule ^' . $match . ' ' . $site_root . $query . " [QSA,L]\n";
 				}
 			}
 	public function add_rule( $regex, $query, $after = 'bottom' ) {
 		if ( is_array( $query ) ) {
 			$external = false;
 			$query    = add_query_arg( $query, 'index.php' );
 		} else {
-			$index = false === strpos( $query, '?' ) ? strlen( $query ) : strpos( $query, '?' );
+			$index = ! str_contains( $query, '?' ) ? strlen( $query ) : strpos( $query, '?' );
 			$front = substr( $query, 0, $index );
-			$external = $front != $this->index;
+			$external = $front !== $this->index;
 		}
 		// "external" = it doesn't correspond to index.php.
 		if ( $external ) {
 			$this->add_external_rule( $regex, $query );
 	public function add_permastruct( $name, $struct, $args = array() ) {
 		// Back-compat for the old parameters: $with_front and $ep_mask.
 		if ( ! is_array( $args ) ) {
 			$args = array( 'with_front' => $args );
 		}
-		if ( func_num_args() == 4 ) {
+		if ( func_num_args() === 4 ) {
 			$args['ep_mask'] = func_get_arg( 3 );
 		}
 		$defaults = array(
 			'with_front'  => true,
 			'feed'        => true,
 			'forcomments' => false,
 			'walk_dirs'   => true,
 			'endpoints'   => true,
 		);
-		$args     = array_intersect_key( $args, $defaults );
-		$args     = wp_parse_args( $args, $defaults );
+		$args = array_intersect_key( $args, $defaults );
+		$args = wp_parse_args( $args, $defaults );
 		if ( $args['with_front'] ) {
 			$struct = $this->front . $struct;
 		} else {
 			$struct = $this->root . $struct;
 		}
 		$args['struct'] = $struct;
 		$this->extra_permastructs[ $name ] = $args;
 	}
 		if ( isset( $do_hard_later ) ) {
 			$hard = $do_hard_later;
 			unset( $do_hard_later );
 		}
-		update_option( 'rewrite_rules', '' );
+		$this->refresh_rewrite_rules();
-		$this->wp_rewrite_rules();
 		/**
 		 * Filters whether a "hard" rewrite rule flush should be performed when requested.
 		 *
 		 * A "hard" flush updates .htaccess (Apache) or web.config (IIS).
 		unset( $this->page_structure );
 		unset( $this->search_structure );
 		unset( $this->feed_structure );
 		unset( $this->comment_feed_structure );
-		$this->use_trailing_slashes = ( '/' === substr( $this->permalink_structure, -1, 1 ) );
+		$this->use_trailing_slashes = str_ends_with( $this->permalink_structure, '/' );
 		// Enable generic rules for pages if permalink structure doesn't begin with a wildcard.
 		if ( preg_match( '/^[^%]*%(?:postname|category|tag|author)%/', $this->permalink_structure ) ) {
 			$this->use_verbose_page_rules = true;
 		} else {
 	 * @since 1.5.0
 	 *
 	 * @param string $permalink_structure Permalink structure.
 	 */
 	public function set_permalink_structure( $permalink_structure ) {
-		if ( $permalink_structure != $this->permalink_structure ) {
+		if ( $this->permalink_structure !== $permalink_structure ) {
 			$old_permalink_structure = $this->permalink_structure;
 			update_option( 'permalink_structure', $permalink_structure );
 			$this->init();

changeset 21	48c4eec2b7e6
parent 19	3d72ae0968f4
child 22	8c2e4d02f4ef