Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Internals

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Class containing an alternative rewrite rules API for handling them dynamically without requiring flushing rules.

[8] Fix | Delete

[9] Fix | Delete

class Yoast_Dynamic_Rewrites implements WPSEO_WordPress_Integration {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Additional rewrite rules with high priority.

[13] Fix | Delete

[14] Fix | Delete

* @var array

[15] Fix | Delete

[16] Fix | Delete

protected $extra_rules_top = [];

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Additional rewrite rules with low priority.

[20] Fix | Delete

[21] Fix | Delete

* @var array

[22] Fix | Delete

[23] Fix | Delete

protected $extra_rules_bottom = [];

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Main instance holder.

[27] Fix | Delete

[28] Fix | Delete

* @var self|null

[29] Fix | Delete

[30] Fix | Delete

protected static $instance = null;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* WP_Rewrite instance to use.

[34] Fix | Delete

[35] Fix | Delete

* @var WP_Rewrite

[36] Fix | Delete

[37] Fix | Delete

public $wp_rewrite;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Gets the main instance of the class.

[41] Fix | Delete

[42] Fix | Delete

* @return self Dynamic rewrites main instance.

[43] Fix | Delete

[44] Fix | Delete

public static function instance() {

[45] Fix | Delete

if ( self::$instance === null ) {

[46] Fix | Delete

self::$instance = new self();

[47] Fix | Delete

self::$instance->register_hooks();

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

return self::$instance;

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Constructor.

[55] Fix | Delete

[56] Fix | Delete

* Sets the WP_Rewrite instance to use.

[57] Fix | Delete

[58] Fix | Delete

* @param WP_Rewrite|null $rewrite Optional. WP_Rewrite instance to use. Default is the $wp_rewrite global.

[59] Fix | Delete

* @throws RuntimeException Throws an exception if the $wp_rewrite global is not set.

[60] Fix | Delete

[61] Fix | Delete

public function __construct( $rewrite = null ) {

[62] Fix | Delete

if ( ! $rewrite ) {

[63] Fix | Delete

if ( empty( $GLOBALS['wp_rewrite'] ) ) {

[64] Fix | Delete

/* translators: 1: PHP class name, 2: PHP variable name */

[65] Fix | Delete

throw new RuntimeException( sprintf( __( 'The %1$s class must not be instantiated before the %2$s global is set.', 'wordpress-seo' ), self::class, '$wp_rewrite' ) );

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

$rewrite = $GLOBALS['wp_rewrite'];

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

$this->wp_rewrite = $rewrite;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Registers all necessary hooks with WordPress.

[76] Fix | Delete

[77] Fix | Delete

* @return void

[78] Fix | Delete

[79] Fix | Delete

public function register_hooks() {

[80] Fix | Delete

add_action( 'init', [ $this, 'trigger_dynamic_rewrite_rules_hook' ], 1 );

[81] Fix | Delete

add_filter( 'option_rewrite_rules', [ $this, 'filter_rewrite_rules_option' ] );

[82] Fix | Delete

add_filter( 'sanitize_option_rewrite_rules', [ $this, 'sanitize_rewrite_rules_option' ] );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Adds a dynamic rewrite rule that transforms a URL structure to a set of query vars.

[87] Fix | Delete

[88] Fix | Delete

* Rules registered with this method are applied dynamically and do not require the rewrite rules

[89] Fix | Delete

* to be flushed in order to become active, which is a benefit over the regular WordPress core API.

[90] Fix | Delete

* Note however that the dynamic application only works for rules that correspond to index.php.

[91] Fix | Delete

* Non-WordPress rewrite rules still require flushing.

[92] Fix | Delete

[93] Fix | Delete

* Any value in the $after parameter that isn't 'bottom' will result in the rule

[94] Fix | Delete

* being placed at the top of the rewrite rules.

[95] Fix | Delete

[96] Fix | Delete

* @param string $regex Regular expression to match request against.

[97] Fix | Delete

* @param string|array $query The corresponding query vars for this rewrite rule.

[98] Fix | Delete

* @param string $priority Optional. Priority of the new rule. Accepts 'top'

[99] Fix | Delete

* or 'bottom'. Default 'bottom'.

[100] Fix | Delete

[101] Fix | Delete

* @return void

[102] Fix | Delete

[103] Fix | Delete

public function add_rule( $regex, $query, $priority = 'bottom' ) {

[104] Fix | Delete

if ( is_array( $query ) ) {

[105] Fix | Delete

$query = add_query_arg( $query, 'index.php' );

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

$this->wp_rewrite->add_rule( $regex, $query, $priority );

[109] Fix | Delete

[110] Fix | Delete

// Do not further handle external rules.

[111] Fix | Delete

if ( substr( $query, 0, strlen( $this->wp_rewrite->index . '?' ) ) !== $this->wp_rewrite->index . '?' ) {

[112] Fix | Delete

return;

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

if ( $priority === 'bottom' ) {

[116] Fix | Delete

$this->extra_rules_bottom[ $regex ] = $query;

[117] Fix | Delete

return;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

$this->extra_rules_top[ $regex ] = $query;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Triggers the hook on which rewrite rules should be added.

[125] Fix | Delete

[126] Fix | Delete

* This allows for a more specific point in time from the generic `init` hook where this is

[127] Fix | Delete

* otherwise handled.

[128] Fix | Delete

[129] Fix | Delete

* @return void

[130] Fix | Delete

[131] Fix | Delete

public function trigger_dynamic_rewrite_rules_hook() {

[132] Fix | Delete

[133] Fix | Delete

/**

[134] Fix | Delete

* Fires when the plugin's dynamic rewrite rules should be added.

[135] Fix | Delete

[136] Fix | Delete

* @param self $dynamic_rewrites Dynamic rewrites handler instance. Use its `add_rule()` method

[137] Fix | Delete

* to add dynamic rewrite rules.

[138] Fix | Delete

[139] Fix | Delete

do_action( 'yoast_add_dynamic_rewrite_rules', $this );

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

/**

[143] Fix | Delete

* Filters the rewrite rules option to dynamically add additional rewrite rules.

[144] Fix | Delete

[145] Fix | Delete

* @param array|string $rewrite_rules Array of rewrite rule $regex => $query pairs, or empty string

[146] Fix | Delete

* if currently not set.

[147] Fix | Delete

[148] Fix | Delete

* @return array|string Filtered value of $rewrite_rules.

[149] Fix | Delete

[150] Fix | Delete

public function filter_rewrite_rules_option( $rewrite_rules ) {

[151] Fix | Delete

// Do not add extra rewrite rules if the rules need to be flushed.

[152] Fix | Delete

if ( empty( $rewrite_rules ) ) {

[153] Fix | Delete

return $rewrite_rules;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

return array_merge( $this->extra_rules_top, $rewrite_rules, $this->extra_rules_bottom );

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* Sanitizes the rewrite rules option prior to writing it to the database.

[161] Fix | Delete

[162] Fix | Delete

* This method ensures that the dynamic rewrite rules do not become part of the actual option.

[163] Fix | Delete

[164] Fix | Delete

* @param array|string $rewrite_rules Array pf rewrite rule $regex => $query pairs, or empty string

[165] Fix | Delete

* in order to unset.

[166] Fix | Delete

[167] Fix | Delete

* @return array|string Filtered value of $rewrite_rules before writing the option.

[168] Fix | Delete

[169] Fix | Delete

public function sanitize_rewrite_rules_option( $rewrite_rules ) {

[170] Fix | Delete

if ( empty( $rewrite_rules ) ) {

[171] Fix | Delete

return $rewrite_rules;

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

return array_diff_key( $rewrite_rules, $this->extra_rules_top, $this->extra_rules_bottom );

[175] Fix | Delete

}

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete