673 lines
18 KiB
PHP
673 lines
18 KiB
PHP
|
<?php declare(strict_types = 1);
|
||
|
|
/**
|
||
|
|
* General utilities class.
|
||
|
|
*
|
||
|
|
* @package query-monitor
|
||
|
|
*/
|
||
|
|
|
||
|
|
if ( ! class_exists( 'QM_Util' ) ) {
|
||
|
|
class QM_Util {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var array<string, QM_Component>
|
||
|
|
*/
|
||
|
|
protected static $file_components = array();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var array<string, string|null>
|
||
|
|
*/
|
||
|
|
protected static $file_dirs = array();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var string|null
|
||
|
|
*/
|
||
|
|
protected static $abspath = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var string|null
|
||
|
|
*/
|
||
|
|
protected static $contentpath = null;
|
||
|
|
|
||
|
|
private function __construct() {}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $size
|
||
|
|
* @return float
|
||
|
|
*/
|
||
|
|
public static function convert_hr_to_bytes( $size ) {
|
||
|
|
|
||
|
|
# Annoyingly, wp_convert_hr_to_bytes() is defined in a file that's only
|
||
|
|
# loaded in the admin area, so we'll use our own version.
|
||
|
|
# See also http://core.trac.wordpress.org/ticket/17725
|
||
|
|
|
||
|
|
$bytes = (float) $size;
|
||
|
|
|
||
|
|
if ( $bytes ) {
|
||
|
|
$last = strtolower( substr( $size, -1 ) );
|
||
|
|
$pos = strpos( ' kmg', $last, 1 );
|
||
|
|
if ( $pos ) {
|
||
|
|
$bytes *= pow( 1024, $pos );
|
||
|
|
}
|
||
|
|
$bytes = round( $bytes );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $bytes;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $dir
|
||
|
|
* @param string $path_replace
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public static function standard_dir( $dir, $path_replace = null ) {
|
||
|
|
|
||
|
|
$dir = self::normalize_path( $dir );
|
||
|
|
|
||
|
|
if ( is_string( $path_replace ) ) {
|
||
|
|
if ( ! self::$abspath ) {
|
||
|
|
self::$abspath = self::normalize_path( ABSPATH );
|
||
|
|
self::$contentpath = self::normalize_path( dirname( WP_CONTENT_DIR ) . '/' );
|
||
|
|
}
|
||
|
|
$dir = str_replace( array(
|
||
|
|
self::$abspath,
|
||
|
|
self::$contentpath,
|
||
|
|
), $path_replace, $dir );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $dir;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $path
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public static function normalize_path( $path ) {
|
||
|
|
if ( function_exists( 'wp_normalize_path' ) ) {
|
||
|
|
$path = wp_normalize_path( $path );
|
||
|
|
} else {
|
||
|
|
$path = str_replace( '\\', '/', $path );
|
||
|
|
$path = str_replace( '//', '/', $path );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $path;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return array<string, string|null>
|
||
|
|
*/
|
||
|
|
public static function get_file_dirs() {
|
||
|
|
if ( empty( self::$file_dirs ) ) {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Filters the absolute directory paths that correlate to components.
|
||
|
|
*
|
||
|
|
* Note that this filter is applied before QM adds its built-in list of components. This is
|
||
|
|
* so custom registered components take precedence during component detection.
|
||
|
|
*
|
||
|
|
* See also the corresponding filters:
|
||
|
|
*
|
||
|
|
* - `qm/component_context/{$type}`
|
||
|
|
* - `qm/component_name/{$type}`
|
||
|
|
*
|
||
|
|
* @since 3.6.0
|
||
|
|
*
|
||
|
|
* @param array<string, string|null> $dirs Array of absolute directory paths keyed by component identifier.
|
||
|
|
*/
|
||
|
|
self::$file_dirs = apply_filters( 'qm/component_dirs', self::$file_dirs );
|
||
|
|
|
||
|
|
self::$file_dirs['plugin'] = WP_PLUGIN_DIR;
|
||
|
|
self::$file_dirs['mu-vendor'] = WPMU_PLUGIN_DIR . '/vendor';
|
||
|
|
self::$file_dirs['go-plugin'] = WPMU_PLUGIN_DIR . '/shared-plugins';
|
||
|
|
self::$file_dirs['mu-plugin'] = WPMU_PLUGIN_DIR;
|
||
|
|
self::$file_dirs['vip-plugin'] = get_theme_root() . '/vip/plugins';
|
||
|
|
|
||
|
|
if ( defined( 'WPCOM_VIP_CLIENT_MU_PLUGIN_DIR' ) ) {
|
||
|
|
self::$file_dirs['vip-client-mu-plugin'] = WPCOM_VIP_CLIENT_MU_PLUGIN_DIR;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( defined( '\Altis\ROOT_DIR' ) ) {
|
||
|
|
self::$file_dirs['altis-vendor'] = \Altis\ROOT_DIR . '/vendor';
|
||
|
|
}
|
||
|
|
|
||
|
|
self::$file_dirs['theme'] = null;
|
||
|
|
self::$file_dirs['stylesheet'] = get_stylesheet_directory();
|
||
|
|
self::$file_dirs['template'] = get_template_directory();
|
||
|
|
self::$file_dirs['other'] = WP_CONTENT_DIR;
|
||
|
|
self::$file_dirs['core'] = ABSPATH;
|
||
|
|
self::$file_dirs['unknown'] = null;
|
||
|
|
|
||
|
|
foreach ( self::$file_dirs as $type => $dir ) {
|
||
|
|
if ( null === $dir ) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
self::$file_dirs[ $type ] = self::standard_dir( $dir );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return self::$file_dirs;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Attempts to determine the component responsible for a given file name.
|
||
|
|
*
|
||
|
|
* @param string $file An absolute file path.
|
||
|
|
* @return QM_Component An object representing the component.
|
||
|
|
*/
|
||
|
|
public static function get_file_component( $file ) {
|
||
|
|
$file = self::standard_dir( $file );
|
||
|
|
$type = '';
|
||
|
|
|
||
|
|
if ( isset( self::$file_components[ $file ] ) ) {
|
||
|
|
return self::$file_components[ $file ];
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ( self::get_file_dirs() as $type => $dir ) {
|
||
|
|
// this slash makes paths such as plugins-mu match mu-plugin not plugin
|
||
|
|
if ( $dir && ( 0 === strpos( $file, trailingslashit( $dir ) ) ) ) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$context = $type;
|
||
|
|
|
||
|
|
switch ( $type ) {
|
||
|
|
case 'altis-vendor':
|
||
|
|
$plug = str_replace( \Altis\ROOT_DIR . '/vendor/', '', $file );
|
||
|
|
$plug = explode( '/', $plug, 3 );
|
||
|
|
$plug = $plug[0] . '/' . $plug[1];
|
||
|
|
/* translators: %s: Dependency name */
|
||
|
|
$name = sprintf( __( 'Dependency: %s', 'query-monitor' ), $plug );
|
||
|
|
break;
|
||
|
|
case 'plugin':
|
||
|
|
case 'mu-plugin':
|
||
|
|
case 'mu-vendor':
|
||
|
|
$plug = str_replace( '/vendor/', '/', $file );
|
||
|
|
$plug = plugin_basename( $plug );
|
||
|
|
if ( strpos( $plug, '/' ) ) {
|
||
|
|
$plug = explode( '/', $plug );
|
||
|
|
$plug = reset( $plug );
|
||
|
|
} else {
|
||
|
|
$plug = basename( $plug );
|
||
|
|
}
|
||
|
|
if ( 'plugin' !== $type ) {
|
||
|
|
/* translators: %s: Plugin name */
|
||
|
|
$name = sprintf( __( 'MU Plugin: %s', 'query-monitor' ), $plug );
|
||
|
|
} else {
|
||
|
|
/* translators: %s: Plugin name */
|
||
|
|
$name = sprintf( __( 'Plugin: %s', 'query-monitor' ), $plug );
|
||
|
|
}
|
||
|
|
$context = $plug;
|
||
|
|
break;
|
||
|
|
case 'go-plugin':
|
||
|
|
case 'vip-plugin':
|
||
|
|
case 'vip-client-mu-plugin':
|
||
|
|
$plug = str_replace( self::$file_dirs[ $type ], '', $file );
|
||
|
|
$plug = trim( $plug, '/' );
|
||
|
|
if ( strpos( $plug, '/' ) ) {
|
||
|
|
$plug = explode( '/', $plug );
|
||
|
|
$plug = reset( $plug );
|
||
|
|
} else {
|
||
|
|
$plug = basename( $plug );
|
||
|
|
}
|
||
|
|
if ( 'vip-client-mu-plugin' === $type ) {
|
||
|
|
/* translators: %s: Plugin name */
|
||
|
|
$name = sprintf( __( 'VIP Client MU Plugin: %s', 'query-monitor' ), $plug );
|
||
|
|
} else {
|
||
|
|
/* translators: %s: Plugin name */
|
||
|
|
$name = sprintf( __( 'VIP Plugin: %s', 'query-monitor' ), $plug );
|
||
|
|
}
|
||
|
|
$context = $plug;
|
||
|
|
break;
|
||
|
|
case 'stylesheet':
|
||
|
|
if ( is_child_theme() ) {
|
||
|
|
$name = __( 'Child Theme', 'query-monitor' );
|
||
|
|
} else {
|
||
|
|
$name = __( 'Theme', 'query-monitor' );
|
||
|
|
}
|
||
|
|
$type = 'theme';
|
||
|
|
break;
|
||
|
|
case 'template':
|
||
|
|
$name = __( 'Parent Theme', 'query-monitor' );
|
||
|
|
$type = 'theme';
|
||
|
|
break;
|
||
|
|
case 'other':
|
||
|
|
// Anything else that's within the content directory should appear as
|
||
|
|
// `wp-content/{dir}` or `wp-content/{file}`
|
||
|
|
$name = self::standard_dir( $file );
|
||
|
|
$name = str_replace( dirname( self::$file_dirs['other'] ), '', $name );
|
||
|
|
$parts = explode( '/', trim( $name, '/' ) );
|
||
|
|
$name = $parts[0] . '/' . $parts[1];
|
||
|
|
$context = $file;
|
||
|
|
break;
|
||
|
|
case 'core':
|
||
|
|
$name = __( 'WordPress Core', 'query-monitor' );
|
||
|
|
break;
|
||
|
|
case 'unknown':
|
||
|
|
default:
|
||
|
|
$name = __( 'Unknown', 'query-monitor' );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Filters the type of a custom or unknown component.
|
||
|
|
*
|
||
|
|
* The dynamic portion of the hook name, `$type`, refers to the component identifier.
|
||
|
|
*
|
||
|
|
* See also the corresponding filters:
|
||
|
|
*
|
||
|
|
* - `qm/component_dirs`
|
||
|
|
* - `qm/component_name/{$type}`
|
||
|
|
* - `qm/component_context/{$type}`
|
||
|
|
*
|
||
|
|
* @since 3.8.1
|
||
|
|
*
|
||
|
|
* @param string $type The component type.
|
||
|
|
* @param string $file The full file path for the file within the component.
|
||
|
|
* @param string $name The component name.
|
||
|
|
* @param string $context The context for the component.
|
||
|
|
*/
|
||
|
|
$type = apply_filters( "qm/component_type/{$type}", $type, $file, $name, $context );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Filters the name of a custom or unknown component.
|
||
|
|
*
|
||
|
|
* The dynamic portion of the hook name, `$type`, refers to the component identifier.
|
||
|
|
*
|
||
|
|
* See also the corresponding filters:
|
||
|
|
*
|
||
|
|
* - `qm/component_dirs`
|
||
|
|
* - `qm/component_type/{$type}`
|
||
|
|
* - `qm/component_context/{$type}`
|
||
|
|
*
|
||
|
|
* @since 3.6.0
|
||
|
|
*
|
||
|
|
* @param string $name The component name.
|
||
|
|
* @param string $file The full file path for the file within the component.
|
||
|
|
*/
|
||
|
|
$name = apply_filters( "qm/component_name/{$type}", $name, $file );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Filters the context for a custom or unknown component. The context is usually a
|
||
|
|
* representation of its type more specific to the individual component.
|
||
|
|
*
|
||
|
|
* The dynamic portion of the hook name, `$type`, refers to the component identifier.
|
||
|
|
*
|
||
|
|
* See also the corresponding filters:
|
||
|
|
*
|
||
|
|
* - `qm/component_dirs`
|
||
|
|
* - `qm/component_type/{$type}`
|
||
|
|
* - `qm/component_name/{$type}`
|
||
|
|
*
|
||
|
|
* @since 3.8.0
|
||
|
|
*
|
||
|
|
* @param string $context The context for the component.
|
||
|
|
* @param string $file The full file path for the file within the component.
|
||
|
|
* @param string $name The component name.
|
||
|
|
*/
|
||
|
|
$context = apply_filters( "qm/component_context/{$type}", $context, $file, $name );
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
$component = new QM_Component();
|
||
|
|
$component->type = $type;
|
||
|
|
$component->name = $name;
|
||
|
|
$component->context = $context;
|
||
|
|
|
||
|
|
self::$file_components[ $file ] = $component;
|
||
|
|
|
||
|
|
return self::$file_components[ $file ];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param array<string, mixed> $callback
|
||
|
|
* @return array<string, mixed>
|
||
|
|
* @phpstan-return array{
|
||
|
|
* name?: string,
|
||
|
|
* file?: string|false,
|
||
|
|
* line?: string|false,
|
||
|
|
* error?: WP_Error,
|
||
|
|
* component?: QM_Component,
|
||
|
|
* }
|
||
|
|
*/
|
||
|
|
public static function populate_callback( array $callback ) {
|
||
|
|
|
||
|
|
if ( is_string( $callback['function'] ) && ( false !== strpos( $callback['function'], '::' ) ) ) {
|
||
|
|
$callback['function'] = explode( '::', $callback['function'] );
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( isset( $callback['class'] ) ) {
|
||
|
|
$callback['function'] = array(
|
||
|
|
$callback['class'],
|
||
|
|
$callback['function'],
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
try {
|
||
|
|
|
||
|
|
if ( is_array( $callback['function'] ) ) {
|
||
|
|
if ( is_object( $callback['function'][0] ) ) {
|
||
|
|
$class = get_class( $callback['function'][0] );
|
||
|
|
$access = '->';
|
||
|
|
} else {
|
||
|
|
$class = $callback['function'][0];
|
||
|
|
$access = '::';
|
||
|
|
}
|
||
|
|
|
||
|
|
$callback['name'] = self::shorten_fqn( $class . $access . $callback['function'][1] ) . '()';
|
||
|
|
$ref = new ReflectionMethod( $class, $callback['function'][1] );
|
||
|
|
} elseif ( is_object( $callback['function'] ) ) {
|
||
|
|
if ( $callback['function'] instanceof Closure ) {
|
||
|
|
$ref = new ReflectionFunction( $callback['function'] );
|
||
|
|
$filename = $ref->getFileName();
|
||
|
|
|
||
|
|
if ( $filename ) {
|
||
|
|
$file = self::standard_dir( $filename, '' );
|
||
|
|
if ( 0 === strpos( $file, '/' ) ) {
|
||
|
|
$file = basename( $filename );
|
||
|
|
}
|
||
|
|
$callback['name'] = sprintf(
|
||
|
|
/* translators: A closure is an anonymous PHP function. 1: Line number, 2: File name */
|
||
|
|
__( 'Closure on line %1$d of %2$s', 'query-monitor' ),
|
||
|
|
$ref->getStartLine(),
|
||
|
|
$file
|
||
|
|
);
|
||
|
|
} else {
|
||
|
|
/* translators: A closure is an anonymous PHP function */
|
||
|
|
$callback['name'] = __( 'Unknown closure', 'query-monitor' );
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
// the object should have a __invoke() method
|
||
|
|
$class = get_class( $callback['function'] );
|
||
|
|
$callback['name'] = self::shorten_fqn( $class ) . '->__invoke()';
|
||
|
|
$ref = new ReflectionMethod( $class, '__invoke' );
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$callback['name'] = self::shorten_fqn( $callback['function'] ) . '()';
|
||
|
|
$ref = new ReflectionFunction( $callback['function'] );
|
||
|
|
}
|
||
|
|
|
||
|
|
$callback['file'] = $ref->getFileName();
|
||
|
|
$callback['line'] = $ref->getStartLine();
|
||
|
|
|
||
|
|
// https://github.com/facebook/hhvm/issues/5856
|
||
|
|
$name = trim( $ref->getName() );
|
||
|
|
|
||
|
|
if ( '__lambda_func' === $name || 0 === strpos( $name, 'lambda_' ) ) {
|
||
|
|
if ( $callback['file'] && preg_match( '|(?P<file>.*)\((?P<line>[0-9]+)\)|', $callback['file'], $matches ) ) {
|
||
|
|
$callback['file'] = $matches['file'];
|
||
|
|
$callback['line'] = $matches['line'];
|
||
|
|
$file = trim( self::standard_dir( $callback['file'], '' ), '/' );
|
||
|
|
/* translators: 1: Line number, 2: File name */
|
||
|
|
$callback['name'] = sprintf( __( 'Anonymous function on line %1$d of %2$s', 'query-monitor' ), $callback['line'], $file );
|
||
|
|
} else {
|
||
|
|
// https://github.com/facebook/hhvm/issues/5807
|
||
|
|
unset( $callback['line'], $callback['file'] );
|
||
|
|
$callback['name'] = $name . '()';
|
||
|
|
$callback['error'] = new WP_Error( 'unknown_lambda', __( 'Unable to determine source of lambda function', 'query-monitor' ) );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( ! empty( $callback['file'] ) ) {
|
||
|
|
$callback['component'] = self::get_file_component( $callback['file'] );
|
||
|
|
} else {
|
||
|
|
$callback['component'] = new QM_Component();
|
||
|
|
$callback['component']->type = 'php';
|
||
|
|
$callback['component']->name = 'PHP';
|
||
|
|
$callback['component']->context = '';
|
||
|
|
}
|
||
|
|
} catch ( ReflectionException $e ) {
|
||
|
|
|
||
|
|
$callback['error'] = new WP_Error( 'reflection_exception', $e->getMessage() );
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
unset( $callback['function'], $callback['class'] );
|
||
|
|
|
||
|
|
return $callback;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function is_ajax() {
|
||
|
|
if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function is_async() {
|
||
|
|
if ( self::is_ajax() ) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
if ( isset( $_SERVER['HTTP_X_REQUESTED_WITH'] ) && 'xmlhttprequest' === strtolower( $_SERVER['HTTP_X_REQUESTED_WITH'] ) ) { // phpcs:ignore
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return WP_Role|false
|
||
|
|
*/
|
||
|
|
public static function get_admins() {
|
||
|
|
if ( is_multisite() ) {
|
||
|
|
return false;
|
||
|
|
} else {
|
||
|
|
return get_role( 'administrator' );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function is_multi_network() {
|
||
|
|
return ( function_exists( 'is_multi_network' ) && is_multi_network() );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param int|string $client
|
||
|
|
* @return array<string, int>
|
||
|
|
* @phpstan-return array{
|
||
|
|
* major: int,
|
||
|
|
* minor: int,
|
||
|
|
* patch: int,
|
||
|
|
* }
|
||
|
|
*/
|
||
|
|
public static function get_client_version( $client ) {
|
||
|
|
|
||
|
|
$client = intval( $client );
|
||
|
|
|
||
|
|
$hello = $client % 10000;
|
||
|
|
|
||
|
|
$major = intval( floor( $client / 10000 ) );
|
||
|
|
$minor = intval( floor( $hello / 100 ) );
|
||
|
|
$patch = intval( $hello % 100 );
|
||
|
|
|
||
|
|
return compact( 'major', 'minor', 'patch' );
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $sql
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public static function get_query_type( $sql ) {
|
||
|
|
// Trim leading whitespace and brackets
|
||
|
|
$sql = ltrim( $sql, ' \t\n\r\0\x0B(' );
|
||
|
|
|
||
|
|
if ( 0 === strpos( $sql, '/*' ) ) {
|
||
|
|
// Strip out leading comments such as `/*NO_SELECT_FOUND_ROWS*/` before calculating the query type
|
||
|
|
$sql = preg_replace( '|^/\*[^\*/]+\*/|', '', $sql );
|
||
|
|
}
|
||
|
|
|
||
|
|
$words = preg_split( '/\b/', trim( $sql ), 2, PREG_SPLIT_NO_EMPTY );
|
||
|
|
$type = 'Unknown';
|
||
|
|
|
||
|
|
if ( is_array( $words ) && isset( $words[0] ) ) {
|
||
|
|
$type = strtoupper( $words[0] );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $type;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param mixed $value
|
||
|
|
* @return string|float|int
|
||
|
|
*/
|
||
|
|
public static function display_variable( $value ) {
|
||
|
|
if ( is_string( $value ) ) {
|
||
|
|
return $value;
|
||
|
|
} elseif ( $value === null ) {
|
||
|
|
return 'null';
|
||
|
|
} elseif ( is_bool( $value ) ) {
|
||
|
|
return ( $value ) ? 'true' : 'false';
|
||
|
|
} elseif ( is_scalar( $value ) ) {
|
||
|
|
return $value;
|
||
|
|
} elseif ( is_object( $value ) ) {
|
||
|
|
$class = get_class( $value );
|
||
|
|
|
||
|
|
switch ( true ) {
|
||
|
|
|
||
|
|
case ( $value instanceof WP_Post ):
|
||
|
|
case ( $value instanceof WP_User ):
|
||
|
|
$class = sprintf( '%s (ID: %s)', $class, $value->ID );
|
||
|
|
break;
|
||
|
|
|
||
|
|
case ( $value instanceof WP_Term ):
|
||
|
|
$class = sprintf( '%s (term_id: %s)', $class, $value->term_id );
|
||
|
|
break;
|
||
|
|
|
||
|
|
case ( $value instanceof WP_Comment ):
|
||
|
|
$class = sprintf( '%s (comment_ID: %s)', $class, $value->comment_ID );
|
||
|
|
break;
|
||
|
|
|
||
|
|
case ( $value instanceof WP_Error ):
|
||
|
|
$class = sprintf( '%s (%s)', $class, $value->get_error_code() );
|
||
|
|
break;
|
||
|
|
|
||
|
|
case ( $value instanceof WP_Role ):
|
||
|
|
case ( $value instanceof WP_Post_Type ):
|
||
|
|
case ( $value instanceof WP_Taxonomy ):
|
||
|
|
$class = sprintf( '%s (%s)', $class, $value->name );
|
||
|
|
break;
|
||
|
|
|
||
|
|
case ( $value instanceof WP_Network ):
|
||
|
|
$class = sprintf( '%s (id: %s)', $class, $value->id );
|
||
|
|
break;
|
||
|
|
|
||
|
|
case ( $value instanceof WP_Site ):
|
||
|
|
$class = sprintf( '%s (blog_id: %s)', $class, $value->blog_id );
|
||
|
|
break;
|
||
|
|
|
||
|
|
case ( $value instanceof WP_Theme ):
|
||
|
|
$class = sprintf( '%s (%s)', $class, $value->get_stylesheet() );
|
||
|
|
break;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
return $class;
|
||
|
|
} else {
|
||
|
|
return gettype( $value );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Shortens a fully qualified name to reduce the length of the names of long namespaced symbols.
|
||
|
|
*
|
||
|
|
* This initialises portions that do not form the first or last portion of the name. For example:
|
||
|
|
*
|
||
|
|
* Inpsyde\Wonolog\HookListener\HookListenersRegistry->hook_callback()
|
||
|
|
*
|
||
|
|
* becomes:
|
||
|
|
*
|
||
|
|
* Inpsyde\W\H\HookListenersRegistry->hook_callback()
|
||
|
|
*
|
||
|
|
* @param string $fqn A fully qualified name.
|
||
|
|
* @return string A shortened version of the name.
|
||
|
|
*/
|
||
|
|
public static function shorten_fqn( $fqn ) {
|
||
|
|
if ( substr_count( $fqn, '\\' ) < 3 ) {
|
||
|
|
return $fqn;
|
||
|
|
}
|
||
|
|
|
||
|
|
return preg_replace_callback( '#\\\\[a-zA-Z0-9_\\\\]{4,}\\\\#', function( array $matches ) {
|
||
|
|
preg_match_all( '#\\\\([a-zA-Z0-9_])#', $matches[0], $m );
|
||
|
|
return '\\' . implode( '\\', $m[1] ) . '\\';
|
||
|
|
}, $fqn );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper function for JSON encoding data and formatting it in a consistent manner.
|
||
|
|
*
|
||
|
|
* @param mixed $data The data to be JSON encoded.
|
||
|
|
* @return string The JSON encoded data.
|
||
|
|
*/
|
||
|
|
public static function json_format( $data ) {
|
||
|
|
// phpcs:ignore PHPCompatibility.Constants.NewConstants.json_unescaped_slashesFound
|
||
|
|
$json_options = JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES;
|
||
|
|
|
||
|
|
$json = json_encode( $data, $json_options );
|
||
|
|
|
||
|
|
if ( false === $json ) {
|
||
|
|
return '';
|
||
|
|
}
|
||
|
|
|
||
|
|
return $json;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the site editor URL for a given template or template part name.
|
||
|
|
*
|
||
|
|
* @param string $template The site template name, for example `twentytwentytwo//header-small-dark`.
|
||
|
|
* @param string $type The template type, either 'wp_template_part' or 'wp_template'.
|
||
|
|
* @return string The admin URL for editing the site template.
|
||
|
|
*/
|
||
|
|
public static function get_site_editor_url( string $template, string $type = 'wp_template_part' ): string {
|
||
|
|
return add_query_arg(
|
||
|
|
array(
|
||
|
|
'postType' => $type,
|
||
|
|
'postId' => urlencode( $template ),
|
||
|
|
'canvas' => 'edit',
|
||
|
|
),
|
||
|
|
admin_url( 'site-editor.php' )
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @deprecated
|
||
|
|
* @param mixed $data
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function is_stringy( $data ) {
|
||
|
|
return ( is_string( $data ) || ( is_object( $data ) && method_exists( $data, '__toString' ) ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param mixed[] $array
|
||
|
|
* @param string $field
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public static function sort( array &$array, $field ) {
|
||
|
|
usort( $array, function( array $a, array $b ) use ( $field ): int {
|
||
|
|
return $a[ $field ] <=> $b[ $field ];
|
||
|
|
} );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param mixed[] $array
|
||
|
|
* @param string $field
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public static function rsort( array &$array, $field ) {
|
||
|
|
usort( $array, function( array $a, array $b ) use ( $field ): int {
|
||
|
|
return $b[ $field ] <=> $a[ $field ];
|
||
|
|
} );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|