From 54c4ac3c8f4aa5cbffcb7a6fe7e26b319b69e218 Mon Sep 17 00:00:00 2001 From: nacin Date: Thu, 18 Feb 2010 23:17:06 +0000 Subject: [PATCH] Move deprecated pluggable functions to a new file to lower their profile. Also throw deprecated warnings if a plugin defines a deprecated pluggable function. See #11388 git-svn-id: http://svn.automattic.com/wordpress/trunk@13204 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/pluggable-deprecated.php | 115 +++++++++++++++++++++++++++ wp-includes/pluggable.php | 91 --------------------- wp-settings.php | 1 + 3 files changed, 116 insertions(+), 91 deletions(-) create mode 100644 wp-includes/pluggable-deprecated.php diff --git a/wp-includes/pluggable-deprecated.php b/wp-includes/pluggable-deprecated.php new file mode 100644 index 0000000000..a7028929d0 --- /dev/null +++ b/wp-includes/pluggable-deprecated.php @@ -0,0 +1,115 @@ +ID, $remember); +} +else : + _deprecated_function( 'wp_setcookie', '2.5', 'wp_set_auth_cookie()' ); +endif; + +if ( !function_exists('wp_clearcookie') ) : +/** + * Clears the authentication cookie, logging the user out. This function is deprecated. + * + * @since 1.5 + * @deprecated 2.5 + * @deprecated Use wp_clear_auth_cookie() + * @see wp_clear_auth_cookie() + */ +function wp_clearcookie() { + _deprecated_function( __FUNCTION__, '2.5', 'wp_clear_auth_cookie()' ); + wp_clear_auth_cookie(); +} +else : + _deprecated_function( 'wp_clearcookie', '2.5', 'wp_clear_auth_cookie()' ); +endif; + +if ( !function_exists('wp_get_cookie_login') ): +/** + * Gets the user cookie login. This function is deprecated. + * + * This function is deprecated and should no longer be extended as it won't be + * used anywhere in WordPress. Also, plugins shouldn't use it either. + * + * @since 2.0.3 + * @deprecated 2.5 + * @deprecated No alternative + * + * @return bool Always returns false + */ +function wp_get_cookie_login() { + _deprecated_function( __FUNCTION__, '2.5' ); + return false; +} +else : + _deprecated_function( 'wp_get_cookie_login', '2.5' ); +endif; + +if ( !function_exists('wp_login') ) : +/** + * Checks a users login information and logs them in if it checks out. This function is deprecated. + * + * Use the global $error to get the reason why the login failed. If the username + * is blank, no error will be set, so assume blank username on that case. + * + * Plugins extending this function should also provide the global $error and set + * what the error is, so that those checking the global for why there was a + * failure can utilize it later. + * + * @since 1.2.2 + * @deprecated Use wp_signon() + * @global string $error Error when false is returned + * + * @param string $username User's username + * @param string $password User's password + * @param bool $deprecated Not used + * @return bool False on login failure, true on successful check + */ +function wp_login($username, $password, $deprecated = '') { + _deprecated_function( __FUNCTION__, '2.5', 'wp_signon()' ); + global $error; + + $user = wp_authenticate($username, $password); + + if ( ! is_wp_error($user) ) + return true; + + $error = $user->get_error_message(); + return false; +} +else : + _deprecated_function( 'wp_login', '2.5', 'wp_signon()' ); +endif; \ No newline at end of file diff --git a/wp-includes/pluggable.php b/wp-includes/pluggable.php index 1508c41092..124af5e942 100644 --- a/wp-includes/pluggable.php +++ b/wp-includes/pluggable.php @@ -1643,97 +1643,6 @@ function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) { } endif; -if ( !function_exists('wp_setcookie') ) : -/** - * Sets a cookie for a user who just logged in. This function is deprecated. - * - * @since 1.5 - * @deprecated 2.5 - * @deprecated Use wp_set_auth_cookie() - * @see wp_set_auth_cookie() - * - * @param string $username The user's username - * @param string $password Optional. The user's password - * @param bool $already_md5 Optional. Whether the password has already been through MD5 - * @param string $home Optional. Will be used instead of COOKIEPATH if set - * @param string $siteurl Optional. Will be used instead of SITECOOKIEPATH if set - * @param bool $remember Optional. Remember that the user is logged in - */ -function wp_setcookie($username, $password = '', $already_md5 = false, $home = '', $siteurl = '', $remember = false) { - _deprecated_function( __FUNCTION__, '2.5', 'wp_set_auth_cookie()' ); - $user = get_userdatabylogin($username); - wp_set_auth_cookie($user->ID, $remember); -} -endif; - -if ( !function_exists('wp_clearcookie') ) : -/** - * Clears the authentication cookie, logging the user out. This function is deprecated. - * - * @since 1.5 - * @deprecated 2.5 - * @deprecated Use wp_clear_auth_cookie() - * @see wp_clear_auth_cookie() - */ -function wp_clearcookie() { - _deprecated_function( __FUNCTION__, '2.5', 'wp_clear_auth_cookie()' ); - wp_clear_auth_cookie(); -} -endif; - -if ( !function_exists('wp_get_cookie_login') ): -/** - * Gets the user cookie login. This function is deprecated. - * - * This function is deprecated and should no longer be extended as it won't be - * used anywhere in WordPress. Also, plugins shouldn't use it either. - * - * @since 2.0.3 - * @deprecated 2.5 - * @deprecated No alternative - * - * @return bool Always returns false - */ -function wp_get_cookie_login() { - _deprecated_function( __FUNCTION__, '2.5' ); - return false; -} -endif; - -if ( !function_exists('wp_login') ) : -/** - * Checks a users login information and logs them in if it checks out. This function is deprecated. - * - * Use the global $error to get the reason why the login failed. If the username - * is blank, no error will be set, so assume blank username on that case. - * - * Plugins extending this function should also provide the global $error and set - * what the error is, so that those checking the global for why there was a - * failure can utilize it later. - * - * @since 1.2.2 - * @deprecated Use wp_signon() - * @global string $error Error when false is returned - * - * @param string $username User's username - * @param string $password User's password - * @param bool $deprecated Not used - * @return bool False on login failure, true on successful check - */ -function wp_login($username, $password, $deprecated = '') { - _deprecated_function( __FUNCTION__, '2.5', 'wp_signon()' ); - global $error; - - $user = wp_authenticate($username, $password); - - if ( ! is_wp_error($user) ) - return true; - - $error = $user->get_error_message(); - return false; -} -endif; - if ( !function_exists( 'wp_text_diff' ) ) : /** * Displays a human readable HTML representation of the difference between two strings. diff --git a/wp-settings.php b/wp-settings.php index 89d9d1efce..3ac778abe1 100644 --- a/wp-settings.php +++ b/wp-settings.php @@ -176,6 +176,7 @@ unset( $plugin ); // Load pluggable functions. require( ABSPATH . WPINC . '/pluggable.php' ); +require( ABSPATH . WPINC . '/pluggable-deprecated.php' ); // Set internal encoding. wp_set_internal_encoding();