<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[13204] trunk:
Move deprecated pluggable functions to a new file to lower their profile.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/13204">13204</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2010-02-18 23:17:06 +0000 (Thu, 18 Feb 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>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 <a href="http://trac.wordpress.org/ticket/11388">#11388</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludespluggablephp">trunk/wp-includes/pluggable.php</a></li>
<li><a href="#trunkwpsettingsphp">trunk/wp-settings.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkwpincludespluggabledeprecatedphp">trunk/wp-includes/pluggable-deprecated.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludespluggabledeprecatedphp"></a>
<div class="addfile"><h4>Added: trunk/wp-includes/pluggable-deprecated.php (0 => 13204)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/pluggable-deprecated.php (rev 0)
+++ trunk/wp-includes/pluggable-deprecated.php 2010-02-18 23:17:06 UTC (rev 13204)
</span><span class="lines">@@ -0,0 +1,115 @@
</span><ins>+<?php
+/**
+ * Deprecated pluggable functions from past WordPress versions. You shouldn't use these
+ * functions and look for the alternatives instead. The functions will be removed in a
+ * later version.
+ *
+ * Deprecated warnings are also thrown if one of these functions is being defined by a plugin.
+ *
+ * @package WordPress
+ * @subpackage Deprecated
+ * @see pluggable.php
+ */
+
+/*
+ * Deprecated functions come here to die.
+ */
+
+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);
+}
+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;
</ins><span class="cx">\ No newline at end of file
</span></span></pre></div>
<a id="trunkwpincludespluggablephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/pluggable.php (13203 => 13204)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/pluggable.php 2010-02-18 22:43:52 UTC (rev 13203)
+++ trunk/wp-includes/pluggable.php 2010-02-18 23:17:06 UTC (rev 13204)
</span><span class="lines">@@ -1643,97 +1643,6 @@
</span><span class="cx"> }
</span><span class="cx"> endif;
</span><span class="cx">
</span><del>-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;
-
</del><span class="cx"> if ( !function_exists( 'wp_text_diff' ) ) :
</span><span class="cx"> /**
</span><span class="cx"> * Displays a human readable HTML representation of the difference between two strings.
</span></span></pre></div>
<a id="trunkwpsettingsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-settings.php (13203 => 13204)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-settings.php 2010-02-18 22:43:52 UTC (rev 13203)
+++ trunk/wp-settings.php 2010-02-18 23:17:06 UTC (rev 13204)
</span><span class="lines">@@ -176,6 +176,7 @@
</span><span class="cx">
</span><span class="cx"> // Load pluggable functions.
</span><span class="cx"> require( ABSPATH . WPINC . '/pluggable.php' );
</span><ins>+require( ABSPATH . WPINC . '/pluggable-deprecated.php' );
</ins><span class="cx">
</span><span class="cx"> // Set internal encoding.
</span><span class="cx"> wp_set_internal_encoding();
</span></span></pre>
</div>
</div>
</body>
</html>