functions.php

<?php
/**
 * Global functions.
 *
 * @package Functions
 * @author  Pierre Lannoy <https://pierre.lannoy.fr/>.
 * @since   2.0.0
 */

if ( ! function_exists('decalog_get_psr_log_version') ) {
	/**
	 * Get the needed version of PSR-3.
	 *
	 * @return  int  The PSR-3 needed version.
	 * @since 4.0.0
	 */
	function decalog_get_psr_log_version() {
		$required = 1;
		if ( ! defined( 'DECALOG_PSR_LOG_VERSION') ) {
			define( 'DECALOG_PSR_LOG_VERSION', 'V1' );
		}
		switch ( strtolower( DECALOG_PSR_LOG_VERSION ) ) {
			case 'v3':
				$required = 3;
				break;
			case 'auto':
				if ( class_exists( '\Psr\Log\NullLogger') ) {
					$reflection = new \ReflectionMethod(\Psr\Log\NullLogger::class, 'log');
					foreach ( $reflection->getParameters() as $param ) {
						if ( 'message' === $param->getName() ) {
							if ( str_contains($param->getType() ?? '', '|') ) {
								$required = 3;
							}
						}
					}
				}
		}
		return $required;
	}
}

/**
 * Multibyte String Pad
 *
 * Functionally, the equivalent of the standard str_pad function, but is capable of successfully padding multibyte strings.
 *
 * @param string $input The string to be padded.
 * @param int $length The length of the resultant padded string.
 * @param string $padding The string to use as padding. Defaults to space.
 * @param int $padType The type of padding. Defaults to STR_PAD_RIGHT.
 * @param string $encoding The encoding to use, defaults to UTF-8.
 *
 * @return string A padded multibyte string.
 * @since   2.0.0
 */
function decalog_mb_str_pad( $input, $length, $padding = ' ', $padType = STR_PAD_RIGHT, $encoding = 'UTF-8' ) {
	$result = $input;
	if ( ( $padding_required = $length - mb_strlen( $input, $encoding ) ) > 0 ) {
		switch ( $padType ) {
			case STR_PAD_LEFT:
				$result =
					mb_substr( str_repeat( $padding, $padding_required ), 0, $padding_required, $encoding ) .
					$input;
				break;
			case STR_PAD_RIGHT:
				$result =
					$input .
					mb_substr( str_repeat( $padding, $padding_required ), 0, $padding_required, $encoding );
				break;
			case STR_PAD_BOTH:
				$left_padding_length  = floor( $padding_required / 2 );
				$right_padding_length = $padding_required - $left_padding_length;
				$result               =
					mb_substr( str_repeat( $padding, $left_padding_length ), 0, $left_padding_length, $encoding ) .
					$input .
					mb_substr( str_repeat( $padding, $right_padding_length ), 0, $right_padding_length, $encoding );
				break;
		}
	}
	return $result;
}

/**
 * Multibyte full trim
 *
 * Functionally, the equivalent of the standard str_pad function, but is capable of successfully padding multibyte strings.
 *
 * @param string $input         The string to be fully trimed.
 * @param string $replacement   Optional. The string replacement.
 *
 * @return string A fully trimed multibyte string.
 * @since   3.6.0
 */
function decalog_mb_full_trim( $input, $replacement = '' ) {
	return preg_replace(
		"/(\t|\n|\v|\f|\r| |\xC2\x85|\xc2\xa0|\xe1\xa0\x8e|\xe2\x80[\x80-\x8D]|\xe2\x80\xa8|\xe2\x80\xa9|\xe2\x80\xaF|\xe2\x81\x9f|\xe2\x81\xa0|\xe3\x80\x80|\xef\xbb\xbf)+/",
		$replacement,
		$input
	);
}

/**
 * Performs an HTTP request using the PUT method and returns its response.
 * Mimics wp_remote_get or wp_remote_post, but for PUT method.
 *
 * @since 3.0.0
 *
 * @see wp_remote_request() For more information on the response array format.
 * @see WP_Http::request() For default arguments information.
 *
 * @param string $url  URL to retrieve.
 * @param array  $args Optional. Request arguments. Default empty array.
 * @return array|WP_Error The response or WP_Error on failure.
 */
function decalog_remote_put( $url, $args = [] ) {
	$http = _wp_http_get_object();
	if ( isset( $http ) ) {
		$defaults    = [ 'method' => 'PUT' ];
		$parsed_args = wp_parse_args( $args, $defaults );
		return $http->request( $url, $parsed_args );
	}
	return new WP_Error( 500 );
}

/**
 * Verify if a resource is a shmop resource.
 *
 * @since 3.6.0
 *
 * @param mixed     $value  URL to retrieve.
 * @return bool     True if it's a shmop resource, false otherwise.
 */
function decalog_is_shmop_resource( $value ) {
	if ( class_exists( 'Shmop' ) ) {
		return $value instanceof Shmop;
	}
	return ( is_resource( $value ) );
}

/**
 * Provide a replacement for filter_var() used with FILTER_SANITIZE_STRING flag (was legit with PHP prior to 8.1).
 */
function decalog_filter_string( string $string ) {
	return preg_replace( '/\x00|<[^>]*>?/', '', $string );
}

/**
 * Verify if wp-cli colorization is needed.
 */
function decalog_is_wpcli_colorized() {
	global $argv;
	foreach ( $argv as $arg ) {
		if ( '--NO-COLOR' === strtoupper( $arg ) ) {
			return false;
		}
		if ( '--COLOR' === strtoupper( $arg ) ) {
			return true;
		}
	}
	return false;
}

/**
 * Normalize extended fields.
 */
function decalog_normalize_extended_fields( string $extended ) {
	$result = [];
	foreach ( explode ( PHP_EOL, $extended ) as $line ) {
		$pair = explode ( '=', $line );
		if ( 2 === count( $pair ) ) {
			$result[ trim ( $pair[0] ) ] = is_numeric( $pair[1] ) ? $pair[1] : trim ( $pair[1] );
		}
	}

	return $result;
}

/**
 * Retrieves the translation of $text.
 *
 * This function is a wrapper for the "real" WP function behind this.
 *
 * @since 4.3.0
 *
 * @param string $text   Text to translate.
 * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
 *                       Default 'default'.
 * @return string Translated text.
 */
function decalog__( $text, $domain = 'default' ) {
	if ( ! doing_action( 'after_setup_theme' ) && ! did_action( 'after_setup_theme' ) ) {
		return $text;
	}
	return translate( $text, $domain );
}

/**
 * Retrieves the translation of $text and escapes it for safe use in HTML output.
 *
 * This function is a wrapper for the "real" WP function behind this.
 *
 * @since 4.3.0
 *
 * @param string $text   Text to translate.
 * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
 *                       Default 'default'.
 * @return string Translated text.
 */
function decalog_esc_html__( $text, $domain = 'default' ) {
	return esc_html( decalog__( $text, $domain ) );
}