Current File : /home/dordingu/public_html/hardkjarni/wp-content/plugins/the-events-calendar/common/src/functions/utils.php
<?php
if ( ! function_exists( 'tribe_array_merge_recursive' ) ) {
/**
* Recursively merge two arrays preserving keys.
*
* @link http://php.net/manual/en/function.array-merge-recursive.php#92195
*
* @param array $array1
* @param array $array2
*
* @return array
*/
function tribe_array_merge_recursive( array &$array1, array &$array2 ) {
$merged = $array1;
foreach ( $array2 as $key => &$value ) {
if ( is_array( $value ) && isset( $merged [ $key ] ) && is_array( $merged [ $key ] ) ) {
$merged [ $key ] = tribe_array_merge_recursive( $merged [ $key ], $value );
} else {
$merged [ $key ] = $value;
}
}
return $merged;
}
}
if ( ! function_exists( 'tribe_register_plugin' ) ) {
/**
* Checks if this plugin has permission to run, if not it notifies the admin
*
* @param string $file_path Full file path to the base plugin file
* @param string $main_class The Main/base class for this plugin
* @param string $version The version
* @param array $classes_req Any Main class files/tribe plugins required for this to run
* @param array $dependencies an array of dependencies to check
*/
function tribe_register_plugin( $file_path, $main_class, $version, $classes_req = [], $dependencies = [] ) {
$tribe_dependency = tribe( Tribe__Dependency::class );
$tribe_dependency->register_plugin( $file_path, $main_class, $version, $classes_req, $dependencies );
}
}
if ( ! function_exists( 'tribe_check_plugin' ) ) {
/**
* Checks if this plugin has permission to run, if not it notifies the admin
*
* @since 4.9
*
* @param string $main_class The Main/base class for this plugin
*
* @return bool Indicates if plugin should continue initialization
*/
function tribe_check_plugin( $main_class ) {
$tribe_dependency = Tribe__Dependency::instance();
return $tribe_dependency->check_plugin( $main_class );
}
}
if ( ! function_exists( 'tribe_append_path' ) ) {
/**
* Append a path fragment to a URL preserving query arguments
* and fragments.
*
* @since 4.3
*
* @param string $path The path to append to the existing, if any, one., e.g. `/some/path`
*
* @param string $url A full URL in the `http://example.com/?query=var#frag` format.
*
* @return mixed|string
*/
function tribe_append_path( $url, $path ) {
$path = trim( $path, '/' );
$query = @parse_url( $url, PHP_URL_QUERY );
$frag = @parse_url( $url, PHP_URL_FRAGMENT );
if ( ! ( empty( $query ) && empty( $frag ) ) ) {
$url = str_replace( '?' . $query, '', $url );
$url = str_replace( '#' . $frag, '', $url );
$query = $query ? '?' . $query : '';
$frag = $frag ? '#' . $frag : '';
}
$url = trailingslashit( esc_url_raw( trailingslashit( $url ) . $path ) );
$url .= $query . $frag;
return $url;
}
}
if ( ! function_exists( 'tribe_exit' ) ) {
/**
* Filterable `die` wrapper.
*
* @param string $status
*
* @return void|mixed Depending on the handler this function might return
* a value or `die` before anything is returned.
*/
function tribe_exit( $status = '' ) {
$handler = 'die';
/**
* Filters the callback to call in place of `die()`.
*
* @param callable $handler The `die` replacement callback.
* @param string $status The exit/die status.
*/
$handler = apply_filters( 'tribe_exit', $handler, $status );
// Die and exit are language constructs that cannot be used as callbacks on all PHP runtimes
if ( 'die' === $handler || 'exit' === $handler ) {
exit ( $status );
}
return call_user_func( $handler, $status );
}
}
if ( ! function_exists( 'tribe_get_request_var' ) ) {
/**
* Tests to see if the requested variable is set either as a post field or as a URL
* param and returns the value if so.
*
* Post data takes priority over fields passed in the URL query. If the field is not
* set then $default (null unless a different value is specified) will be returned.
*
* The variable being tested for can be an array if you wish to find a nested value.
*
* @since 4.9.17 Included explicit check against $_REQUEST.
*
* @see Tribe__Utils__Array::get()
*
* @param string|array $var
* @param mixed $default
*
* @return mixed
*/
function tribe_get_request_var( $var, $default = null ) {
$requests = [];
// Prevent a slew of warnings every time we call this.
if ( isset( $_REQUEST ) ) {
$requests[] = (array) $_REQUEST;
}
if ( isset( $_GET ) ) {
$requests[] = (array) $_GET;
}
if ( isset( $_POST ) ) {
$requests[] = (array) $_POST;
}
if ( empty( $requests ) ) {
return $default;
}
$unsafe = Tribe__Utils__Array::get_in_any( $requests, $var, $default );
return tribe_sanitize_deep( $unsafe );
}
}
if ( ! function_exists( 'tribe_get_global_query_object' ) ) {
/**
* Grabs the $wp_query global in a safe way with some fallbacks that help prevent fatal errors
* on sites where themes or other plugins directly manipulate the $wp_query global.
*
* @since 4.7.8
*
* @return WP_Query The $wp_query, the $wp_the_query if $wp_query empty, null otherwise.
*/
function tribe_get_global_query_object() {
global $wp_query;
global $wp_the_query;
if ( ! empty( $wp_query ) ) {
return $wp_query;
}
if ( ! empty( $wp_the_query ) ) {
return $wp_the_query;
}
return null;
}
}
if ( ! function_exists( 'tribe_null_or_truthy' ) ) {
/**
* Validation of Null or Truthy values for Shortcode Attributes.
*
* @since 5.1.4
*
* @param mixed $value Which value will be validated.
*
* @return bool|null Sanitizes the value passed as a boolean or null.
*/
function tribe_null_or_truthy( $value = null ) {
if ( null === $value || 'null' === $value ) {
return null;
}
return tribe_is_truthy( $value );
}
}
if ( ! function_exists( 'tribe_null_or_number' ) ) {
/**
* Validation of Null or Numerical values for Shortcode Attributes.
* We don't use absint() since -1 is a common number used to indicate "all" or "infinite".
*
* @since 4.13.2
*
* @param mixed $value Which value will be validated.
*
* @return int|null Sanitizes the value passed as an integer or null.
*/
function tribe_null_or_number( $value = null ) {
if ( null === $value || 'null' === $value ) {
return null;
}
return (int) $value;
}
}
if ( ! function_exists( 'tribe_is_truthy' ) ) {
/**
* Determines if the provided value should be regarded as 'true'.
*
* @param mixed $var
*
* @return bool
*/
function tribe_is_truthy( $var ) {
if ( is_bool( $var ) ) {
return $var;
}
/**
* Provides an opportunity to modify strings that will be
* deemed to evaluate to true.
*
* @param array $truthy_strings
*/
$truthy_strings = (array) apply_filters( 'tribe_is_truthy_strings', [
'1',
'enable',
'enabled',
'on',
'y',
'yes',
'true',
] );
// Makes sure we are dealing with lowercase for testing
if ( is_string( $var ) ) {
$var = strtolower( $var );
}
// If $var is a string, it is only true if it is contained in the above array
if ( in_array( $var, $truthy_strings, true ) ) {
return true;
}
// All other strings will be treated as false
if ( is_string( $var ) ) {
return false;
}
// For other types (ints, floats etc) cast to bool
return (bool) $var;
}
}
if ( ! function_exists( 'tribe_sort_by_priority' ) ) {
/**
* Sorting function based on Priority
*
* @since 4.7.20
*
* @param object|array $b Second subject to compare
*
* @param object|array $a First Subject to compare
*
* @return int
*/
function tribe_sort_by_priority( $a, $b ) {
if ( is_array( $a ) ) {
$a_priority = $a['priority'];
} else {
$a_priority = $a->priority;
}
if ( is_array( $b ) ) {
$b_priority = $b['priority'];
} else {
$b_priority = $b->priority;
}
if ( (int) $a_priority === (int) $b_priority ) {
return 0;
}
return (int) $a_priority > (int) $b_priority ? 1 : -1;
}
}
if ( ! function_exists( 'tribe_normalize_terms_list' ) ) {
/**
* Normalizes a list of terms to a list of fields.
*
* @since 4.5
*
* @param string $taxonomy The terms taxonomy.
* @param string $field The fields the terms should be normalized to.
* @param $terms A term or array of terms to normalize.
*
* @return array An array of the valid normalized terms.
*/
function tribe_normalize_terms_list( $terms, $taxonomy, $field = 'term_id' ) {
if ( ! is_array( $terms ) ) {
$terms = [ $terms ];
}
$normalized = [];
foreach ( $terms as $term ) {
if ( is_object( $term ) && ! empty( $term->{$field} ) ) {
$normalized[] = $term->{$field};
} elseif ( is_numeric( $term ) ) {
$term = get_term_by( 'id', $term, $taxonomy );
if ( $term instanceof WP_Term ) {
$normalized[] = $term->{$field};
}
} elseif ( is_string( $term ) ) {
$term = get_term_by( 'slug', $term, $taxonomy );
if ( $term instanceof WP_Term ) {
$normalized[] = $term->{$field};
}
} elseif ( is_array( $term ) && ! empty( $term[ $field ] ) ) {
$normalized[] = $term[ $field ];
}
}
return $normalized;
}
}
if ( ! function_exists( 'tribe_upload_image' ) ) {
/**
* @see Tribe__Image__Uploader::upload_and_get_attachment_id()
*
* @param string|int $image The path to an image file, an image URL or an attachment post ID.
*
* @return int|bool The attachment post ID if the uploading and attachment is successful or the ID refers to an attachment;
* `false` otherwise.
*/
function tribe_upload_image( $image ) {
$uploader = new Tribe__Image__Uploader( $image );
return $uploader->upload_and_get_attachment_id();
}
}
if ( ! function_exists( 'tribe_is_error' ) ) {
/**
* Check whether variable is a WordPress or Tribe Error.
*
* Returns true if $thing is an object of the Tribe_Error or WP_Error class.
*
* @since 4.5.3
*
* @param mixed $thing Any old variable will do.
*
* @return bool Indicates if $thing was an error.
*/
function tribe_is_error( $thing ) {
return ( $thing instanceof Tribe__Error || is_wp_error( $thing ) );
}
}
if ( ! function_exists( 'tribe_retrieve_object_by_hook' ) ) {
/**
* Attempts to find and return an object of the specified type that is associated
* with a specific hook.
*
* This is useful when third party code registers callbacks that belong to anonymous
* objects and it isn't possible to obtain the reference any other way.
*
* @since 4.5.8
*
* @param string $class_name
* @param string $hook
* @param int $priority
*
* @return object|false
*/
function tribe_retrieve_object_by_hook( $class_name, $hook, $priority ) {
global $wp_filter;
// No callbacks registered for this hook and priority?
if (
! isset( $wp_filter[ $hook ] )
|| ! isset( $wp_filter[ $hook ][ $priority ] )
) {
return false;
}
// Otherwise iterate through the registered callbacks at the specified priority
foreach ( $wp_filter[ $hook ]->callbacks[ $priority ] as $callback ) {
// Skip if this callback isn't an object method
if (
! is_array( $callback['function'] )
|| ! is_object( $callback['function'][0] )
) {
continue;
}
// If this isn't the callback we're looking for let's skip ahead
if ( $class_name !== get_class( $callback['function'][0] ) ) {
continue;
}
return $callback['function'][0];
}
return false;
}
}
if ( ! function_exists( 'tribe_is_wpml_active' ) ) {
/**
* A unified way of checking if WPML is activated.
*
* @since 4.6.2
*
* @return boolean
*/
function tribe_is_wpml_active() {
return ( class_exists( 'SitePress' ) && defined( 'ICL_PLUGIN_PATH' ) );
}
}
if ( ! function_exists( 'tribe_post_exists' ) ) {
/**
* Checks if a post, optionally of a specific type, exists in the database.
*
* This is a low-level database check that will ignore caches and will
* check if there is an entry, in the posts table, for the post.
*
* @since 4.7.7
*
* @param string|int $post_id_or_name Either a post ID or a post name.
* @param null $post_type An optional post type, or a list of post types, the
* post should have; a logic OR will be used.
*
* @return bool|int The matching post ID if found, `false` otherwise
*/
function tribe_post_exists( $post_id_or_name, $post_type = null ) {
if ( $post_id_or_name instanceof WP_Post ) {
$post_id_or_name = $post_id_or_name->ID;
}
global $wpdb;
$query_template = "SELECT ID FROM {$wpdb->posts} WHERE %s";
$query_vars = [];
$where = '';
if ( is_numeric( $post_id_or_name ) ) {
$where = 'ID = %d';
$query_vars[] = $post_id_or_name;
} elseif ( is_string( $post_id_or_name ) ) {
$where = 'post_name = %s';
$query_vars[] = $post_id_or_name;
}
if (
is_string( $post_type )
|| (
is_array( $post_type )
&& count( $post_type ) === count( array_filter( $post_type, 'is_string' ) )
)
) {
$post_types_where_template = ' AND post_type IN (%s)';
$post_types = (array) $post_type;
$post_types_interval = $wpdb->prepare(
implode(
',',
array_fill( 0, count( $post_types ), '%s' )
),
$post_types
);
$where .= sprintf( $post_types_where_template, $post_types_interval );
}
$prepared = $wpdb->prepare( sprintf( $query_template, $where ), $query_vars );
$found = $wpdb->get_var( $prepared );
return ! empty( $found ) ? (int) $found : false;
}
}
if ( ! function_exists( 'tribe_post_excerpt' ) ) {
/**
* Wrapper function for `tribe_events_get_the_excerpt` to prevent access the function when is not present on the
* current site installation.
*
* @param $post
*
* @return null|string
*/
function tribe_post_excerpt( $post ) {
if ( function_exists( 'tribe_events_get_the_excerpt' ) ) {
return tribe_events_get_the_excerpt( $post );
}
if ( ! is_numeric( $post ) && ! $post instanceof WP_Post ) {
$post = get_the_ID();
}
if ( is_numeric( $post ) ) {
$post = WP_Post::get_instance( $post );
}
if ( ! $post instanceof WP_Post ) {
return null;
}
$excerpt = has_excerpt( $post->ID )
? $post->post_excerpt
: wp_trim_words( $post->post_content );
return wpautop( $excerpt );
}
}
if ( ! function_exists( 'tribe_catch_and_throw' ) ) {
/**
* A convenience function used to cast errors to exceptions.
*
* Use in `set_error_handler` calls:
*
* try{
* set_error_handler( 'tribe_catch_and_throw' );
* // ...do something that could generate an error...
* restore_error_handler();
* } catch ( RuntimeException $e ) {
* // Handle the exception.
* }
*
* @since 4.9.5
*
* @see set_error_handler()
* @see restore_error_handler()
* @throws RuntimeException The message will be the error message, the code will be the error code.
*/
function tribe_catch_and_throw( $errno, $errstr ) {
throw new RuntimeException( $errstr, $errno );
}
}
if ( ! function_exists( 'tribe_is_regex' ) ) {
/**
* Checks whether a candidate string is a valid regular expression or not.
*
* @since 4.9.5
*
* @param string $candidate The candidate string to check, it must include the
* regular expression opening and closing tags to validate.
*
* @return bool Whether a candidate string is a valid regular expression or not.
*/
function tribe_is_regex( $candidate ) {
if ( ! is_string( $candidate ) ) {
return false;
}
$n = strlen( $candidate );
// regex must be at least 2 delimiters + 1 character - invalid regex.
if ( $n < 3 ) {
return false;
}
// Missing or mismatched delimiters - invalid regex.
if ( $candidate[0] !== $candidate[ $n - 1 ] ) {
return false;
}
// We need to have the Try/Catch for Warnings too
try {
return ! ( @preg_match( $candidate, null ) === false );
} catch ( Exception $e ) {
return false;
}
}
}
if ( ! function_exists( 'tribe_unfenced_regex' ) ) {
/**
* Removes fence characters and modifiers from a regular expression string.
*
* Use this to go from a PCRE-format regex (PHP) to one SQL can understand.
*
* @since 4.9.5
*
* @param string $regex The input regular expression string.
*
* @return string The un-fenced regular expression string.
*/
function tribe_unfenced_regex( $regex ) {
if ( ! is_string( $regex ) ) {
return $regex;
}
$str_fence = $regex[0];
// Let's pick a fence char the string itself is not using.
$fence_char = '~' === $str_fence ? '#' : '~';
$pattern = $fence_char
. preg_quote( $str_fence, $fence_char ) // the opening fence
. '(.*)' // keep anything after the opening fence, group 1
. preg_quote( $str_fence, $fence_char ) // the closing fence
. '.*' // any modifier after the closing fence
. $fence_char;
return preg_replace( $pattern, '$1', $regex );
}
}
/**
* Create a function to mock the real function if the extension or Beta is not present.
*
*
*/
if ( ! function_exists( 'has_blocks' ) ) {
/**
* Determine whether a post or content string has blocks.
*
* This test optimizes for performance rather than strict accuracy, detecting
* the pattern of a block but not validating its structure. For strict accuracy
* you should use the block parser on post content.
*
* @since 4.8
*
* @see https://github.com/WordPress/gutenberg/blob/73d9759116dde896931f4d152f186147a57889fe/lib/register.php#L313-L337s
*
* @param int|string|WP_Post|null $post Optional. Post content, post ID, or post object. Defaults to global $post.
*
* @return bool Whether the post has blocks.
*/
function has_blocks( $post = null ) {
if ( ! is_string( $post ) ) {
$wp_post = get_post( $post );
if ( $wp_post instanceof WP_Post ) {
$post = $wp_post->post_content;
}
}
return false !== strpos( (string) $post, '<!-- wp:' );
}
}
if ( ! function_exists( 'tribe_register_rest_route' ) ) {
/**
* Wrapper function for `register_rest_route` to allow for filtering any Tribe REST API endpoint.
*
* @since 4.9.12
*
* @param string $route The base URL for route you are adding.
* @param array $args Optional. Either an array of options for the endpoint, or an array of arrays for
* multiple methods. Default empty array.
* @param bool $override Optional. If the route already exists, should we override it? True overrides,
* false merges (with newer overriding if duplicate keys exist). Default false.
*
* @param string $namespace The first URL segment after core prefix. Should be unique to your package/plugin.
*
* @return bool True on success, false on error.
*/
function tribe_register_rest_route( $namespace, $route, $args = [], $override = false ) {
/**
* Allow plugins to customize REST API arguments and callbacks.
*
* @since 4.9.12
*
* @param string $namespace The first URL segment after core prefix. Should be unique to your package/plugin.
* @param string $route The base URL for route you are adding.
* @param bool $override Optional. If the route already exists, should we override it? True overrides,
* false merges (with newer overriding if duplicate keys exist). Default false.
*
* @param array $args Either an array of options for the endpoint, or an array of arrays for
* multiple methods. Default empty array.
*/
$args = apply_filters( 'tribe_register_rest_route_args_' . $namespace . $route, $args, $namespace, $route, $override );
/**
* Allow plugins to customize REST API arguments and callbacks.
*
* @since 4.9.12
*
* @param string $namespace The first URL segment after core prefix. Should be unique to your package/plugin.
* @param string $route The base URL for route you are adding.
* @param bool $override Optional. If the route already exists, should we override it? True overrides,
* false merges (with newer overriding if duplicate keys exist). Default false.
*
* @param array $args Either an array of options for the endpoint, or an array of arrays for
* multiple methods. Default empty array.
*/
$args = apply_filters( 'tribe_register_rest_route_args', $args, $namespace, $route, $override );
// Compatibility with version 5.5 of WordPress to avoid notices.
if (
! empty( $args['callback'] )
&& is_callable( $args['callback'] )
&& ! isset( $args['permission_callback'] )
) {
$args['permission_callback'] = '__return_true';
}
return register_rest_route( $namespace, $route, $args, $override );
}
}
if ( ! function_exists( 'tribe_get_class_instance' ) ) {
/**
* Gets the class instance / Tribe Container from the passed object or string.
*
* @since 4.10.0
*
* @see \tad_DI52_Container::isBound()
* @see \tribe()
*
* @param string|object $class The plugin class' singleton name, class name, or instance.
*
* @return mixed|object|Tribe__Container|null Null if not found, else the result from tribe().
*/
function tribe_get_class_instance( $class ) {
if ( is_object( $class ) ) {
return $class;
}
if ( ! is_string( $class ) ) {
return null;
}
// Check if class exists and has instance getter method.
if ( class_exists( $class ) ) {
if ( method_exists( $class, 'instance' ) ) {
return $class::instance();
}
if ( method_exists( $class, 'get_instance' ) ) {
return $class::get_instance();
}
}
try {
return tribe( $class );
} catch ( \RuntimeException $exception ) {
return null;
}
}
}
if ( ! function_exists( 'tribe_get_least_version_ever_installed' ) ) {
/**
* Gets the lowest version number ever installed for the specified class of a plugin having a
* `version_history_slug` property or a `VERSION` constant (i.e. Main classes).
*
* If user initially installed v2, downgraded to v1, then updated to v3, this will return v1.
* If no historical version records, fallback is the class' current version.
* If no version info found, it will return false.
* Zero may have been logged as a past version but gets ignored.
*
* @since 4.10.0
*
* @param string|object $class The plugin class' singleton name, class name, or instance.
*
* @return string|boolean The SemVer version string or false if no info found.
*/
function tribe_get_least_version_ever_installed( $class ) {
if ( ! is_string( $class ) ) {
$class = get_class( $class );
if ( false === $class ) {
return false;
}
}
$history = tribe_plugin_version_history( $class );
// Try for the version history first.
if ( false !== $history ) {
// '0' may be logged as a version number, which isn't useful, so we remove it
$history = array_filter( $history );
$history = array_unique( $history );
if ( ! empty( $history ) ) {
// Sort the array so smallest version number is first (likely how the array is stored anyway)
usort( $history, 'version_compare' );
return array_shift( $history );
}
}
// Fall back to the current plugin version.
if ( defined( $class . '::VERSION' ) ) {
return $class::VERSION;
}
// No version set.
return false;
}
}
if ( ! function_exists( 'tribe_get_greatest_version_ever_installed' ) ) {
/**
* Gets the highest version number ever installed for the specified class of a plugin having a
* `version_history_slug` property or a `VERSION` constant (i.e. Main classes).
*
* If user initially installed v2, updated to v3, then downgraded to v2, this will return v3.
* If no historical version records, fallback is the class' current version.
* If no version info found, it will return false.
* Zero may have been logged as a past version but gets ignored.
*
* @since 4.10.0
*
* @see \tribe_get_currently_installed_version() To get the current version, even if it's not the greatest.
*
* @param string|object $class The plugin class' singleton name, class name, or instance.
*
* @return string|boolean The SemVer version string or false if no info found.
*/
function tribe_get_greatest_version_ever_installed( $class ) {
if ( ! is_string( $class ) ) {
$class = get_class( $class );
if ( false === $class ) {
return false;
}
}
$history = tribe_plugin_version_history( $class );
// Try for the version history first.
if ( false !== $history ) {
// '0' may be logged as a version number, which isn't useful, so we remove it
$history = array_filter( $history );
$history = array_unique( $history );
if ( ! empty( $history ) ) {
// Sort the array so smallest version number is first (likely how the array is stored anyway)
usort( $history, 'version_compare' );
return array_pop( $history );
}
}
// Fall back to the current plugin version.
if ( defined( $class . '::VERSION' ) ) {
return $class::VERSION;
}
// No version set.
return false;
}
}
/**
* Gets the plugin version history for a given main class.
*
* Important to note we cannot setup instances to get these values, we need to
* use static mapping here, since generating a full instance will effectively
* activate parts of the plugin behind the scenes.
*
* @since 4.12.14
*
* @param string $class Which plugin main class we are looking for.
*
* @return array|false
*/
function tribe_plugin_version_history( $class ) {
if ( ! is_string( $class ) ) {
$class = get_class( $class );
if ( false === $class ) {
return false;
}
}
$map = [
'Tribe__Events__Main' => 'previous_ecp_versions',
'Tribe__Tickets__Main' => 'previous_event_tickets_versions',
'tickets.main' => 'previous_event_tickets_versions',
'Tribe__Tickets_Plus__Main' => 'previous_event_tickets_plus_versions',
'tickets-plus.main' => 'previous_event_tickets_plus_versions',
];
if ( ! isset( $map[ $class ] ) ) {
return false;
}
return (array) Tribe__Settings_Manager::get_option( $map[ $class ] );
}
if ( ! function_exists( 'tribe_get_first_ever_installed_version' ) ) {
/**
* Gets the initially-recorded version number installed for the specified class of a plugin having a
* `version_history_slug` property or a `VERSION` constant (i.e. Main classes).
*
* If user initially installed v2, downgraded to v1, then updated to v3, this will return v2.
* If no historical version records, fallback is the class' current version.
* If no version info found, it will return false.
* Zero may have been logged as a past version but gets ignored.
*
* @since 4.10.0
*
* @param string|object $class The plugin class' singleton name, class name, or instance.
*
* @return string|boolean The SemVer version string or false if no info found.
*/
function tribe_get_first_ever_installed_version( $class ) {
if ( ! is_string( $class ) ) {
$class = get_class( $class );
if ( false === $class ) {
return false;
}
}
$history = tribe_plugin_version_history( $class );
// Try for the version history first.
if ( false !== $history ) {
// '0' may be logged as a version number, which isn't useful, so we remove it
while (
! empty( $history )
&& empty( $history[0] )
) {
array_shift( $history );
}
// Found it so return it
if ( ! empty( $history[0] ) ) {
return $history[0];
}
}
// Fall back to the current plugin version.
if ( defined( $class . '::VERSION' ) ) {
return $class::VERSION;
}
// No version set.
return false;
}
}
if ( ! function_exists( 'tribe_get_currently_installed_version' ) ) {
/**
* Gets the current version number installed for the specified class of a plugin having a
* `VERSION` constant (i.e. Main classes)--different logic than related functions.
*
* If user initially installed v2, downgraded to v1, then updated to v3, this will return v3.
* Only looks at the class' current version, else false.
*
* @since 4.10.0
*
* @see \tribe_get_greatest_version_ever_installed() To get the greatest ever installed, even if not the current.
*
* @param string|object $class The plugin class' singleton name, class name, or instance.
*
* @return string|boolean The SemVer version string or false if no info found.
*/
function tribe_get_currently_installed_version( $class ) {
$instance = tribe_get_class_instance( $class );
// First try for class constant (different logic from the other similar functions).
if ( defined( $class . '::VERSION' ) ) {
return $class::VERSION;
}
// No version set.
return false;
}
}
if ( ! function_exists( 'tribe_installed_before' ) ) {
/**
* Checks if a plugin's initially-installed version was prior to the passed version.
* If no info found, it will assume the plugin is old and return true.
*
* @since 4.10.0
*
* @param string|object $class The plugin class' singleton name, class name, or instance.
* @param string $version The SemVer version string to compare.
*
* @return boolean Whether the plugin was installed prior to the passed version.
*/
function tribe_installed_before( $class, $version ) {
$install_version = tribe_get_first_ever_installed_version( $class );
// If no install version, let's assume it's been here a while.
if ( empty( $install_version ) ) {
return true;
}
return 0 > version_compare( $install_version, $version );
}
}
if ( ! function_exists( 'tribe_installed_after' ) ) {
/**
* Checks if a plugin's initially-installed version was after the passed version.
* If no info found, it will assume the plugin is old and return false.
*
* @since 4.10.0
*
* @param string|object $class The plugin class' singleton name, class name, or instance.
* @param string $version The SemVer version string to compare.
*
* @return boolean Whether the plugin was installed after the passed version.
*/
function tribe_installed_after( $class, $version ) {
$install_version = tribe_get_first_ever_installed_version( $class );
// If no install version, let's assume it's been here a while.
if ( empty( $install_version ) ) {
return false;
}
return 0 < version_compare( $install_version, $version );
}
}
if ( ! function_exists( 'tribe_installed_on' ) ) {
/**
* Checks if a plugin was installed at/on the passed version.
* If no info found, it will assume the plugin is old and return false.
*
* @since 4.10.0
*
* @param string|object $class The plugin class' singleton name, class name, or instance.
* @param string $version The SemVer version string to compare.
*
* @return boolean Whether the plugin was installed at/on the passed version.
*/
function tribe_installed_on( $class, $version ) {
$install_version = tribe_get_first_ever_installed_version( $class );
// If no install version, let's assume it's been here a while.
if ( empty( $install_version ) ) {
return false;
}
return 0 === version_compare( $install_version, $version );
}
}
if ( ! function_exists( 'tribe_get_request_vars' ) ) {
/**
* Returns the sanitized version of the `$_REQUEST` super-global array.
*
* Note: the return value is cached. It will be resolve the first time the function is called, per HTTP request,
* then the same return value will be returned. After the function has been called the first time, changes to the
* `$_REQUEST` super-global will NOT be reflected in the function return value.
* Call the function with `$refresh` set to `true` to refresh the function value.
*
* @since 4.9.18
*
* @param bool $refresh Whether to parse the `$_REQUEST` cache again and refresh the cache or not; defaults to
* `false`.
*
* @return array The sanitized version of the `$_REQUEST` super-global.
*/
function tribe_get_request_vars( $refresh = false ) {
static $cache;
if ( ! isset( $_REQUEST ) ) {
return [];
}
if ( null !== $cache && ! $refresh ) {
return $cache;
}
$cache = array_combine(
array_keys( $_REQUEST ),
array_map( static function ( $v )
{
return filter_var( $v, FILTER_SANITIZE_STRING );
},
$_REQUEST )
);
return $cache;
}
}
if ( ! function_exists( 'tribe_sanitize_deep' ) ) {
/**
* Sanitizes a value according to its type.
*
* The function will recursively sanitize array values.
*
* @since 4.9.20
*
* @param mixed $value The value, or values, to sanitize.
*
* @return mixed|null Either the sanitized version of the value, or `null` if the value is not a string, number or
* array.
*/
function tribe_sanitize_deep( &$value ) {
if ( is_bool( $value ) ) {
return $value;
}
if ( is_string( $value ) ) {
$value = filter_var( $value, FILTER_SANITIZE_STRING, FILTER_FLAG_NO_ENCODE_QUOTES );
return $value;
}
if ( is_int( $value ) ) {
$value = filter_var( $value, FILTER_VALIDATE_INT );
return $value;
}
if ( is_float( $value ) ) {
$value = filter_var( $value, FILTER_VALIDATE_FLOAT );
return $value;
}
if ( is_array( $value ) ) {
array_walk( $value, 'tribe_sanitize_deep' );
return $value;
}
return null;
}
}
if ( ! function_exists( 'tribe_get_query_var' ) ) {
/**
* Returns a query var parsing an input URL.
*
* @since 4.9.23
*
* @param string $url The URL to parse.
* @param string|array $query_arg The query variable(s) to parse and return.
* @param mixed|null $default The default value to return if the URL cannot be parsed, or the query variable is
* not found.
*
* @return mixed|null The query variable value, if set, or the default value.
*/
function tribe_get_query_var( $url, $query_arg, $default = null ) {
if ( empty( $url ) ) {
return $default;
}
$query = wp_parse_url( $url, PHP_URL_QUERY );
if ( empty( $query ) ) {
return $default;
}
wp_parse_str( $query, $parsed );
if ( ! is_array( $query_arg ) ) {
return Tribe__Utils__Array::get( $parsed, $query_arg, $default );
}
$query_args = (array) ( $query_arg );
return array_intersect_key(
(array) $parsed,
array_combine( $query_args, $query_args )
);
}
}
if ( ! function_exists( 'tribe_without_filters' ) ) {
/**
* Runs a callback or Closure taking care to detach and reattach a set of filters.
*
* The purpose of this function is to make sure a certain callback will run in a "clean" filter environment where
* a set of filters (and actions) has been suspended to avoid side effects from applying to it.
* The function guarantees the existing filters will be detached and re-attached only to run the callback, avoiding
* issues where some piece of code might detach some filters and not re-attach them due to errors.
*
* @since 4.12.10
*
* @param array<string> $filters A set of filter, or actions, handles to detach before running the callback and
* re-attach after.
* @param callable $do The callback, or Closure, that should run in the context where the specified set of filters
* has been "suspended".
*
* @return mixed The result of the callback function.
*/
function tribe_without_filters( array $filters, callable $do ) {
$filter_backups = [];
// If none of the filters to skip has anything attached to it, then skip it.
$hooked_filters = array_filter( $filters, 'has_filter' );
if ( empty( $hooked_filters ) ) {
// No filter has functions attached to it, just return the callback invocation.
return $do();
}
foreach ( $hooked_filters as $tag ) {
$filter_backups[ $tag ] = $GLOBALS['wp_filter'][ $tag ];
// A `null` entry will be parsed, from filter API functions, as a filter that has nothing on it.
$GLOBALS['wp_filter'][ $tag ] = null;
}
$result = $do();
foreach ( $filter_backups as $tag => $filter_backup ) {
$GLOBALS['wp_filter'][ $tag ] = $filter_backup;
}
return $result;
}
/**
* Runs a callbacks while suspending, removing and re-adding, a filter or action.
*
* The function will infer the priority of the filter, required for its correct detachment and re-attachment, on
* its own.
*
* @since 4.12.12
*
* @param string $filter_tag The filter tag to suspend.
* @param callable $filter_callback The filter_callback currently attached to the filter.
* @param callable $do The filter_callback that will be run detaching the `$filter_callback`.
* @param int $args The number of arguments that should be used to re-attach the filtering callback to the filter.
*
* @return mixed The return value of the `$do` callback.
*/
function tribe_suspending_filter( $filter_tag, callable $filter_callback, callable $do, $args = 1 ) {
$priority = has_filter( $filter_tag, $filter_callback );
if ( false !== $priority ) {
remove_filter( $filter_tag, $filter_callback, $priority );
}
$result = $do();
if ( false !== $priority ) {
add_filter( $filter_tag, $filter_callback, $priority, $args );
}
return $result;
}
}
/**
* Get the next increment of a cached incremental value.
*
* @since 4.14.7
*
* @param string $key Cache key for the incrementor.
* @param string $expiration_trigger The trigger that causes the cache key to expire.
* @param int $default The default value of the incrementor.
*
* @return int
**/
function tribe_get_next_cached_increment( $key, $expiration_trigger = '', $default = 0 ) {
$cache = tribe( 'cache' );
$value = (int) $cache->get( $key, $expiration_trigger, $default );
$value++;
$cache->set( $key, $value, \Tribe__Cache::NON_PERSISTENT, $expiration_trigger );
return $value;
}
Mini Shell