upskill-event-manager/wordpress-dev/wordpress/wp-content/plugins/user-registration/includes/functions-ur-deprecated.php
bengizmo d1509b3d60 feat(dev-env): implement backup-based development workflow
This commit introduces a more reliable and consistent approach to setting up
the development environment using backups:

- Add setup-from-backup.sh script for environment setup from existing backups
- Standardize script naming and organization
- Move obsolete scripts to bin/obsolete directory
- Update documentation with new workflow instructions
- Create migration guide for transitioning to new workflow
- Update Memory Bank with workflow improvements

The new workflow provides:
- More reliable environment setup
- Faster setup process
- Offline development capability
- Consistent development environments across team members

Breaking changes:
- setup-dev.sh is replaced by setup-from-backup.sh
- sync-and-setup.sh is replaced by separate scripts
- verify-with-wpcli.sh is no longer used

Migration path is documented in MIGRATION_GUIDE.md
2025-03-26 11:26:18 -03:00

196 lines
7.7 KiB
PHP

<?php
/**
* Deprecated Functions
*
* Where functions come to die.
*
* @package EverestForms\Functions
* @version 1.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Runs a deprecated action with notice only if used.
*
* @since 1.0.0
* @param string $tag The name of the action hook.
* @param array $args Array of additional function arguments to be passed to do_action().
* @param string $version The version of EverestForms that deprecated the hook.
* @param string $replacement The hook that should have been used.
* @param string $message A message regarding the change.
*/
function ur_do_deprecated_action( $tag, $args, $version, $replacement = null, $message = null ) {
if ( ! has_action( $tag ) ) {
return;
}
ur_deprecated_hook( $tag, $version, $replacement, $message );
do_action_ref_array( $tag, $args );
}
/**
* Wrapper for deprecated functions so we can apply some extra logic.
*
* @since 1.0.0
* @param string $function Function used.
* @param string $version Version the message was added in.
* @param string $replacement Replacement for the called function.
*/
function ur_deprecated_function( $function, $version, $replacement = null ) {
// @codingStandardsIgnoreStart
if ( wp_doing_ajax() ) {
/**
* Fires an action when a deprecated function is run.
*
* The 'deprecated_function_run' action allows developers to hook into the point
* where a deprecated function is executed. It provides information about the
* deprecated function, its recommended replacement, and the version at which it
* was deprecated.
*
* @param string $function The name of the deprecated function being executed.
* @param string $replacement The recommended replacement for the deprecated function.
* @param string $version The version at which the function was deprecated.
*/
do_action( 'deprecated_function_run', $function, $replacement, $version );
$log_string = "The {$function} function is deprecated since version {$version}.";
$log_string .= $replacement ? " Replace with {$replacement}." : '';
error_log( $log_string );
} else {
_deprecated_function( $function, $version, $replacement );
}
// @codingStandardsIgnoreEnd
}
/**
* Wrapper for deprecated hook so we can apply some extra logic.
*
* @since 1.0.0
* @param string $hook The hook that was used.
* @param string $version The version of User Registration that deprecated the hook.
* @param string $replacement The hook that should have been used.
* @param string $message A message regarding the change.
*/
function ur_deprecated_hook( $hook, $version, $replacement = null, $message = null ) {
// @codingStandardsIgnoreStart
if ( wp_doing_ajax() ) {
/**
* Fires an action when a deprecated hook is run.
*
* The 'deprecated_hook_run' action allows developers to hook into the point
* where a deprecated hook is executed. It provides information about the
* deprecated hook, its recommended replacement, the version at which it was
* deprecated, and an optional custom deprecation message.
*
* @param string $hook The name of the deprecated hook being executed.
* @param string $replacement The recommended replacement for the deprecated hook.
* @param string $version The version at which the hook was deprecated.
* @param string $message Optional. Custom deprecation message.
*/
do_action( 'deprecated_hook_run', $hook, $replacement, $version, $message );
$message = empty( $message ) ? '' : ' ' . $message;
$log_string = "{$hook} is deprecated since version {$version}";
$log_string .= $replacement ? "! Use {$replacement} instead." : ' with no alternative available.';
error_log( $log_string . $message );
} else {
_deprecated_hook( $hook, $version, $replacement, $message );
}
// @codingStandardsIgnoreEnd
}
/**
* When catching an exception, this allows us to log it if unexpected.
*
* @since 1.0.0
* @param Exception $exception_object The exception object.
* @param string $function The function which threw exception.
* @param array $args The args passed to the function.
*/
function ur_caught_exception( $exception_object, $function = '', $args = array() ) {
// @codingStandardsIgnoreStart
$message = $exception_object->getMessage();
$message .= '. Args: ' . print_r( $args, true ) . '.';
ur_do_deprecated_action( 'everest_forms_caught_exception', array( $exception_object, $function, $args ), '1.8.6', 'user_registration_caught_exception' );
/**
* Fires an action when an exception is caught.
*
* The 'user_registration_caught_exception' action allows developers to hook into the point
* where an exception is caught in the User Registration plugin. It provides information about
* the exception object, the function where the exception occurred, and the arguments passed to
* that function.
*
* @param Exception $exception_object The caught exception object.
* @param string $function The name of the function where the exception occurred.
* @param array $args The arguments passed to the function.
*/
do_action( 'user_registration_caught_exception', $exception_object, $function, $args );
error_log( "Exception caught in {$function}. {$message}." );
// @codingStandardsIgnoreEnd
}
/**
* Wrapper for ur_doing_it_wrong.
*
* @since 1.0.0
* @param string $function Function used.
* @param string $message Message to log.
* @param string $version Version the message was added in.
*/
function ur_deprecated_doing_it_wrong( $function, $message, $version ) {
// @codingStandardsIgnoreStart
$message .= ' Backtrace: ' . wp_debug_backtrace_summary();
if ( wp_doing_ajax() ) {
/**
* Fires an action when a deprecated function is used incorrectly.
*
* The 'doing_it_wrong_run' action allows developers to hook into the point where
* a deprecated function is used incorrectly. It provides information about the
* deprecated function, the associated error message, and the version at which it
* was deprecated.
*
* @param string $function The name of the deprecated function used incorrectly.
* @param string $message The error message associated with using the function incorrectly.
* @param string $version The version at which the function was deprecated.
*/
do_action( 'doing_it_wrong_run', $function, $message, $version );
error_log( "{$function} was called incorrectly. {$message}. This message was added in version {$version}." );
} else {
_doing_it_wrong( $function, $message, $version );
}
// @codingStandardsIgnoreEnd
}
/**
* Wrapper for deprecated arguments so we can apply some extra logic.
*
* @since 1.0.0
* @param string $argument Argument used.
* @param string $version Version the message was added in.
* @param string $message A message regarding the change.
*/
function ur_deprecated_argument( $argument, $version, $message = null ) {
// @codingStandardsIgnoreStart
if ( wp_doing_ajax() ) {
/**
* Fires an action when a deprecated argument is encountered.
*
* The 'deprecated_argument_run' action allows developers to hook into the point
* where a deprecated argument is encountered. It provides information about the
* deprecated argument, the associated error message, and the version at which it
* was deprecated.
*
* @param string $argument The name of the deprecated argument encountered.
* @param string $message The error message associated with the deprecated argument.
* @param string $version The version at which the argument was deprecated.
*/
do_action( 'deprecated_argument_run', $argument, $message, $version );
error_log( "The {$argument} argument is deprecated since version {$version}. {$message}" );
} else {
_deprecated_argument( $argument, $version, $message );
}
// @codingStandardsIgnoreEnd
}