Changeset 12584

Timestamp:

12/30/2009 04:23:39 PM (15 years ago)

Author:

westi

Message:

Updates and improvements to _depreceated_argument. See #11386 props nacin.

Location:

trunk

Files:

• wp-admin/includes/image.php (modified) (1 diff)
• wp-admin/includes/meta-boxes.php (modified) (1 diff)
• wp-admin/includes/upgrade.php (modified) (1 diff)
• wp-app.php (modified) (1 diff)
• wp-includes/author-template.php (modified) (3 diffs)
• wp-includes/comment-template.php (modified) (4 diffs)
• wp-includes/comment.php (modified) (1 diff)
• wp-includes/cron.php (modified) (1 diff)
• wp-includes/formatting.php (modified) (1 diff)
• wp-includes/functions.php (modified) (6 diffs)
• wp-includes/kses.php (modified) (1 diff)
• wp-includes/link-template.php (modified) (1 diff)
• wp-includes/post-template.php (modified) (2 diffs)
• wp-includes/post.php (modified) (1 diff)
• wp-includes/widgets.php (modified) (1 diff)

trunk/wp-admin/includes/image.php

@@ -18 +18 @@
  * @param mixed $file Filename of the original image, Or attachment id.
  * @param int $max_side Maximum length of a single side for the thumbnail.
+ * @param mixed $deprecated Not used.
  * @return string Thumbnail path on success, Error string on failure.
  */
 function wp_create_thumbnail( $file, $max_side, $deprecated = '' ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
     $thumbpath = image_resize( $file, $max_side, $max_side );
     return apply_filters( 'wp_create_thumbnail', $thumbpath );

trunk/wp-admin/includes/meta-boxes.php

@@ -639 +639 @@
 function xfn_check($class, $value = '', $deprecated = '') {
     global $link;
+
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
 
     $link_rel = isset( $link->link_rel ) ? $link->link_rel : ''; // In PHP 5.3: $link_rel = $link->link_rel ?: '';

trunk/wp-admin/includes/upgrade.php

@@ -34 +34 @@
  * @return array Array keys 'url', 'user_id', 'password', 'password_message'.
  */
-function wp_install($blog_title, $user_name, $user_email, $public, $deprecated='') {
+function wp_install( $blog_title, $user_name, $user_email, $public, $deprecated = '' ) {
     global $wp_rewrite;
+
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '2.6' );
 
     wp_check_mysql_version();

trunk/wp-app.php

@@ -885 +885 @@
      * @since 2.2.0
      *
-     * @param mixed $deprecated Optional, not used.
+     * @param mixed $deprecated Not used.
      * @return string
      */
     function get_categories_url($deprecated = '') {
+        if ( !empty( $deprecated ) )
+            _deprecated_argument( __FUNCTION__, '2.5' );
         return $this->app_base . $this->CATEGORIES_PATH;
     }

trunk/wp-includes/author-template.php

@@ -23 +23 @@
 function get_the_author($deprecated = '') {
     global $authordata;
+
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     return apply_filters('the_author', is_object($authordata) ? $authordata->display_name : null);
 }
@@ -45 +49 @@
  * @return string The author's display name, from get_the_author().
  */
-function the_author($deprecated = '', $deprecated_echo = true) {
-    if ( !empty($deprecated) )
-        _deprecated_argument(__FUNCTION__, 'deprecated', '1.5');
-    if ( $deprecated_echo !== true )
-        _deprecated_argument(__FUNCTION__, 'deprecated_echo', '1.5', __('Use get_the_author() instead if you do not want the value echoed.'));
+function the_author( $deprecated = '', $deprecated_echo = true ) {
+    if ( !empty( $deprecated ) || $deprecated_echo !== true )
+        _deprecated_argument( __FUNCTION__, '1.5', $deprecated_echo !== true ? __('Use get_the_author() instead if you do not want the value echoed.') : null );
     if ( $deprecated_echo )
         echo get_the_author();
@@ -183 +185 @@
 function the_author_posts_link($deprecated = '') {
     if ( !empty( $deprecated ) )
-        _deprecated_argument(__FUNCTION__, 'deprecated', '0.0');
+        _deprecated_argument( __FUNCTION__, '0.0' );
 
     global $authordata;

trunk/wp-includes/comment-template.php

@@ -504 +504 @@
  * @since 0.71
  *
- * @param string $deprecated_1 Not Used
- * @param bool $deprecated_2 Not Used
- */
-function comments_link( $deprecated_1 = '', $deprecated_2 = '' ) {
-    if ( !empty( $deprecated_1 ) )
-        _deprecated_argument(__FUNCTION__, 'deprecated_1', '0.0');
-    if ( !empty( $deprecated_2 ) )
-        _deprecated_argument(__FUNCTION__, 'deprecated_2', '0.0');
-
+ * @param string $deprecated Not Used
+ * @param bool $deprecated Not Used
+ */
+function comments_link( $deprecated = '', $deprecated = '' ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
     echo get_comments_link();
 }
@@ -555 +552 @@
 function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
     global $id;
+
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     $number = get_comments_number($id);
 
@@ -697 +698 @@
  * @uses get_trackback_url() Gets the trackback url for the current post
  *
- * @param bool $deprecated Remove backwards compat in 2.5
+ * @param bool $deprecated_echo Remove backwards compat in 2.5
  * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.
  */
-function trackback_url($deprecated = true) {
-    if ($deprecated) echo get_trackback_url();
-    else return get_trackback_url();
+function trackback_url( $deprecated_echo = true ) {
+    if ( $deprecated_echo !== true )
+        _deprecated_argument( __FUNCTION__, '2.5', __('Use get_trackback_url() instead if you do not want the value echoed.') );
+    if ( $deprecated_echo )
+        echo get_trackback_url();
+    else
+        return get_trackback_url();
 }
 
@@ -713 +718 @@
  */
 function trackback_rdf($deprecated = '') {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '2.5' );
+
     if (stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') === false) {
         echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"

trunk/wp-includes/comment.php

@@ -1512 +1512 @@
  * @return bool|string False on failure, string containing URI on success.
  */
-function discover_pingback_server_uri($url, $deprecated = '') {
-    if ( !empty($deprecated) )
-        _deprecated_argument(__FUNCTION__, 'deprecated', '0.0');
+function discover_pingback_server_uri( $url, $deprecated = '' ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
 
     $pingback_str_dquote = 'rel="pingback"';

trunk/wp-includes/cron.php

@@ -137 +137 @@
     // Previously this function took the arguments as discrete vars rather than an array like the rest of the API
     if ( !is_array($args) ) {
-        _deprecated_argument(__FUNCTION__, 'args', '3.0.0', __('This argument has changed to an array so as to match with the behaviour of all the other cron functions.') );
+        _deprecated_argument( __FUNCTION__, '3.0.0', __('This argument has changed to an array to match the behavior of the other cron functions.') );
         $args = array_slice( func_get_args(), 1 );
     }

trunk/wp-includes/formatting.php

@@ -867 +867 @@
  */
 function convert_chars($content, $deprecated = '') {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     // Translation of invalid Unicode references range to valid range
     $wp_htmltranswinuni = array(

trunk/wp-includes/functions.php

@@ -571 +571 @@
  */
 function add_option( $name, $value = '', $deprecated = '', $autoload = 'yes' ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '2.3' );
+
     global $wpdb;
 
@@ -1204 +1207 @@
  */
 function wp_get_http( $url, $file_path = false, $deprecated = false ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     @set_time_limit( 60 );
 
@@ -1246 +1252 @@
  */
 function wp_get_http_headers( $url, $deprecated = false ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     $response = wp_remote_head( $url );
 
@@ -2188 +2197 @@
  */
 function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     if ( empty( $name ) )
         return array( 'error' => __( 'Empty filename' ) );
@@ -3040 +3052 @@
  * <code>
  * if ( !empty($deprecated) )
- *  _deprecated_argument( __FUNCTION__, 'deprecated', '0.0' );
+ *  _deprecated_argument( __FUNCTION__, '0.0' );
  * </code>
  *
@@ -3054 +3066 @@
  * @access private
  *
- * @uses do_action() Calls 'deprecated_argument_run' and passes the function and argument names and what to use instead.
+ * @uses do_action() Calls 'deprecated_argument_run' and passes the function name and what to use instead.
  * @uses apply_filters() Calls 'deprecated_argument_trigger_error' and expects boolean value of true to do trigger or false to not trigger error.
  *
  * @param string $function The function that was called
- * @param string $argument The name of the deprecated argument that was used
- * @param string $version The version of WordPress that deprecated the function
+ * @param string $version The version of WordPress that deprecated the argument used
  * @param string $message Optional. A message regarding the change.
  */
-function _deprecated_argument($function, $argument, $version, $message = null) {
-
-    do_action('deprecated_argument_run', $function, $argument, $message);
+function _deprecated_argument($function, $version, $message = null) {
+
+    do_action('deprecated_argument_run', $function, $message);
 
     // Allow plugin to filter the output error trigger
     if( WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
         if( !is_null($message) )
-            trigger_error( sprintf( __('The %1$s argument of %2$s is <strong>deprecated</strong> since version %3$s! %4$s'), $function, $argument, $version, $message ) );
+            trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s! %3$s'), $function, $version, $message ) );
         else
-            trigger_error( sprintf( __('The %1$s argument of %2$s is <strong>deprecated</strong> since version %3$s with no alternative available.'), $function, $argument, $version ) );
+            trigger_error( sprintf( __('%1$s was called with an argument that is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
     }
 }

trunk/wp-includes/kses.php

@@ -1198 +1198 @@
 
 function safecss_filter_attr( $css, $deprecated = '' ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     $css = wp_kses_no_null($css);
     $css = str_replace(array("\n","\r","\t"), '', $css);

trunk/wp-includes/link-template.php

@@ -169 +169 @@
  * @return string
  */
-function post_permalink($post_id = 0, $deprecated = '') {
+function post_permalink( $post_id = 0, $deprecated = '' ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     return get_permalink($post_id);
 }

trunk/wp-includes/post-template.php

@@ -247 +247 @@
  * @return string
  */
-function get_the_excerpt($deprecated = '') {
+function get_the_excerpt( $deprecated = '' ) {
     if ( !empty( $deprecated ) )
-        _deprecated_argument(__FUNCTION__, 'deprecated', '2.3');
+        _deprecated_argument( __FUNCTION__, '2.3' );
 
     global $post;
@@ -902 +902 @@
  * @param bool $permalink Optional, default is false. Whether to include permalink.
  */
-function the_attachment_link($id = 0, $fullsize = false, $deprecated = false, $permalink = false) {
+function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
+
     if ( $fullsize )
         echo wp_get_attachment_link($id, 'full', $permalink);

trunk/wp-includes/post.php

@@ -3539 +3539 @@
  * @param object $post Object type containing the post information
  */
-function _future_post_hook($deprecated = '', $post) {
+function _future_post_hook( $deprecated = '', $post ) {
+    if ( !empty( $deprecated ) )
+        _deprecated_argument( __FUNCTION__, '0.0' );
     wp_clear_scheduled_hook( 'publish_future_post', array( $post->ID ) );
-    wp_schedule_single_event(strtotime($post->post_date_gmt. ' GMT'), 'publish_future_post', array($post->ID));
+    wp_schedule_single_event( strtotime( $post->post_date_gmt. ' GMT' ), 'publish_future_post', array( $post->ID ) );
 }
 

trunk/wp-includes/widgets.php

@@ -986 +986 @@
 function wp_get_sidebars_widgets($deprecated = true) {
     if ( $deprecated !== true )
-        _deprecated_argument(__FUNCTION__, 'deprecated', '0.0');
+        _deprecated_argument( __FUNCTION__, '0.0' );
 
     global $wp_registered_widgets, $wp_registered_sidebars, $_wp_sidebars_widgets;