WP_Rewrite::set_permalink_structure

Advertisement

Summery Summery

Sets the main permalink structure for the site.

Syntax Syntax

WP_Rewrite::set_permalink_structure( string $permalink_structure )

Description 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

Parameters Parameters

$permalink_structure

(Required) Permalink structure.

Source Source

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

	 */
	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 );
		}

Advertisement

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Advertisement

Leave a Reply