| Current File : /home/bwalansa/www/wp-content/plugins/the-events-calendar.19/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
*
* @return bool Indicates if plugin should continue initialization
*/
function tribe_register_plugin( $file_path, $main_class, $version, $classes_req = array() ) {
$tribe_dependency = Tribe__Dependency::instance();
$should_plugin_run = true;
// Checks to see if the plugins are active
if ( ! empty( $classes_req ) && ! $tribe_dependency->has_requisite_plugins( $classes_req ) ) {
$should_plugin_run = false;
$tribe_plugins = new Tribe__Plugins();
$admin_notice = new Tribe__Admin__Notice__Plugin_Download( $file_path );
foreach ( $classes_req as $class => $version ) {
$plugin = $tribe_plugins->get_plugin_by_class( $class );
$is_active = $tribe_dependency->is_plugin_version( $class, $version );
$admin_notice->add_required_plugin( $plugin['short_name'], $plugin['thickbox_url'], $is_active );
}
}
if ( $should_plugin_run ) {
$tribe_dependency->add_active_plugin( $main_class, $version, $file_path );
}
return $should_plugin_run;
}
}
if ( ! function_exists( 'tribe_append_path' ) ) {
/**
* Append a path fragment to a URL preserving query arguments
* and fragments.
*
* @param string $url A full URL in the `http://example.com/?query=var#frag` format.
* @param string $path The path to append to the existing, if any, one., e.g. `/some/path`
*
* @return mixed|string
*
* @since 4.3
*/
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.
*
* @see Tribe__Utils__Array::get()
*
* @param string|array $var
* @param mixed $default
*
* @return mixed
*/
function tribe_get_request_var( $var, $default = null ) {
$post_var = Tribe__Utils__Array::get( $_POST, $var );
if ( null !== $post_var ) {
return $post_var;
}
$query_var = Tribe__Utils__Array::get( $_GET, $var );
if ( null !== $query_var ) {
return $query_var;
}
return $default;
}
}
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 object 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_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', array(
'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;
}
}
/**
* Sorting function based on Priority
*
* @since 4.7.20
*
* @param object|array $a First Subject to compare
* @param object|array $b Second 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;
}
return (int) $a_priority === (int) $b_priority ? 0 : (int) $a_priority > (int) $b_priority;
}
if ( ! function_exists( 'tribe_normalize_terms_list' ) ) {
/**
* Normalizes a list of terms to a list of fields.
*
* @param $terms A term or array of terms to normalize.
* @param string $taxonomy The terms taxonomy.
* @param string $field Teh fields the terms should be normalized to.
*
* @since 4.5
*
* @return array An array of the valid normalized terms.
*/
function tribe_normalize_terms_list( $terms, $taxonomy, $field = 'term_id' ) {
if ( ! is_array( $terms ) ) {
$terms = array( $terms );
}
$normalized = array();
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' ) ) {
/** * @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.
*
* @see Tribe__Image__Uploader::upload_and_get_attachment_id()
*/
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 = array();
$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 );
}
}