W3cubDocs

/WordPress

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.

Return

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

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;
	}

Changelog

Version Description
1.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rewrite/get_search_permastruct