Ticket #8779: standardized_function_names.3.diff

wp-includes/deprecated.php

@@ -1304 +1304 @@
         return get_comment($comment_ID, ARRAY_A);
 }
 
+/**
+ * @deprecated Use add_css_class()
+ * @see add_css_class()
+ * @since 2.7
+ *
+ * @param string $add
+ * @param string $class
+ * @return string The class
+ */
+function add_cssclass( $add = '', $class = '') {
+        _deprecated_function( __FUNCTION__, '2.8', 'add_css_class()' );
+        return add_css_class($add, $class);
+}
+
+/**
+ * Remove user meta data.
+ *
+ * @deprecated Use delete_user_meta()
+ * @since 2.0.0
+ * @uses $wpdb WordPress database object for queries.
+ *
+ * @param int $user_id User ID.
+ * @param string $meta_key Metadata key.
+ * @param mixed $meta_value Metadata value.
+ * @return bool True deletion completed and false if user_id is not a number.
+ */
+function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) {
+        _deprecated_function( __FUNCTION__, '2.8', 'delete_user_meta()' );
+        return delete_user_meta($user_id, $meta_key, $meta_value);
+}
+
+/**
+ * Retrieve all options as it was for 1.2.
+ *
+ * @deprecated Use get_all_options_110()
+ * @since 1.2.0
+ *
+ * @return array List of options.
+ */
+function get_alloptions_110() {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_all_options_110()' );
+        return get_all_options_110();
+}
+
+/**
+ * Get the week start and end from the datetime or date string from mysql.
+ *
+ * @deprecated Use get_week_start_end()
+ * @since 0.71
+ *
+ * @param string $mysqlstring Date or datetime field type from mysql.
+ * @param int $start_of_week Optional. Start of the week as an integer.
+ * @return array Keys are 'start' and 'end'.
+ */
+function get_weekstartend( $mysqlstring, $start_of_week = '' ) {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_week_start_end()' );
+        return get_week_start_end($mysqlstring, $start_of_week);
+}
+
+/**
+ * Retrieve all autoload options or all options, if no autoloaded ones exist.
+ *
+ * This is different from wp_load_alloptions() in that this function does not
+ * cache its results and will retrieve all options from the database every time
+ *
+ * it is called.
+ *
+ * @deprecated Use get_all_options()
+ * @since 1.0.0
+ * @package WordPress
+ * @subpackage Option
+ * @uses apply_filters() Calls 'pre_option_$optionname' hook with option value as parameter.
+ * @uses apply_filters() Calls 'all_options' on options list.
+ *
+ * @return array List of all options.
+ */
+function get_alloptions() {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_all_options()' );
+        return get_all_options();
+}
+
+/**
+ * Number of posts user has written.
+ *
+ * @deprecated Use get_user_num_posts()
+ * @since 0.71
+ * @uses $wpdb WordPress database object for queries.
+ *
+ * @param int $userid User ID.
+ * @return int Amount of posts user has written.
+ */
+function get_usernumposts($userid = 0) {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_user_num_posts()' );
+        return get_user_num_posts($userid);
+}
+
+/**
+ * Retrieve user metadata.
+ *
+ * If $user_id is not a number, then the function will fail over with a 'false'
+ * boolean return value. Other returned values depend on whether there is only
+ * one item to be returned, which be that single item type. If there is more
+ * than one metadata value, then it will be list of metadata values.
+ *
+ * @deprecated Use get_user_meta()
+ * @since 2.0.0
+ * @uses $wpdb WordPress database object for queries.
+ *
+ * @param int $user_id User ID
+ * @param string $meta_key Optional. Metadata key.
+ * @return mixed
+ */
+function get_usermeta( $user_id = 0, $meta_key = '') {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_user_meta()' );
+        return get_user_meta($user_id, $meta_key);
+}
+
+/**
+ * The date the last comment was modified.
+ *
+ * @deprecated Use get_last_comment_modified()
+ * @since 1.5.0
+ * @uses $wpdb
+ * @global array $cache_lastcommentmodified
+ *
+ * @param string $timezone Which timezone to use in reference to 'gmt', 'blog',
+ *              or 'server' locations.
+ * @return string Last comment modified date.
+ */
+function get_lastcommentmodified($timezone = 'server') {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_last_comment_modified()' );
+        return get_last_comment_modified($timezone);
+}
+
+/**
+ * Retrieve text color for custom header.
+ *
+ * @deprecated Use get_header_text_color()
+ * @since 2.1.0
+ * @uses HEADER_TEXTCOLOR
+ *
+ * @return string
+ */
+function get_header_textcolor() {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_header_text_color()' );
+        return get_header_text_color();
+}
+
+/**
+ * Retrieve information about the blog.
+ *
+ * Some show parameter values are deprecated and will be removed in future
+ * versions. Care should be taken to check the function contents and know what
+ * the deprecated blog info options are. Options without "// DEPRECATED" are
+ * the preferred and recommended ways to get the information.
+ *
+ * The possible values for the 'show' parameter are listed below.
+ * <ol>
+ * <li><strong>url<strong> - Blog URI to homepage.</li>
+ * <li><strong>wpurl</strong> - Blog URI path to WordPress.</li>
+ * <li><strong>description</strong> - Secondary title</li>
+ * </ol>
+ *
+ * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91),
+ * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The
+ * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment
+ * feed) or 'comments_rss2_url' (RSS 2.0 comment feed).
+ *
+ * There are many other options and you should check the function contents:
+ * {@source 32 37}
+ *
+ * @deprecated use get_blog_info()
+ * @since 0.71
+ *
+ * @param string $show Blog info to retrieve.
+ * @param string $filter How to filter what is retrieved.
+ * @return string Mostly string values, might be empty.
+ */
+function get_bloginfo($show = '', $filter = 'raw') {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_blog_info()' );
+        return get_blog_info($show, $filter);
+}
+
+/**
+ * RSS container for the bloginfo function.
+ *
+ * You can retrieve anything that you can using the get_bloginfo() function.
+ * Everything will be stripped of tags and characters converted, when the values
+ * are retrieved for use in the feeds.
+ *
+ * @package WordPress
+ * @subpackage Feed
+ *
+ * @deprecated use get_blog_info_rss()
+ * @since 1.5.1
+ * @uses apply_filters() Calls 'get_bloginfo_rss' hook with two parameters.
+ * @see get_bloginfo() For the list of possible values to display.
+ *
+ * @param string $show See get_bloginfo() for possible values.
+ * @return string
+ */
+function get_bloginfo_rss($show = '') {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_blog_info_rss()' );
+        return get_blog_info_rss($show);
+}
+
+/**
+ * Retrieve page numbers links.
+ *
+ * @deprecated Use get_comments_page_num_link()
+ * @since 2.7.0
+ *
+ * @param int $pagenum Optional. Page number.
+ * @return string
+ */
+function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_comments_page_num_link()' );
+        return get_comments_page_num_link($pagenum, $max_page);
+}
+
+/**
+ * Retrieve the category name by the category ID.
+ *
+ * @since 0.71
+ * @deprecated Use get_cat_name()
+ * @see get_cat_name() get_catname() is deprecated in favor of get_cat_name().
+ *
+ * @param int $cat_ID Category ID
+ * @return string category name
+ */
+function get_catname( $cat_ID = 0 ) {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_cat_name()' );
+        return get_cat_name( $cat_ID );
+}
+
+/**
+ * Retrieve the date the the last post was published.
+ *
+ * The server timezone is the default and is the difference between GMT and
+ * server time. The 'blog' value is the date when the last post was posted. The
+ * 'gmt' is when the last post was posted in GMT formatted date.
+ *
+ * @deprecated Use get_last_post_date()
+ * @since 0.71
+ *
+ * @uses $wpdb
+ * @uses $blog_id
+ * @uses apply_filters() Calls 'get_lastpostdate' filter
+ *
+ * @global mixed $cache_lastpostdate Stores the last post date
+ * @global mixed $pagenow The current page being viewed
+ *
+ * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
+ * @return string The date of the last post.
+ */
+function get_lastpostdate($timezone = 'server') {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_last_post_date()' );
+        return get_lastpostdate($timezone);
+}
+
+/**
+ * Retrieve last post modified date depending on timezone.
+ *
+ * The server timezone is the default and is the difference between GMT and
+ * server time. The 'blog' value is just when the last post was modified. The
+ * 'gmt' is when the last post was modified in GMT time.
+ *
+ * @deprecated use get_last_post_modified()
+ * @since 1.2.0
+ * @uses $wpdb
+ * @uses $blog_id
+ * @uses apply_filters() Calls 'get_lastpostmodified' filter
+ *
+ * @global mixed $cache_lastpostmodified Stores the date the last post was modified
+ *
+ * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
+ * @return string The date the post was last modified.
+ */
+function get_lastpostmodified($timezone = 'server') {
+        _deprecated_function( __FUNCTION__, '2.8', 'get_last_post_modified()' );
+        return get_last_post_modified($timezone);
+}
+
+/**
+ * Update metadata of user.
+ *
+ * There is no need to serialize values, they will be serialized if it is
+ * needed. The metadata key can only be a string with underscores. All else will
+ * be removed.
+ *
+ * Will remove the metadata, if the meta value is empty.
+ *
+ * @deprecated use update_user_meta()
+ * @since 2.0.0
+ * @uses $wpdb WordPress database object for queries
+ *
+ * @param int $user_id User ID
+ * @param string $meta_key Metadata key.
+ * @param mixed $meta_value Metadata value.
+ * @return bool True on successful update, false on failure.
+ */
+function update_usermeta( $user_id, $meta_key, $meta_value ) {
+        _deprecated_function( __FUNCTION__, '2.8', 'update_user_meta()' );
+        return update_user_meta($user_id, $meta_key, $meta_value);
+}
+
+/**
+ * Updates metadata cache for list of post IDs.
+ *
+ * Performs SQL query to retrieve the metadata for the post IDs and updates the
+ * metadata cache for the posts. Therefore, the functions, which call this
+ * function, do not need to perform SQL queries on their own.
+ *
+ * @package WordPress
+ * @subpackage Cache
+ * @deprecated Use update_post_meta_cache()
+ * @since 2.1.0
+ *
+ * @uses $wpdb
+ *
+ * @param array $post_ids List of post IDs.
+ * @return bool|array Returns false if there is nothing to update or an array of metadata.
+ */
+function update_postmeta_cache($post_ids = array()) {
+        _deprecated_function( __FUNCTION__, '2.8', 'update_post_meta_cache()' );
+        return update_post_meta_cache($post_ids);
+}
+