| Current File : /home/bwalansa/www/wp-content.old/plugins.backup/the-events-calendar/src/Tribe/Rewrite.php |
<?php
// Don't load directly
defined( 'WPINC' ) or die;
/**
* Rewrite Configuration Class
* Permalinks magic Happens over here!
*/
class Tribe__Events__Rewrite extends Tribe__Rewrite {
/**
* Static singleton variable
* @var self
*/
public static $instance;
/**
* WP_Rewrite Instance
* @var WP_Rewrite
*/
public $rewrite;
/**
* Rewrite rules Holder
* @var array
*/
public $rules = array();
/**
* Base slugs for rewrite urls
* @var array
*/
public $bases = array();
/**
* After creating the Hooks on WordPress we lock the usage of the function
* @var boolean
*/
protected $hook_lock = false;
/**
* Tribe__Events__Rewrite constructor.
*
* @param WP_Rewrite|null $wp_rewrite
*/
public function __construct( WP_Rewrite $wp_rewrite = null ) {
$this->rewrite = $wp_rewrite;
}
/**
* Static Singleton Factory Method
*
* @return Tribe__Events__Rewrite
*/
public static function instance( $wp_rewrite = null ) {
if ( ! isset( self::$instance ) ) {
self::$instance = new self( $wp_rewrite );
}
return self::$instance;
}
/**
* Generate the Rewrite Rules
*
* @param WP_Rewrite $wp_rewrite WordPress Rewrite that will be modified, pass it by reference (&$wp_rewrite)
*/
public function filter_generate( WP_Rewrite $wp_rewrite ) {
parent::filter_generate( $wp_rewrite );
/**
* Use this to change the Tribe__Events__Rewrite instance before new rules
* are committed.
*
* Should be used when you want to add more rewrite rules without having to
* deal with the array merge, noting that rules for The Events Calendar are
* themselves added via this hook (default priority).
*
* @var Tribe__Events__Rewrite $rewrite
*/
do_action( 'tribe_events_pre_rewrite', $this );
/**
* Provides an opportunity to modify The Events Calendar's rewrite rules before they
* are merged in to WP's own rewrite rules.
*
* @param array $events_rewrite_rules
* @param Tribe__Events__Rewrite $tribe_rewrite
* @param WP_Rewrite $wp_rewrite WordPress Rewrite that will be modified.
*/
$this->rules = apply_filters( 'tribe_events_rewrite_rules_custom', $this->rules, $this, $wp_rewrite );
$wp_rewrite->rules = $this->rules + $wp_rewrite->rules;
}
/**
* Sets up the rules required by The Events Calendar.
*
* This should be called during tribe_events_pre_rewrite, which means other plugins needing to add rules
* of their own can do so on the same hook at a lower or higher priority, according to how specific
* those rules are.
*
* @param Tribe__Events__Rewrite $rewrite
*/
public function generate_core_rules( Tribe__Events__Rewrite $rewrite ) {
$rewrite
// Single
->single( array( 'ical' ), array( 'ical' => 1, 'name' => '%1', 'post_type' => Tribe__Events__Main::POSTTYPE ) )
// Archive
->archive( array( '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'paged' => '%1' ) )
->archive( array( '{{ featured }}', '{{ page }}', '(\d+)' ), array( 'featured' => true, 'eventDisplay' => 'list', 'paged' => '%1' ) )
->archive( array( '(feed|rdf|rss|rss2|atom)' ), array( 'eventDisplay' => 'list', 'feed' => '%1' ) )
->archive( array( '{{ featured }}', '(feed|rdf|rss|rss2|atom)' ), array( 'featured' => true, 'eventDisplay' => 'list', 'feed' => '%1' ) )
->archive( array( '{{ month }}' ), array( 'eventDisplay' => 'month' ) )
->archive( array( '{{ month }}', '{{ featured }}' ), array( 'eventDisplay' => 'month', 'featured' => true ) )
->archive( array( '{{ month }}', '(\d{4}-\d{2})' ), array( 'eventDisplay' => 'month', 'eventDate' => '%1' ) )
->archive( array( '{{ list }}', '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'paged' => '%1' ) )
->archive( array( '{{ list }}', '{{ featured }}', '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'featured' => true, 'paged' => '%1' ) )
->archive( array( '{{ list }}' ), array( 'eventDisplay' => 'list' ) )
->archive( array( '{{ list }}', '{{ featured }}' ), array( 'eventDisplay' => 'list', 'featured' => true ) )
->archive( array( '{{ today }}' ), array( 'eventDisplay' => 'day' ) )
->archive( array( '{{ today }}', '{{ featured }}' ), array( 'eventDisplay' => 'day', 'featured' => true ) )
->archive( array( '(\d{4}-\d{2})' ), array( 'eventDisplay' => 'month', 'eventDate' => '%1' ) )
->archive( array( '(\d{4}-\d{2})', '{{ featured }}' ), array( 'eventDisplay' => 'month', 'eventDate' => '%1', 'featured' => true ) )
->archive( array( '(\d{4}-\d{2}-\d{2})' ), array( 'eventDisplay' => 'day', 'eventDate' => '%1' ) )
->archive( array( '(\d{4}-\d{2}-\d{2})', '{{ featured }}' ), array( 'eventDisplay' => 'day', 'eventDate' => '%1', 'featured' => true ) )
->archive( array( '{{ featured }}' ), array( 'featured' => true ) )
->archive( array(), array( 'eventDisplay' => 'default' ) )
->archive( array( 'ical' ), array( 'ical' => 1 ) )
->archive( array( '{{ featured }}', 'ical' ), array( 'ical' => 1, 'featured' => true ) )
->archive( array( '(\d{4}-\d{2}-\d{2})', 'ical' ), array( 'ical' => 1, 'eventDisplay' => 'day', 'eventDate' => '%1' ) )
->archive( array( '(\d{4}-\d{2}-\d{2})', 'ical', 'featured' ), array( 'ical' => 1, 'eventDisplay' => 'day', 'eventDate' => '%1', 'featured' => true ) )
// Taxonomy
->tax( array( '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'paged' => '%2' ) )
->tax( array( '{{ featured }}', '{{ page }}', '(\d+)' ), array( 'featured' => true, 'eventDisplay' => 'list', 'paged' => '%2' ) )
->tax( array( '{{ month }}' ), array( 'eventDisplay' => 'month' ) )
->tax( array( '{{ month }}', '{{ featured }}' ), array( 'eventDisplay' => 'month', 'featured' => true ) )
->tax( array( '{{ list }}', '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'paged' => '%2' ) )
->tax( array( '{{ list }}', '{{ featured }}', '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'featured' => true, 'paged' => '%2' ) )
->tax( array( '{{ list }}' ), array( 'eventDisplay' => 'list' ) )
->tax( array( '{{ list }}', '{{ featured }}' ), array( 'eventDisplay' => 'list', 'featured' => true ) )
->tax( array( '{{ today }}' ), array( 'eventDisplay' => 'day' ) )
->tax( array( '{{ today }}', '{{ featured }}' ), array( 'eventDisplay' => 'day', 'featured' => true ) )
->tax( array( '{{ day }}', '(\d{4}-\d{2}-\d{2})' ), array( 'eventDisplay' => 'day', 'eventDate' => '%2' ) )
->tax( array( '{{ day }}', '(\d{4}-\d{2}-\d{2})', '{{ featured }}' ), array( 'eventDisplay' => 'day', 'eventDate' => '%2', 'featured' => true ) )
->tax( array( '(\d{4}-\d{2})' ), array( 'eventDisplay' => 'month', 'eventDate' => '%2' ) )
->tax( array( '(\d{4}-\d{2})', '{{ featured }}' ), array( 'eventDisplay' => 'month', 'eventDate' => '%2', 'featured' => true ) )
->tax( array( '(\d{4}-\d{2}-\d{2})' ), array( 'eventDisplay' => 'day', 'eventDate' => '%2' ) )
->tax( array( '(\d{4}-\d{2}-\d{2})', '{{ featured }}' ), array( 'eventDisplay' => 'day', 'eventDate' => '%2', 'featured' => true ) )
->tax( array( 'feed' ), array( 'eventDisplay' => 'list', 'feed' => 'rss2' ) )
->tax( array( '{{ featured }}', 'feed' ), array( 'featured' => true, 'eventDisplay' => 'list', 'feed' => 'rss2' ) )
->tax( array( 'ical' ), array( 'ical' => 1 ) )
->tax( array( '{{ featured }}', 'ical' ), array( 'featured' => true, 'ical' => 1 ) )
->tax( array( 'feed', '(feed|rdf|rss|rss2|atom)' ), array( 'feed' => '%2' ) )
->tax( array( '{{ featured }}', 'feed', '(feed|rdf|rss|rss2|atom)' ), array( 'featured' => true, 'feed' => '%2' ) )
->tax( array( '{{ featured }}' ), array( 'featured' => true, 'eventDisplay' => 'default' ) )
->tax( array(), array( 'eventDisplay' => 'default' ) )
// Tag
->tag( array( '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'paged' => '%2' ) )
->tag( array( '{{ featured }}', '{{ page }}', '(\d+)' ), array( 'featured' => true, 'eventDisplay' => 'list', 'paged' => '%2' ) )
->tag( array( '{{ month }}' ), array( 'eventDisplay' => 'month' ) )
->tag( array( '{{ month }}', '{{ featured }}' ), array( 'eventDisplay' => 'month', 'featured' => true ) )
->tag( array( '{{ list }}', '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'paged' => '%2' ) )
->tag( array( '{{ list }}', '{{ featured }}', '{{ page }}', '(\d+)' ), array( 'eventDisplay' => 'list', 'featured' => true, 'paged' => '%2' ) )
->tag( array( '{{ list }}' ), array( 'eventDisplay' => 'list' ) )
->tag( array( '{{ list }}', '{{ featured }}' ), array( 'eventDisplay' => 'list', 'featured' => true ) )
->tag( array( '{{ today }}' ), array( 'eventDisplay' => 'day' ) )
->tag( array( '{{ today }}', '{{ featured }}' ), array( 'eventDisplay' => 'day', 'featured' => true ) )
->tag( array( '{{ day }}', '(\d{4}-\d{2}-\d{2})' ), array( 'eventDisplay' => 'day', 'eventDate' => '%2' ) )
->tag( array( '{{ day }}', '(\d{4}-\d{2}-\d{2})', '{{ featured }}' ), array( 'eventDisplay' => 'day', 'eventDate' => '%2', 'featured' => true ) )
->tag( array( '(\d{4}-\d{2})' ), array( 'eventDisplay' => 'month', 'eventDate' => '%2' ) )
->tag( array( '(\d{4}-\d{2})', '{{ featured }}' ), array( 'eventDisplay' => 'month', 'eventDate' => '%2', 'featured' => true ) )
->tag( array( '(\d{4}-\d{2}-\d{2})' ), array( 'eventDisplay' => 'day', 'eventDate' => '%2' ) )
->tag( array( '(\d{4}-\d{2}-\d{2})', '{{ featured }}' ), array( 'eventDisplay' => 'day', 'eventDate' => '%2', 'featured' => true ) )
->tag( array( 'feed' ), array( 'eventDisplay' => 'list', 'feed' => 'rss2' ) )
->tag( array( '{{ featured }}', 'feed' ), array( 'eventDisplay' => 'list', 'feed' => 'rss2', 'featured' => true ) )
->tag( array( 'ical' ), array( 'ical' => 1 ) )
->tag( array( '{{ featured }}', 'ical' ), array( 'featured' => true, 'ical' => 1 ) )
->tag( array( 'feed', '(feed|rdf|rss|rss2|atom)' ), array( 'feed' => '%2' ) )
->tag( array( '{{ featured }}', 'feed', '(feed|rdf|rss|rss2|atom)' ), array( 'featured' => true, 'feed' => '%2' ) )
->tag( array( '{{ featured }}' ), array( 'featured' => true ) )
->tag( array(), array( 'eventDisplay' => 'default' ) );
}
/**
* Filters the post permalink to take 3rd party plugins into account.
*
* @param string $permalink Permalink for the post
* @param WP_Post $post Post Object
*
* @return string Permalink with the language
*/
public function filter_post_type_link( $permalink, $post ) {
$supported_post_types = array(
Tribe__Events__Main::POSTTYPE,
Tribe__Events__Main::VENUE_POST_TYPE,
Tribe__Events__Main::ORGANIZER_POST_TYPE,
);
if ( ! in_array( $post->post_type, $supported_post_types ) ) {
return $permalink;
}
$permalink = str_replace( self::PERCENT_PLACEHOLDER, '%', $permalink );
/**
* Filters a supported post type permalink to allow third-party plugins to add or remove components.
*
* @param string $permalink The permalink for the post generated by the The Events Calendar.
* @param WP_Post $post The current post object.
* @param array $supported_post_types An array of post types supported by The Events Calendar.
*/
$permalink = apply_filters( 'tribe_events_post_type_permalink', $permalink, $post, $supported_post_types );
return $permalink;
}
/**
* Checking if WPML is active on this WP
*
* @return boolean
*/
public function is_wpml_active() {
return ! empty( $GLOBALS['sitepress'] ) && $GLOBALS['sitepress'] instanceof SitePress;
}
/**
* Get the base slugs for the Plugin Rewrite rules
*
* WARNING: Don't mess with the filters below if you don't know what you are doing
*
* @param string $method Use "regex" to return a Regular Expression with the possible Base Slugs using l10n
* @return object Return Base Slugs with l10n variations
*/
public function get_bases( $method = 'regex' ) {
$tec = Tribe__Events__Main::instance();
/**
* If you want to modify the base slugs before the i18n happens filter this use this filter
* All the bases need to have a key and a value, they might be the same or not.
*
* Each value is an array of possible slugs: to improve robustness the "original" English
* slug is supported in addition to translated forms for month, list, today and day: this
* way if the forms are altered (whether through i18n or other custom mods) *after* links
* have already been promulgated, there will be less chance of visitors hitting 404s.
*
* The term "original" here for:
* - events
* - event
*
* Means that is a value that can be overwritten and relies on the user value entered on the
* options page.
*
* @var array $bases
*/
$bases = apply_filters( 'tribe_events_rewrite_base_slugs', array(
'month' => array( 'month', $tec->monthSlug ),
'list' => array( 'list', $tec->listSlug ),
'today' => array( 'today', $tec->todaySlug ),
'day' => array( 'day', $tec->daySlug ),
'tag' => array( 'tag', $tec->tag_slug ),
'tax' => array( 'category', $tec->category_slug ),
'page' => array( 'page', esc_html_x( 'page', 'The "/page/" URL string component.', 'the-events-calendar' ) ),
'single' => array( Tribe__Settings_Manager::get_option( 'singleEventSlug', 'event' ), $tec->rewriteSlugSingular ),
'archive' => array( Tribe__Settings_Manager::get_option( 'eventsSlug', 'events' ), $tec->rewriteSlug ),
'featured' => array( 'featured', $tec->featured_slug ),
) );
// Remove duplicates (no need to have 'month' twice if no translations are in effect, etc)
$bases = array_map( 'array_unique', $bases );
// By default we always have `en_US` to avoid 404 with older URLs
$languages = apply_filters( 'tribe_events_rewrite_i18n_languages', array_unique( array( 'en_US', get_locale() ) ) );
// By default we load the Default and our plugin domains
$domains = apply_filters( 'tribe_events_rewrite_i18n_domains', array(
'default' => true, // Default doesn't need file path
'the-events-calendar' => $tec->plugin_dir . 'lang/',
) );
/**
* Use `tribe_events_rewrite_i18n_slugs_raw` to modify the raw version of the l10n slugs bases.
*
* This is useful to modify the bases before the method is taken into account.
*
* @param array $bases An array of rewrite bases that have been generated.
* @param string $method The method that's being used to generate the bases; defaults to `regex`.
* @param array $domains An associative array of language domains to use; these would be plugin or themes language
* domains with a `'plugin-slug' => '/absolute/path/to/lang/dir'`
*/
$bases = apply_filters( 'tribe_events_rewrite_i18n_slugs_raw', $bases, $method, $domains );
if ( 'regex' === $method ) {
foreach ( $bases as $type => $base ) {
// Escape all the Bases
$base = array_map( 'preg_quote', $base );
// Create the Regular Expression
$bases[ $type ] = '(?:' . implode( '|', $base ) . ')';
}
}
/**
* Use `tribe_events_rewrite_i18n_slugs` to modify the final version of the l10n slugs bases
*
* At this stage the method has been applied already and this filter will work with the
* finalized version of the bases.
*
* @param array $bases An array of rewrite bases that have been generated.
* @param string $method The method that's being used to generate the bases; defaults to `regex`.
* @param array $domains An associative array of language domains to use; these would be plugin or themes language
* domains with a `'plugin-slug' => '/absolute/path/to/lang/dir'`
*/
return (object) apply_filters( 'tribe_events_rewrite_i18n_slugs', $bases, $method, $domains );
}
/**
* Alias to `$this->add()` but adding the archive base first
*
* @param array|string $regex The regular expression to catch the URL
* @param array $args The arguments in which the regular expression "alias" to
*
* @return Tribe__Events__Rewrite
*/
public function archive( $regex, $args = array() ) {
$default = array(
'post_type' => Tribe__Events__Main::POSTTYPE,
);
$args = array_filter( wp_parse_args( $args, $default ) );
$regex = array_merge( array( $this->bases->archive ), (array) $regex );
return $this->add( $regex, $args );
}
/**
* Alias to `$this->add()` but adding the singular base first
*
* @param array|string $regex The regular expression to catch the URL
* @param array $args The arguments in which the regular expression "alias" to
*
* @return Tribe__Events__Rewrite
*/
public function single( $regex, $args = array() ) {
$regex = array_merge( array( $this->bases->single, '([^/]+)' ), (array) $regex );
return $this->add( $regex, $args );
}
/**
* Alias to `$this->add()` but adding the taxonomy base first
*
* @param array|string $regex The regular expression to catch the URL
* @param array $args The arguments in which the regular expression "alias" to
*
* @return Tribe__Events__Rewrite
*/
public function tax( $regex, $args = array() ) {
$default = array(
'post_type' => Tribe__Events__Main::POSTTYPE,
Tribe__Events__Main::TAXONOMY => '%1',
);
$args = array_filter( wp_parse_args( $args, $default ) );
$regex = array_merge( array( $this->bases->archive, $this->bases->tax, '(?:[^/]+/)*([^/]+)' ), (array) $regex );
return $this->add( $regex, $args );
}
/**
* Alias to `$this->add()` but adding the tag base first
*
* @param array|string $regex The regular expression to catch the URL
* @param array $args The arguments in which the regular expression "alias" to
*
* @return Tribe__Events__Rewrite
*/
public function tag( $regex, $args = array() ) {
$default = array(
'post_type' => Tribe__Events__Main::POSTTYPE,
'tag' => '%1',
);
$args = array_filter( wp_parse_args( $args, $default ) );
$regex = array_merge( array( $this->bases->archive, $this->bases->tag, '([^/]+)' ), (array) $regex );
return $this->add( $regex, $args );
}
protected function remove_hooks() {
parent::remove_hooks();
remove_filter( 'post_type_link', array( $this, 'filter_post_type_link' ), 15 );
}
protected function add_hooks() {
parent::add_hooks();
add_action( 'tribe_events_pre_rewrite', array( $this, 'generate_core_rules' ) );
add_filter( 'post_type_link', array( $this, 'filter_post_type_link' ), 15, 2 );
add_filter( 'url_to_postid', array( $this, 'filter_url_to_postid' ) );
}
/**
* Prevent url_to_postid to run if on the main events page to avoid
* query conflicts.
*
* @since 4.6.15
*
* @param string $url The URL from `url_to_postid()`
* @see [94328]
*
* @return int|string $url
*/
public function filter_url_to_postid( $url ) {
$events_url = Tribe__Events__Main::instance()->getLink();
// check if the site is using pretty permalinks
if ( '' !== get_option( 'permalink_structure' ) ) {
$url_query = @parse_url( $url, PHP_URL_QUERY );
// Remove the "args" in case we receive any
if ( ! empty( $url_query ) ) {
$url = str_replace( '?' . $url_query, '', $url );
} else {
// Check if they're viewing the events page with pretty params
if ( 0 === stripos( $url, $events_url ) ) {
$url = $events_url;
}
}
}
if (
$url === $events_url
|| $url === Tribe__Events__Main::instance()->getLink( 'month' )
) {
return 0;
}
return $url;
}
}