context = 'Charitable';
}
/**
* Create and return the class object.
*
* @since 1.4.0
*
* @return Charitable_Deprecated
*/
public static function get_instance() {
if ( is_null( self::$instance ) ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Log a deprecated argument.
*
* @since 1.4.0
*
* @param string $function The deprecated function.
* @param string $version The version when this argument became deprecated.
* @param string|null $extra_message An extra message to include for the notice.
* @return boolean Whether the notice was logged.
*/
public function deprecated_argument( $function, $version, $extra_message = null ) {
if ( ! $this->is_logging_enabled() ) {
return false;
}
if ( ! is_null( $extra_message ) ) {
$message = sprintf( __( '%1$s was called with an argument that is deprecated since version %2$s of %4$s! %3$s', 'charitable' ), $function, $version, $extra_message, $this->context );
} else {
$message = sprintf( __( '%1$s was called with an argument that is deprecated since version %2$s of %3$s with no alternatives available.', 'charitable' ), $function, $version, $this->context );
}
trigger_error( $message );
return true;
}
/**
* Log a deprecated function.
*
* @since 1.4.0
*
* @param string $function The function that has been deprecated.
* @param string $version The version of Charitable where the function was deprecated.
* @param string|null $replacement Optional. The function to use instead.
* @return boolean Whether the notice was logged.
*/
public function deprecated_function( $function, $version, $replacement = null ) {
if ( ! $this->is_logging_enabled() ) {
return false;
}
if ( ! is_null( $replacement ) ) {
$message = sprintf( __( '%1$s is deprecated since version %2$s of %4$s! Use %3$s instead.', 'charitable' ), $function, $version, $replacement, $this->context );
} else {
$message = sprintf( __( '%1$s is deprecated since version %2$s of %3$s with no alternatives available.', 'charitable' ), $function, $version, $this->context );
}
trigger_error( $message );
return true;
}
/**
* Log a general "doing it wrong" notice.
*
* @since 1.4.0
*
* @param string $function The function with the problem.
* @param string $message An error message.
* @param string $version The version in which this error message was addd.
* @return boolean Whether the notice was logged.
*/
public function doing_it_wrong( $function, $message, $version ) {
if ( ! $this->is_logging_enabled() ) {
return false;
}
$version = is_null( $version ) ? '' : sprintf( __( '(This message was added in %s version %s.)', 'charitable' ), $this->context, $version );
$message = sprintf( __( '%1$s was called incorrectly. %2$s %3$s', 'charitable' ), $function, $message, $version );
trigger_error( $message );
return true;
}
/**
* Returns whether logging is enabled.
*
* @since 1.4.0
*
* @return boolean
*/
private function is_logging_enabled() {
if ( ! isset( self::$logging ) ) {
self::$logging = WP_DEBUG && apply_filters( 'charitable_log_deprecated_notices', true );
}
return self::$logging;
}
}
endif;