WP_Rewrite::get_search_permastruct() WordPress Method

The WP_Rewrite::get_search_permastruct() method is used to get the permastruct for search URLs. This permastruct is used for search URLs which do not use pretty permalinks.

WP_Rewrite::get_search_permastruct() #

Retrieves the search permalink structure.


Description

The permalink structure is root property, search base, and finally ‘/%search%’. Will set the search_structure property and then return it without attempting to set the value again.


Top ↑

Return

(string|false) Search permalink structure on success, false on failure.


Top ↑

Source

File: wp-includes/class-wp-rewrite.php

	public function get_search_permastruct() {
		if ( isset( $this->search_structure ) ) {
			return $this->search_structure;
		}

		if ( empty( $this->permalink_structure ) ) {
			$this->search_structure = '';
			return false;
		}

		$this->search_structure = $this->root . $this->search_base . '/%search%';

		return $this->search_structure;
	}


Top ↑

Changelog

Changelog
VersionDescription
1.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.