WP_Rewrite::set_permalink_structure( string $permalink_structure )

Sets the main permalink structure for the site.


Description

Will update the ‘permalink_structure’ option, if there is a difference between the current permalink structure and the parameter value. Calls WP_Rewrite::init() after the option is updated.

Fires the ‘permalink_structure_changed’ action once the init call has processed passing the old and new values


Top ↑

Parameters

$permalink_structure string Required
Permalink structure.

Top ↑

Source

File: wp-includes/class-wp-rewrite.php. View all references

public function set_permalink_structure( $permalink_structure ) {
	if ( $permalink_structure != $this->permalink_structure ) {
		$old_permalink_structure = $this->permalink_structure;
		update_option( 'permalink_structure', $permalink_structure );

		$this->init();

		/**
		 * Fires after the permalink structure is updated.
		 *
		 * @since 2.8.0
		 *
		 * @param string $old_permalink_structure The previous permalink structure.
		 * @param string $permalink_structure     The new permalink structure.
		 */
		do_action( 'permalink_structure_changed', $old_permalink_structure, $permalink_structure );
	}
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.