*/
/**
- * Entire Post data.
+ * Retrieves all post data for a given post.
*
* @since 0.71
* @deprecated 1.5.1 Use get_post()
* @see get_post()
*
- * @param int $postid
- * @return array
+ * @param int $postid Post ID.
+ * @return array Post data.
*/
function get_postdata($postid) {
_deprecated_function( __FUNCTION__, '1.5.1', 'get_post()' );
function start_wp() {
global $wp_query;
- _deprecated_function( __FUNCTION__, '1.5', __('new WordPress Loop') );
+ _deprecated_function( __FUNCTION__, '1.5.0', __('new WordPress Loop') );
// Since the old style loop is being used, advance the query iterator here.
$wp_query->next_post();
}
/**
- * Return or Print Category ID.
+ * Returns or prints a category ID.
*
* @since 0.71
* @deprecated 0.71 Use get_the_category()
* @see get_the_category()
*
- * @param bool $echo
- * @return null|int
+ * @param bool $echo Optional. Whether to echo the output. Default true.
+ * @return int Category ID.
*/
function the_category_ID($echo = true) {
_deprecated_function( __FUNCTION__, '0.71', 'get_the_category()' );
}
/**
- * Print category with optional text before and after.
+ * Prints a category with optional text before and after.
*
* @since 0.71
* @deprecated 0.71 Use get_the_category_by_ID()
* @see get_the_category_by_ID()
*
- * @param string $before
- * @param string $after
+ * @param string $before Optional. Text to display before the category. Default empty.
+ * @param string $after Optional. Text to display after the category. Default empty.
*/
-function the_category_head($before='', $after='') {
+function the_category_head( $before = '', $after = '' ) {
global $currentcat, $previouscat;
_deprecated_function( __FUNCTION__, '0.71', 'get_the_category_by_ID()' );
}
/**
- * Prints link to the previous post.
+ * Prints a link to the previous post.
*
* @since 1.5.0
* @deprecated 2.0.0 Use previous_post_link()
* @param string $previous
* @param string $title
* @param string $in_same_cat
- * @param int $limitprev
+ * @param int $limitprev
* @param string $excluded_categories
*/
function previous_post($format='%', $previous='previous post: ', $title='yes', $in_same_cat='no', $limitprev=1, $excluded_categories='') {
- _deprecated_function( __FUNCTION__, '2.0', 'previous_post_link()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'previous_post_link()' );
if ( empty($in_same_cat) || 'no' == $in_same_cat )
$in_same_cat = false;
* @param string $excluded_categories
*/
function next_post($format='%', $next='next post: ', $title='yes', $in_same_cat='no', $limitnext=1, $excluded_categories='') {
- _deprecated_function( __FUNCTION__, '2.0', 'next_post_link()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'next_post_link()' );
if ( empty($in_same_cat) || 'no' == $in_same_cat )
$in_same_cat = false;
* @return bool
*/
function user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
$author_data = get_userdata($user_id);
return ($author_data->user_level > 1);
* @return bool
*/
function user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
$author_data = get_userdata($user_id);
return ($author_data->user_level >= 1);
* @return bool
*/
function user_can_edit_post($user_id, $post_id, $blog_id = 1) {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
$author_data = get_userdata($user_id);
$post = get_post($post_id);
* @return bool
*/
function user_can_delete_post($user_id, $post_id, $blog_id = 1) {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
// right now if one can edit, one can delete
return user_can_edit_post($user_id, $post_id, $blog_id);
* @return bool
*/
function user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
$author_data = get_userdata($user_id);
return (($author_data->user_level > 4) && user_can_create_post($user_id, $blog_id, $category_id));
* @return bool returns true if $user_id can edit $post_id's date
*/
function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
$author_data = get_userdata($user_id);
return (($author_data->user_level > 4) && user_can_edit_post($user_id, $post_id, $blog_id));
* @return bool returns true if $user_id can edit $post_id's comments
*/
function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
// right now if one can edit a post, one can edit comments made on it
return user_can_edit_post($user_id, $post_id, $blog_id);
* @return bool returns true if $user_id can delete $post_id's comments
*/
function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
// right now if one can edit comments, one can delete comments
return user_can_edit_post_comments($user_id, $post_id, $blog_id);
* @return bool
*/
function user_can_edit_user($user_id, $other_user) {
- _deprecated_function( __FUNCTION__, '2.0', 'current_user_can()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'current_user_can()' );
$user = get_userdata($user_id);
$other = get_userdata($other_user);
function get_linksbyname($cat_name = "noname", $before = '', $after = '<br />', $between = " ", $show_images = true, $orderby = 'id',
$show_description = true, $show_rating = false,
$limit = -1, $show_updated = 0) {
- _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' );
$cat_id = -1;
$cat = get_term_by('name', $cat_name, 'link_category');
* @return string|null
*/
function wp_get_linksbyname($category, $args = '') {
- _deprecated_function(__FUNCTION__, '2.1', 'wp_list_bookmarks()');
+ _deprecated_function(__FUNCTION__, '2.1.0', 'wp_list_bookmarks()');
$defaults = array(
'after' => '<br />',
* @return array
*/
function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) {
- _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' );
$cat_id = -1;
$cat = get_term_by('name', $cat_name, 'link_category');
* @return array
*/
function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) {
- _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' );
$links = get_bookmarks( array( 'category' => $category, 'orderby' => $orderby, 'limit' => $limit ) ) ;
*/
function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = '<br />', $between = " ",
$show_images = true, $orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) {
- _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' );
get_linksbyname($cat_name, $before, $after, $between, $show_images, $orderby, $show_description, true, $limit, $show_updated);
}
*/
function get_links_withrating($category = -1, $before = '', $after = '<br />', $between = " ", $show_images = true,
$orderby = 'id', $show_description = true, $limit = -1, $show_updated = 0) {
- _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' );
get_links($category, $before, $after, $between, $show_images, $orderby, $show_description, true, $limit, $show_updated);
}
* @return int Only returns 0.
*/
function get_autotoggle($id = 0) {
- _deprecated_function( __FUNCTION__, '2.1' );
+ _deprecated_function( __FUNCTION__, '2.1.0' );
return 0;
}
function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0,
$optioncount = 0, $hide_empty = 1, $use_desc_for_title = 1, $children=false, $child_of=0, $categories=0,
$recurse=0, $feed = '', $feed_image = '', $exclude = '', $hierarchical=false) {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_list_categories()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_categories()' );
$query = compact('optionall', 'all', 'sort_column', 'sort_order', 'file', 'list', 'optiondates', 'optioncount', 'hide_empty', 'use_desc_for_title', 'children',
'child_of', 'categories', 'recurse', 'feed', 'feed_image', 'exclude', 'hierarchical');
* @return false|null|string
*/
function wp_list_cats($args = '') {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_list_categories()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_categories()' );
$r = wp_parse_args( $args );
function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = 'asc',
$show_last_update = 0, $show_count = 0, $hide_empty = 1, $optionnone = false,
$selected = 0, $exclude = 0) {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_dropdown_categories()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_dropdown_categories()' );
$show_option_all = '';
if ( $optionall )
* @return null|string
*/
function list_authors($optioncount = false, $exclude_admin = true, $show_fullname = false, $hide_empty = true, $feed = '', $feed_image = '') {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_list_authors()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_authors()' );
$args = compact('optioncount', 'exclude_admin', 'show_fullname', 'hide_empty', 'feed', 'feed_image');
return wp_list_authors($args);
* @return array
*/
function wp_get_post_cats($blogid = '1', $post_ID = 0) {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_get_post_categories()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_get_post_categories()' );
return wp_get_post_categories($post_ID);
}
* @return bool|mixed
*/
function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array()) {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_set_post_categories()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_set_post_categories()' );
return wp_set_post_categories($post_ID, $post_categories);
}
* @return string|null
*/
function get_archives($type='', $limit='', $format='html', $before = '', $after = '', $show_post_count = false) {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_get_archives()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_get_archives()' );
$args = compact('type', 'limit', 'format', 'before', 'after', 'show_post_count');
return wp_get_archives($args);
}
* @return string|null
*/
function get_author_link($echo, $author_id, $author_nicename = '') {
- _deprecated_function( __FUNCTION__, '2.1', 'get_author_posts_url()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_author_posts_url()' );
$link = get_author_posts_url($author_id, $author_nicename);
*/
function link_pages($before='<br />', $after='<br />', $next_or_number='number', $nextpagelink='next page', $previouspagelink='previous page',
$pagelink='%', $more_file='') {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_link_pages()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_link_pages()' );
$args = compact('before', 'after', 'next_or_number', 'nextpagelink', 'previouspagelink', 'pagelink', 'more_file');
return wp_link_pages($args);
* @return string
*/
function get_settings($option) {
- _deprecated_function( __FUNCTION__, '2.1', 'get_option()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_option()' );
return get_option($option);
}
* @see the_permalink()
*/
function permalink_link() {
- _deprecated_function( __FUNCTION__, '1.2', 'the_permalink()' );
+ _deprecated_function( __FUNCTION__, '1.2.0', 'the_permalink()' );
the_permalink();
}
* @param string $deprecated
*/
function permalink_single_rss($deprecated = '') {
- _deprecated_function( __FUNCTION__, '2.3', 'the_permalink_rss()' );
+ _deprecated_function( __FUNCTION__, '2.3.0', 'the_permalink_rss()' );
the_permalink_rss();
}
* @return null|string
*/
function wp_get_links($args = '') {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_list_bookmarks()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_bookmarks()' );
if ( strpos( $args, '=' ) === false ) {
$cat_id = $args;
*/
function get_links($category = -1, $before = '', $after = '<br />', $between = ' ', $show_images = true, $orderby = 'name',
$show_description = true, $show_rating = false, $limit = -1, $show_updated = 1, $echo = true) {
- _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmarks()' );
$order = 'ASC';
if ( substr($orderby, 0, 1) == '_' ) {
* @param string $order Sort link categories by 'name' or 'id'
*/
function get_links_list($order = 'name') {
- _deprecated_function( __FUNCTION__, '2.1', 'wp_list_bookmarks()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_bookmarks()' );
$order = strtolower($order);
* @param bool $count the number of links in the db
*/
function links_popup_script($text = 'Links', $width=400, $height=400, $file='links.all.php', $count = true) {
- _deprecated_function( __FUNCTION__, '2.1' );
+ _deprecated_function( __FUNCTION__, '2.1.0' );
}
/**
+ * Legacy function that retrieved the value of a link's link_rating field.
+ *
* @since 1.0.1
* @deprecated 2.1.0 Use sanitize_bookmark_field()
* @see sanitize_bookmark_field()
*
- * @param object $link
- * @return mixed
+ * @param object $link Link object.
+ * @return mixed Value of the 'link_rating' field, false otherwise.
*/
-function get_linkrating($link) {
- _deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' );
+function get_linkrating( $link ) {
+ _deprecated_function( __FUNCTION__, '2.1.0', 'sanitize_bookmark_field()' );
return sanitize_bookmark_field('link_rating', $link->link_rating, $link->link_id, 'display');
}
* @return string
*/
function get_linkcatname($id = 0) {
- _deprecated_function( __FUNCTION__, '2.1', 'get_category()' );
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_category()' );
$id = (int) $id;
* @param string $link_text
*/
function comments_rss_link($link_text = 'Comments RSS') {
- _deprecated_function( __FUNCTION__, '2.5', 'post_comments_feed_link()' );
+ _deprecated_function( __FUNCTION__, '2.5.0', 'post_comments_feed_link()' );
post_comments_feed_link($link_text);
}
* @return string
*/
function get_category_rss_link($echo = false, $cat_ID = 1) {
- _deprecated_function( __FUNCTION__, '2.5', 'get_category_feed_link()' );
+ _deprecated_function( __FUNCTION__, '2.5.0', 'get_category_feed_link()' );
$link = get_category_feed_link($cat_ID, 'rss2');
* @return string
*/
function get_author_rss_link($echo = false, $author_id = 1) {
- _deprecated_function( __FUNCTION__, '2.5', 'get_author_feed_link()' );
+ _deprecated_function( __FUNCTION__, '2.5.0', 'get_author_feed_link()' );
$link = get_author_feed_link($author_id);
if ( $echo )
* @return string
*/
function comments_rss() {
- _deprecated_function( __FUNCTION__, '2.2', 'get_post_comments_feed_link()' );
+ _deprecated_function( __FUNCTION__, '2.2.0', 'get_post_comments_feed_link()' );
return esc_url( get_post_comments_feed_link() );
}
* @return int The new user's ID.
*/
function create_user($username, $password, $email) {
- _deprecated_function( __FUNCTION__, '2.0', 'wp_create_user()' );
+ _deprecated_function( __FUNCTION__, '2.0.0', 'wp_create_user()' );
return wp_create_user($username, $password, $email);
}
* Unused function.
*
* @deprecated 2.5.0
-*/
+ */
function gzip_compression() {
- _deprecated_function( __FUNCTION__, '2.5' );
+ _deprecated_function( __FUNCTION__, '2.5.0' );
return false;
}
* @return array The comment data
*/
function get_commentdata( $comment_ID, $no_cache = 0, $include_unapproved = false ) {
- _deprecated_function( __FUNCTION__, '2.7', 'get_comment()' );
+ _deprecated_function( __FUNCTION__, '2.7.0', 'get_comment()' );
return get_comment($comment_ID, ARRAY_A);
}
* @return string category name
*/
function get_catname( $cat_ID ) {
- _deprecated_function( __FUNCTION__, '2.8', 'get_cat_name()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_cat_name()' );
return get_cat_name( $cat_ID );
}
* @return string
*/
function get_category_children( $id, $before = '/', $after = '', $visited = array() ) {
- _deprecated_function( __FUNCTION__, '2.8', 'get_term_children()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_term_children()' );
if ( 0 == $id )
return '';
* @return object List of all of the category IDs.
*/
function get_all_category_ids() {
- _deprecated_function( __FUNCTION__, '4.0', 'get_terms()' );
+ _deprecated_function( __FUNCTION__, '4.0.0', 'get_terms()' );
if ( ! $cat_ids = wp_cache_get( 'all_category_ids', 'category' ) ) {
$cat_ids = get_terms( 'category', array('fields' => 'ids', 'get' => 'all') );
* @return string The author's description.
*/
function get_the_author_description() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'description\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'description\')' );
return get_the_author_meta('description');
}
* @see the_author_meta()
*/
function the_author_description() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'description\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'description\')' );
the_author_meta('description');
}
* @return string The author's login name (username).
*/
function get_the_author_login() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'login\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'login\')' );
return get_the_author_meta('login');
}
* @see the_author_meta()
*/
function the_author_login() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'login\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'login\')' );
the_author_meta('login');
}
* @return string The author's first name.
*/
function get_the_author_firstname() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'first_name\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'first_name\')' );
return get_the_author_meta('first_name');
}
* @see the_author_meta()
*/
function the_author_firstname() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'first_name\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'first_name\')' );
the_author_meta('first_name');
}
* @return string The author's last name.
*/
function get_the_author_lastname() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'last_name\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'last_name\')' );
return get_the_author_meta('last_name');
}
* @see the_author_meta()
*/
function the_author_lastname() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'last_name\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'last_name\')' );
the_author_meta('last_name');
}
* @return string The author's nickname.
*/
function get_the_author_nickname() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'nickname\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'nickname\')' );
return get_the_author_meta('nickname');
}
* @see the_author_meta()
*/
function the_author_nickname() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'nickname\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'nickname\')' );
the_author_meta('nickname');
}
* @return string The author's username.
*/
function get_the_author_email() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'email\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'email\')' );
return get_the_author_meta('email');
}
* @see the_author_meta()
*/
function the_author_email() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'email\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'email\')' );
the_author_meta('email');
}
* @return string The author's ICQ number.
*/
function get_the_author_icq() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'icq\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'icq\')' );
return get_the_author_meta('icq');
}
* @see the_author_meta()
*/
function the_author_icq() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'icq\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'icq\')' );
the_author_meta('icq');
}
* @return string The author's Yahoo! IM name.
*/
function get_the_author_yim() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'yim\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'yim\')' );
return get_the_author_meta('yim');
}
* @see the_author_meta()
*/
function the_author_yim() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'yim\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'yim\')' );
the_author_meta('yim');
}
* @return string The author's MSN address.
*/
function get_the_author_msn() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'msn\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'msn\')' );
return get_the_author_meta('msn');
}
* @see the_author_meta()
*/
function the_author_msn() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'msn\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'msn\')' );
the_author_meta('msn');
}
* @return string The author's AIM address.
*/
function get_the_author_aim() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'aim\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'aim\')' );
return get_the_author_meta('aim');
}
* @see the_author_meta()
*/
function the_author_aim() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'aim\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'aim\')' );
the_author_meta('aim');
}
* @return string The author's display name.
*/
function get_author_name( $auth_id = false ) {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'display_name\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'display_name\')' );
return get_the_author_meta('display_name', $auth_id);
}
* @return string The URL to the author's page.
*/
function get_the_author_url() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'url\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'url\')' );
return get_the_author_meta('url');
}
* @see the_author_meta()
*/
function the_author_url() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'url\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'url\')' );
the_author_meta('url');
}
* @return string|int The author's ID.
*/
function get_the_author_ID() {
- _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'ID\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'get_the_author_meta(\'ID\')' );
return get_the_author_meta('ID');
}
* @since 0.71
* @deprecated 2.8.0 Use the_author_meta()
* @see the_author_meta()
-*/
+ */
function the_author_ID() {
- _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'ID\')' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'the_author_meta(\'ID\')' );
the_author_meta('ID');
}
* @param int $encode_html Optional. How to encode the content.
*/
function the_content_rss($more_link_text='(more...)', $stripteaser=0, $more_file='', $cut = 0, $encode_html = 0) {
- _deprecated_function( __FUNCTION__, '2.9', 'the_content_feed' );
+ _deprecated_function( __FUNCTION__, '2.9.0', 'the_content_feed' );
$content = get_the_content($more_link_text, $stripteaser);
$content = apply_filters('the_content_rss', $content);
if ( $cut && !$encode_html )
* @return string HTML stripped out of content with links at the bottom.
*/
function make_url_footnote( $content ) {
- _deprecated_function( __FUNCTION__, '2.9', '' );
+ _deprecated_function( __FUNCTION__, '2.9.0', '' );
preg_match_all( '/<a(.+?)href=\"(.+?)\"(.*?)>(.+?)<\/a>/', $content, $matches );
$links_summary = "\n";
for ( $i = 0, $c = count( $matches[0] ); $i < $c; $i++ ) {
* @return string Translated context string without pipe
*/
function _c( $text, $domain = 'default' ) {
- _deprecated_function( __FUNCTION__, '2.9', '_x()' );
+ _deprecated_function( __FUNCTION__, '2.9.0', '_x()' );
return before_last_bar( translate( $text, $domain ) );
}
* @return string Translated text
*/
function translate_with_context( $text, $domain = 'default' ) {
- _deprecated_function( __FUNCTION__, '2.9', '_x()' );
+ _deprecated_function( __FUNCTION__, '2.9.0', '_x()' );
return before_last_bar( translate( $text, $domain ) );
}
/**
- * A version of _n(), which supports contexts.
+ * Legacy version of _n(), which supports contexts.
+ *
* Strips everything from the translation after the last bar.
*
* @since 2.7.0
* @deprecated 3.0.0 Use _nx()
* @see _nx()
+ *
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param int $number The number to compare against to use either the singular or plural form.
+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
+ * @return string The translated singular or plural form.
*/
function _nc( $single, $plural, $number, $domain = 'default' ) {
- _deprecated_function( __FUNCTION__, '2.9', '_nx()' );
+ _deprecated_function( __FUNCTION__, '2.9.0', '_nx()' );
return before_last_bar( _n( $single, $plural, $number, $domain ) );
}
* @see _n()
*/
function __ngettext() {
- _deprecated_function( __FUNCTION__, '2.8', '_n()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', '_n()' );
$args = func_get_args();
return call_user_func_array('_n', $args);
}
* @see _n_noop()
*/
function __ngettext_noop() {
- _deprecated_function( __FUNCTION__, '2.8', '_n_noop()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', '_n_noop()' );
$args = func_get_args();
return call_user_func_array('_n_noop', $args);
* @return array List of all options.
*/
function get_alloptions() {
- _deprecated_function( __FUNCTION__, '3.0', 'wp_load_alloptions()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'wp_load_alloptions()' );
return wp_load_alloptions();
}
* @return string
*/
function get_the_attachment_link($id = 0, $fullsize = false, $max_dims = false, $permalink = false) {
- _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_link()' );
+ _deprecated_function( __FUNCTION__, '2.5.0', 'wp_get_attachment_link()' );
$id = (int) $id;
$_post = get_post($id);
* @return array Icon URL and full path to file, respectively.
*/
function get_attachment_icon_src( $id = 0, $fullsize = false ) {
- _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image_src()' );
+ _deprecated_function( __FUNCTION__, '2.5.0', 'wp_get_attachment_image_src()' );
$id = (int) $id;
if ( !$post = get_post($id) )
return false;
* @return false|string HTML content.
*/
function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) {
- _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image()' );
+ _deprecated_function( __FUNCTION__, '2.5.0', 'wp_get_attachment_image()' );
$id = (int) $id;
if ( !$post = get_post($id) )
return false;
* @return false|string
*/
function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) {
- _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image()' );
+ _deprecated_function( __FUNCTION__, '2.5.0', 'wp_get_attachment_image()' );
$id = (int) $id;
if ( !$post = get_post($id) )
return false;
}
/**
- * Retrieve bookmark data based on ID.
+ * Retrieves bookmark data based on ID.
*
* @since 2.0.0
* @deprecated 2.1.0 Use get_bookmark()
* @see get_bookmark()
*
- * @param int $bookmark_id ID of link
- * @param string $output OBJECT, ARRAY_N, or ARRAY_A
- * @return object|array
+ * @param int $bookmark_id ID of link
+ * @param string $output Optional. Type of output. Accepts OBJECT, ARRAY_N, or ARRAY_A.
+ * Default OBJECT.
+ * @param string $filter Optional. How to filter the link for output. Accepts 'raw', 'edit',
+ * 'attribute', 'js', 'db', or 'display'. Default 'raw'.
+ * @return object|array Bookmark object or array, depending on the type specified by `$output`.
*/
-function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') {
- _deprecated_function( __FUNCTION__, '2.1', 'get_bookmark()' );
+function get_link( $bookmark_id, $output = OBJECT, $filter = 'raw' ) {
+ _deprecated_function( __FUNCTION__, '2.1.0', 'get_bookmark()' );
return get_bookmark($bookmark_id, $output, $filter);
}
* @return string The cleaned URL.
*/
function sanitize_url( $url, $protocols = null ) {
- _deprecated_function( __FUNCTION__, '2.8', 'esc_url_raw()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'esc_url_raw()' );
return esc_url_raw( $url, $protocols );
}
*
* @since 1.2.0
* @deprecated 3.0.0 Use esc_url()
- * @see Alias for esc_url()
+ * @see esc_url()
*
* @param string $url The URL to be cleaned.
* @param array $protocols Optional. An array of acceptable protocols.
* @param string $context Optional. How the URL will be used. Default is 'display'.
- * @return string The cleaned $url after the 'clean_url' filter is applied.
+ * @return string The cleaned $url after the {@see 'clean_url'} filter is applied.
*/
function clean_url( $url, $protocols = null, $context = 'display' ) {
if ( $context == 'db' )
- _deprecated_function( 'clean_url( $context = \'db\' )', '3.0', 'esc_url_raw()' );
+ _deprecated_function( 'clean_url( $context = \'db\' )', '3.0.0', 'esc_url_raw()' );
else
- _deprecated_function( __FUNCTION__, '3.0', 'esc_url()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'esc_url()' );
return esc_url( $url, $protocols, $context );
}
/**
* Escape single quotes, specialchar double quotes, and fix line endings.
*
- * The filter 'js_escape' is also applied by esc_js()
+ * The filter {@see 'js_escape'} is also applied by esc_js().
*
* @since 2.0.4
* @deprecated 2.8.0 Use esc_js()
* @return string Escaped text.
*/
function js_escape( $text ) {
- _deprecated_function( __FUNCTION__, '2.8', 'esc_js()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'esc_js()' );
return esc_js( $text );
}
/**
- * Escaping for HTML blocks.
+ * Legacy escaping for HTML blocks.
*
* @deprecated 2.8.0 Use esc_html()
* @see esc_html()
+ *
+ * @param string $string String to escape.
+ * @param string $quote_style Unused.
+ * @param false|string $charset Unused.
+ * @param false $double_encode Whether to double encode. Unused.
+ * @return string Escaped `$string`.
*/
function wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
- _deprecated_function( __FUNCTION__, '2.8', 'esc_html()' );
- if ( func_num_args() > 1 ) { // Maintain backwards compat for people passing additional args
+ _deprecated_function( __FUNCTION__, '2.8.0', 'esc_html()' );
+ if ( func_num_args() > 1 ) { // Maintain back-compat for people passing additional arguments.
$args = func_get_args();
return call_user_func_array( '_wp_specialchars', $args );
} else {
* @return string
*/
function attribute_escape( $text ) {
- _deprecated_function( __FUNCTION__, '2.8', 'esc_attr()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'esc_attr()' );
return esc_attr( $text );
}
/**
- * Register widget for sidebar with backwards compatibility.
+ * Register widget for sidebar with backward compatibility.
*
* Allows $name to be an array that accepts either three elements to grab the
* first element and the third for the name or just uses the first element of
* the array for the name.
*
- * Passes to {@link wp_register_sidebar_widget()} after argument list and
- * backwards compatibility is complete.
+ * Passes to wp_register_sidebar_widget() after argument list and backward
+ * compatibility is complete.
*
* @since 2.2.0
* @deprecated 2.8.0 Use wp_register_sidebar_widget()
* @see wp_register_sidebar_widget()
*
- * @param string|int $name Widget ID.
- * @param callable $output_callback Run when widget is called.
- * @param string $classname Classname widget option.
- * @param mixed $params ,... Widget parameters.
+ * @param string|int $name Widget ID.
+ * @param callable $output_callback Run when widget is called.
+ * @param string $classname Optional. Classname widget option. Default empty.
+ * @param mixed $params ,... Widget parameters.
*/
function register_sidebar_widget($name, $output_callback, $classname = '') {
- _deprecated_function( __FUNCTION__, '2.8', 'wp_register_sidebar_widget()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_sidebar_widget()' );
// Compat
if ( is_array($name) ) {
if ( count($name) == 3 )
}
/**
- * Alias of {@link wp_unregister_sidebar_widget()}.
+ * Serves as an alias of wp_unregister_sidebar_widget().
*
* @since 2.2.0
* @deprecated 2.8.0 Use wp_unregister_sidebar_widget()
* @param int|string $id Widget ID.
*/
function unregister_sidebar_widget($id) {
- _deprecated_function( __FUNCTION__, '2.8', 'wp_unregister_sidebar_widget()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'wp_unregister_sidebar_widget()' );
return wp_unregister_sidebar_widget($id);
}
* @param int $height Widget height.
*/
function register_widget_control($name, $control_callback, $width = '', $height = '') {
- _deprecated_function( __FUNCTION__, '2.8', 'wp_register_widget_control()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_widget_control()' );
// Compat
if ( is_array($name) ) {
if ( count($name) == 3 )
* @param int|string $id Widget ID.
*/
function unregister_widget_control($id) {
- _deprecated_function( __FUNCTION__, '2.8', 'wp_unregister_widget_control()' );
+ _deprecated_function( __FUNCTION__, '2.8.0', 'wp_unregister_widget_control()' );
return wp_unregister_widget_control($id);
}
* @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__, '3.0', 'delete_user_meta()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'delete_user_meta()' );
global $wpdb;
if ( !is_numeric( $user_id ) )
return false;
* @return mixed
*/
function get_usermeta( $user_id, $meta_key = '' ) {
- _deprecated_function( __FUNCTION__, '3.0', 'get_user_meta()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'get_user_meta()' );
global $wpdb;
$user_id = (int) $user_id;
* @return bool True on successful update, false on failure.
*/
function update_usermeta( $user_id, $meta_key, $meta_value ) {
- _deprecated_function( __FUNCTION__, '3.0', 'update_user_meta()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'update_user_meta()' );
global $wpdb;
if ( !is_numeric( $user_id ) )
return false;
}
/**
- * Get users for the blog.
+ * Get users for the site.
*
- * For setups that use the multi-blog feature. Can be used outside of the
- * multi-blog feature.
+ * For setups that use the multisite feature. Can be used outside of the
+ * multisite feature.
*
* @since 2.2.0
* @deprecated 3.1.0 Use get_users()
* @see get_users()
*
- * @global wpdb $wpdb WordPress database abstraction object.
- * @uses $blog_id The Blog id of the blog for those that use more than one blog
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int $id Blog ID.
- * @return array List of users that are part of that Blog ID
+ * @param int $id Site ID.
+ * @return array List of users that are part of that site ID
*/
function get_users_of_blog( $id = '' ) {
- _deprecated_function( __FUNCTION__, '3.1', 'get_users()' );
+ _deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' );
- global $wpdb, $blog_id;
- if ( empty($id) )
- $id = (int) $blog_id;
+ global $wpdb;
+ if ( empty( $id ) ) {
+ $id = get_current_blog_id();
+ }
$blog_prefix = $wpdb->get_blog_prefix($id);
$users = $wpdb->get_results( "SELECT user_id, user_id AS ID, user_login, display_name, user_email, meta_value FROM $wpdb->users, $wpdb->usermeta WHERE {$wpdb->users}.ID = {$wpdb->usermeta}.user_id AND meta_key = '{$blog_prefix}capabilities' ORDER BY {$wpdb->usermeta}.user_id" );
return $users;
* @param bool $add Optional, default is true. Add or remove links. Defaults to true.
*/
function automatic_feed_links( $add = true ) {
- _deprecated_function( __FUNCTION__, '3.0', "add_theme_support( 'automatic-feed-links' )" );
+ _deprecated_function( __FUNCTION__, '3.0.0', "add_theme_support( 'automatic-feed-links' )" );
if ( $add )
add_theme_support( 'automatic-feed-links' );
* @since 1.5.0
* @deprecated 3.0.0 Use get_the_author_meta()
* @see get_the_author_meta()
+ *
+ * @param string $field User meta field.
+ * @param false|int $user Optional. User ID to retrieve the field for. Default false (current user).
+ * @return string The author's field from the current author's DB object.
*/
function get_profile( $field, $user = false ) {
- _deprecated_function( __FUNCTION__, '3.0', 'get_the_author_meta()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'get_the_author_meta()' );
if ( $user ) {
$user = get_user_by( 'login', $user );
$user = $user->ID;
}
/**
- * Number of posts user has written.
+ * Retrieves the number of posts a user has written.
*
* @since 0.71
* @deprecated 3.0.0 Use count_user_posts()
* @see count_user_posts()
+ *
+ * @param int $userid User to count posts for.
+ * @return int Number of posts the given user has written.
*/
function get_usernumposts( $userid ) {
- _deprecated_function( __FUNCTION__, '3.0', 'count_user_posts()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'count_user_posts()' );
return count_user_posts( $userid );
}
* @since 1.5.0
* @deprecated 3.0.0
*
- * @uses $is_macIE
- * @uses $is_winIE
+ * @global $is_macIE
+ * @global $is_winIE
*
* @param string $text Text to be made safe.
* @return string Fixed text.
*/
function funky_javascript_fix($text) {
- _deprecated_function( __FUNCTION__, '3.0' );
+ _deprecated_function( __FUNCTION__, '3.0.0' );
// Fixes for browsers' JavaScript bugs.
global $is_macIE, $is_winIE;
* @return bool Whether the taxonomy exists.
*/
function is_taxonomy( $taxonomy ) {
- _deprecated_function( __FUNCTION__, '3.0', 'taxonomy_exists()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'taxonomy_exists()' );
return taxonomy_exists( $taxonomy );
}
* @return mixed Get the term id or Term Object, if exists.
*/
function is_term( $term, $taxonomy = '', $parent = 0 ) {
- _deprecated_function( __FUNCTION__, '3.0', 'term_exists()' );
+ _deprecated_function( __FUNCTION__, '3.0.0', 'term_exists()' );
return term_exists( $term, $taxonomy, $parent );
}
* @return bool
*/
function is_plugin_page() {
- _deprecated_function( __FUNCTION__, '3.1' );
+ _deprecated_function( __FUNCTION__, '3.1.0' );
global $plugin_page;
* @return bool Always return True
*/
function update_category_cache() {
- _deprecated_function( __FUNCTION__, '3.1' );
+ _deprecated_function( __FUNCTION__, '3.1.0' );
return true;
}
* @return bool
*/
function wp_timezone_supported() {
- _deprecated_function( __FUNCTION__, '3.2' );
+ _deprecated_function( __FUNCTION__, '3.2.0' );
return true;
}
/**
- * Display editor: TinyMCE, HTML, or both.
+ * Displays an editor: TinyMCE, HTML, or both.
*
* @since 2.1.0
* @deprecated 3.3.0 Use wp_editor()
* @see wp_editor()
*
- * @param string $content Textarea content.
- * @param string $id Optional, default is 'content'. HTML ID attribute value.
- * @param string $prev_id Optional, not used
- * @param bool $media_buttons Optional, default is true. Whether to display media buttons.
- * @param int $tab_index Optional, not used
+ * @param string $content Textarea content.
+ * @param string $id Optional. HTML ID attribute value. Default 'content'.
+ * @param string $prev_id Optional. Unused.
+ * @param bool $media_buttons Optional. Whether to display media buttons. Default true.
+ * @param int $tab_index Optional. Unused.
+ * @param bool $extended Optional. Unused.
*/
function the_editor($content, $id = 'content', $prev_id = 'title', $media_buttons = true, $tab_index = 2, $extended = true) {
- _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' );
+ _deprecated_function( __FUNCTION__, '3.3.0', 'wp_editor()' );
wp_editor( $content, $id, array( 'media_buttons' => $media_buttons ) );
}
* @return array of arrays. The array is indexed by user_id, containing $metavalues object arrays.
*/
function get_user_metavalues($ids) {
- _deprecated_function( __FUNCTION__, '3.3' );
+ _deprecated_function( __FUNCTION__, '3.3.0' );
$objects = array();
* @return object|array The now sanitized User Object or Array (will be the same type as $user)
*/
function sanitize_user_object($user, $context = 'display') {
- _deprecated_function( __FUNCTION__, '3.3' );
+ _deprecated_function( __FUNCTION__, '3.3.0' );
if ( is_object($user) ) {
if ( !isset($user->ID) )
* @return string
*/
function get_boundary_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $start = true) {
- _deprecated_function( __FUNCTION__, '3.3' );
+ _deprecated_function( __FUNCTION__, '3.3.0' );
$posts = get_boundary_post($in_same_cat, $excluded_categories, $start);
// If there is no post stop.
* @param string $excluded_categories Optional. Excluded categories IDs.
*/
function start_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
- _deprecated_function( __FUNCTION__, '3.3' );
+ _deprecated_function( __FUNCTION__, '3.3.0' );
echo get_boundary_post_rel_link($title, $in_same_cat, $excluded_categories, true);
}
* @return string
*/
function get_index_rel_link() {
- _deprecated_function( __FUNCTION__, '3.3' );
+ _deprecated_function( __FUNCTION__, '3.3.0' );
$link = "<link rel='index' title='" . esc_attr( get_bloginfo( 'name', 'display' ) ) . "' href='" . esc_url( user_trailingslashit( get_bloginfo( 'url', 'display' ) ) ) . "' />\n";
return apply_filters( "index_rel_link", $link );
* @deprecated 3.3.0
*/
function index_rel_link() {
- _deprecated_function( __FUNCTION__, '3.3' );
+ _deprecated_function( __FUNCTION__, '3.3.0' );
echo get_index_rel_link();
}
* @since 2.8.0
* @deprecated 3.3.0
*
- * @param string $title Optional. Link title format.
+ * @param string $title Optional. Link title format. Default '%title'.
* @return string
*/
-function get_parent_post_rel_link($title = '%title') {
- _deprecated_function( __FUNCTION__, '3.3' );
+function get_parent_post_rel_link( $title = '%title' ) {
+ _deprecated_function( __FUNCTION__, '3.3.0' );
if ( ! empty( $GLOBALS['post'] ) && ! empty( $GLOBALS['post']->post_parent ) )
$post = get_post($GLOBALS['post']->post_parent);
*
* @since 2.8.0
* @deprecated 3.3.0
+ *
+ * @param string $title Optional. Link title format. Default '%title'.
*/
-function parent_post_rel_link($title = '%title') {
- _deprecated_function( __FUNCTION__, '3.3' );
+function parent_post_rel_link( $title = '%title' ) {
+ _deprecated_function( __FUNCTION__, '3.3.0' );
echo get_parent_post_rel_link($title);
}
*
* @since 3.2.0
* @deprecated 3.3.0
+ *
+ * @param WP_Admin_Bar $wp_admin_bar WP_Admin_Bar instance.
*/
function wp_admin_bar_dashboard_view_site_menu( $wp_admin_bar ) {
- _deprecated_function( __FUNCTION__, '3.3' );
+ _deprecated_function( __FUNCTION__, '3.3.0' );
$user_id = get_current_user_id();
}
/**
- * Checks if the current user belong to a given blog.
+ * Checks if the current user belong to a given site.
*
* @since MU
* @deprecated 3.3.0 Use is_user_member_of_blog()
* @see is_user_member_of_blog()
*
- * @param int $blog_id Blog ID
+ * @param int $blog_id Site ID
* @return bool True if the current users belong to $blog_id, false if not.
*/
function is_blog_user( $blog_id = 0 ) {
- _deprecated_function( __FUNCTION__, '3.3', 'is_user_member_of_blog()' );
+ _deprecated_function( __FUNCTION__, '3.3.0', 'is_user_member_of_blog()' );
return is_user_member_of_blog( get_current_user_id(), $blog_id );
}
* @deprecated 3.4.0 Use error_log()
* @see error_log()
*
- * @link http://www.php.net/manual/en/function.error-log.php
+ * @link https://secure.php.net/manual/en/function.error-log.php
+ *
+ * @param string $filename File name.
+ * @param string $mode Type of access you required to the stream.
+ * @return false Always false.
*/
function debug_fopen( $filename, $mode ) {
_deprecated_function( __FUNCTION__, 'error_log()' );
* @deprecated 3.4.0 Use error_log()
* @see error_log()
*
- * @link http://www.php.net/manual/en/function.error-log.php
+ * @link https://secure.php.net/manual/en/function.error-log.php
+ *
+ * @param mixed $fp Unused.
+ * @param string $string Message to log.
*/
function debug_fwrite( $fp, $string ) {
_deprecated_function( __FUNCTION__, 'error_log()' );
* @deprecated 3.4.0 Use error_log()
* @see error_log()
*
- * @link http://www.php.net/manual/en/function.error-log.php
+ * @link https://secure.php.net/manual/en/function.error-log.php
+ *
+ * @param mixed $fp Unused.
*/
function debug_fclose( $fp ) {
_deprecated_function( __FUNCTION__, 'error_log()' );
* @return array Theme list with theme data.
*/
function get_themes() {
- _deprecated_function( __FUNCTION__, '3.4', 'wp_get_themes()' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'wp_get_themes()' );
global $wp_themes;
if ( isset( $wp_themes ) )
* @return array|null Null, if theme name does not exist. Theme data, if exists.
*/
function get_theme( $theme ) {
- _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme( $stylesheet )' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'wp_get_theme( $stylesheet )' );
$themes = get_themes();
if ( is_array( $themes ) && array_key_exists( $theme, $themes ) )
* @return string
*/
function get_current_theme() {
- _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme()' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'wp_get_theme()' );
if ( $theme = get_option( 'current_theme' ) )
return $theme;
* @return string The pre block without paragraph/line-break conversion.
*/
function clean_pre($matches) {
- _deprecated_function( __FUNCTION__, '3.4' );
+ _deprecated_function( __FUNCTION__, '3.4.0' );
if ( is_array($matches) )
$text = $matches[1] . $matches[2] . "</pre>";
* @deprecated 3.4.0 Use add_theme_support()
* @see add_theme_support()
*
- * @param callable $wp_head_callback Call on 'wp_head' action.
+ * @param callable $wp_head_callback Call on the {@see 'wp_head'} action.
* @param callable $admin_head_callback Call on custom header administration screen.
* @param callable $admin_preview_callback Output a custom header image div on the custom header administration screen. Optional.
*/
function add_custom_image_header( $wp_head_callback, $admin_head_callback, $admin_preview_callback = '' ) {
- _deprecated_function( __FUNCTION__, '3.4', 'add_theme_support( \'custom-header\', $args )' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'add_theme_support( \'custom-header\', $args )' );
$args = array(
'wp-head-callback' => $wp_head_callback,
'admin-head-callback' => $admin_head_callback,
* @return null|bool Whether support was removed.
*/
function remove_custom_image_header() {
- _deprecated_function( __FUNCTION__, '3.4', 'remove_theme_support( \'custom-header\' )' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'remove_theme_support( \'custom-header\' )' );
return remove_theme_support( 'custom-header' );
}
* @deprecated 3.4.0 Use add_theme_support()
* @see add_theme_support()
*
- * @param callable $wp_head_callback Call on 'wp_head' action.
+ * @param callable $wp_head_callback Call on the {@see 'wp_head'} action.
* @param callable $admin_head_callback Call on custom background administration screen.
* @param callable $admin_preview_callback Output a custom background image div on the custom background administration screen. Optional.
*/
function add_custom_background( $wp_head_callback = '', $admin_head_callback = '', $admin_preview_callback = '' ) {
- _deprecated_function( __FUNCTION__, '3.4', 'add_theme_support( \'custom-background\', $args )' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'add_theme_support( \'custom-background\', $args )' );
$args = array();
if ( $wp_head_callback )
$args['wp-head-callback'] = $wp_head_callback;
* @return null|bool Whether support was removed.
*/
function remove_custom_background() {
- _deprecated_function( __FUNCTION__, '3.4', 'remove_theme_support( \'custom-background\' )' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'remove_theme_support( \'custom-background\' )' );
return remove_theme_support( 'custom-background' );
}
* @return array Theme data.
*/
function get_theme_data( $theme_file ) {
- _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme()' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'wp_get_theme()' );
$theme = new WP_Theme( basename( dirname( $theme_file ) ), dirname( dirname( $theme_file ) ) );
$theme_data = array(
* @param array $pages list of page objects
*/
function update_page_cache( &$pages ) {
- _deprecated_function( __FUNCTION__, '3.4', 'update_post_cache()' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'update_post_cache()' );
update_post_cache( $pages );
}
* @param int $id Page ID to clean
*/
function clean_page_cache( $id ) {
- _deprecated_function( __FUNCTION__, '3.4', 'clean_post_cache()' );
+ _deprecated_function( __FUNCTION__, '3.4.0', 'clean_post_cache()' );
clean_post_cache( $id );
}
* @param int $post_id An optional post ID.
*/
function sticky_class( $post_id = null ) {
- _deprecated_function( __FUNCTION__, '3.5', 'post_class()' );
+ _deprecated_function( __FUNCTION__, '3.5.0', 'post_class()' );
if ( is_sticky( $post_id ) )
echo ' sticky';
}
* @since 2.3.4
* @deprecated 3.5.0 Use get_post_ancestors()
* @see get_post_ancestors()
+ *
+ * @param WP_Post &$post Post object, passed by reference (unused).
*/
function _get_post_ancestors( &$post ) {
- _deprecated_function( __FUNCTION__, '3.5' );
+ _deprecated_function( __FUNCTION__, '3.5.0' );
}
/**
* @return resource The resulting image resource on success, Error string on failure.
*/
function wp_load_image( $file ) {
- _deprecated_function( __FUNCTION__, '3.5', 'wp_get_image_editor()' );
+ _deprecated_function( __FUNCTION__, '3.5.0', 'wp_get_image_editor()' );
if ( is_numeric( $file ) )
$file = get_attached_file( $file );
- if ( ! is_file( $file ) )
- return sprintf(__('File “%s” doesn’t exist?'), $file);
+ if ( ! is_file( $file ) ) {
+ /* translators: %s: file name */
+ return sprintf( __( 'File “%s” doesn’t exist?' ), $file );
+ }
if ( ! function_exists('imagecreatefromstring') )
return __('The GD image library is not installed.');
- // Set artificially high because GD uses uncompressed images in memory
- @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
+ // Set artificially high because GD uses uncompressed images in memory.
+ wp_raise_memory_limit( 'image' );
+
$image = imagecreatefromstring( file_get_contents( $file ) );
- if ( !is_resource( $image ) )
- return sprintf(__('File “%s” is not an image.'), $file);
+ if ( ! is_resource( $image ) ) {
+ /* translators: %s: file name */
+ return sprintf( __( 'File “%s” is not an image.' ), $file );
+ }
return $image;
}
* @return mixed WP_Error on failure. String with new destination path.
*/
function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $dest_path = null, $jpeg_quality = 90 ) {
- _deprecated_function( __FUNCTION__, '3.5', 'wp_get_image_editor()' );
+ _deprecated_function( __FUNCTION__, '3.5.0', 'wp_get_image_editor()' );
$editor = wp_get_image_editor( $file );
if ( is_wp_error( $editor ) )
* @return WP_Post|null Post object or array holding post contents and information
*/
function wp_get_single_post( $postid = 0, $mode = OBJECT ) {
- _deprecated_function( __FUNCTION__, '3.5', 'get_post()' );
+ _deprecated_function( __FUNCTION__, '3.5.0', 'get_post()' );
return get_post( $postid, $mode );
}
* @return bool False if does not authenticate, true if username and password authenticates.
*/
function user_pass_ok($user_login, $user_pass) {
- _deprecated_function( __FUNCTION__, '3.5', 'wp_authenticate()' );
+ _deprecated_function( __FUNCTION__, '3.5.0', 'wp_authenticate()' );
$user = wp_authenticate( $user_login, $user_pass );
if ( is_wp_error( $user ) )
return false;
* @return bool
*/
function gd_edit_image_support($mime_type) {
- _deprecated_function( __FUNCTION__, '3.5', 'wp_image_editor_supports()' );
+ _deprecated_function( __FUNCTION__, '3.5.0', 'wp_image_editor_supports()' );
if ( function_exists('imagetypes') ) {
switch( $mime_type ) {
* @return string A shorthand byte value.
*/
function wp_convert_bytes_to_hr( $bytes ) {
- _deprecated_function( __FUNCTION__, '3.6', 'size_format()' );
+ _deprecated_function( __FUNCTION__, '3.6.0', 'size_format()' );
- $units = array( 0 => 'B', 1 => 'kB', 2 => 'MB', 3 => 'GB', 4 => 'TB' );
+ $units = array( 0 => 'B', 1 => 'KB', 2 => 'MB', 3 => 'GB', 4 => 'TB' );
$log = log( $bytes, KB_IN_BYTES );
$power = (int) $log;
$size = pow( KB_IN_BYTES, $log - $power );
* @since 2.9.0
* @access private
* @deprecated 3.7.0
+ *
+ * @param string $t Search terms to "tidy", e.g. trim.
+ * @return string Trimmed search terms.
*/
function _search_terms_tidy( $t ) {
- _deprecated_function( __FUNCTION__, '3.7' );
+ _deprecated_function( __FUNCTION__, '3.7.0' );
return trim( $t, "\"'\n\r " );
}
*/
function rich_edit_exists() {
global $wp_rich_edit_exists;
- _deprecated_function( __FUNCTION__, '3.9' );
+ _deprecated_function( __FUNCTION__, '3.9.0' );
if ( ! isset( $wp_rich_edit_exists ) )
$wp_rich_edit_exists = file_exists( ABSPATH . WPINC . '/js/tinymce/tinymce.js' );
* @since 2.7.0
* @access private
* @deprecated 3.9.0
+ *
+ * @param int $count Number of topics.
+ * @return int Number of topics.
*/
function default_topic_count_text( $count ) {
return $count;
* @return string The very same text.
*/
function format_to_post( $content ) {
- _deprecated_function( __FUNCTION__, '3.9' );
+ _deprecated_function( __FUNCTION__, '3.9.0' );
return $content;
}
* @return string text, safe for inclusion in LIKE query.
*/
function like_escape($text) {
- _deprecated_function( __FUNCTION__, '4.0', 'wpdb::esc_like()' );
+ _deprecated_function( __FUNCTION__, '4.0.0', 'wpdb::esc_like()' );
return str_replace( array( "%", "_" ), array( "\\%", "\\_" ), $text );
}
* @return bool Whether SSL access is available.
*/
function url_is_accessable_via_ssl( $url ) {
- _deprecated_function( __FUNCTION__, '4.0' );
+ _deprecated_function( __FUNCTION__, '4.0.0' );
$response = wp_remote_get( set_url_scheme( $url, 'https' ) );
* @deprecated 4.3.0
*/
function preview_theme() {
- _deprecated_function( __FUNCTION__, '4.3' );
+ _deprecated_function( __FUNCTION__, '4.3.0' );
}
/**
* @return string
*/
function _preview_theme_template_filter() {
- _deprecated_function( __FUNCTION__, '4.3' );
+ _deprecated_function( __FUNCTION__, '4.3.0' );
return '';
}
* @return string
*/
function _preview_theme_stylesheet_filter() {
- _deprecated_function( __FUNCTION__, '4.3' );
+ _deprecated_function( __FUNCTION__, '4.3.0' );
return '';
}
* @return string
*/
function preview_theme_ob_filter( $content ) {
- _deprecated_function( __FUNCTION__, '4.3' );
+ _deprecated_function( __FUNCTION__, '4.3.0' );
return $content;
}
* @return string
*/
function preview_theme_ob_filter_callback( $matches ) {
- _deprecated_function( __FUNCTION__, '4.3' );
+ _deprecated_function( __FUNCTION__, '4.3.0' );
return '';
}
/**
* Formats text for the rich text editor.
*
- * The filter 'richedit_pre' is applied here. If $text is empty the filter will
+ * The {@see 'richedit_pre'} filter is applied here. If $text is empty the filter will
* be applied to an empty string.
*
* @since 2.0.0
* @return string The formatted text after filter is applied.
*/
function wp_richedit_pre($text) {
- _deprecated_function( __FUNCTION__, '4.3', 'format_for_editor()' );
+ _deprecated_function( __FUNCTION__, '4.3.0', 'format_for_editor()' );
if ( empty( $text ) ) {
/**
- * Filter text returned for the rich text editor.
+ * Filters text returned for the rich text editor.
*
* This filter is first evaluated, and the value returned, if an empty string
* is passed to wp_richedit_pre(). If an empty string is passed, it results
* Formats text for the HTML editor.
*
* Unless $output is empty it will pass through htmlspecialchars before the
- * 'htmledit_pre' filter is applied.
+ * {@see 'htmledit_pre'} filter is applied.
*
* @since 2.5.0
* @deprecated 4.3.0 Use format_for_editor()
* @return string Formatted text after filter applied.
*/
function wp_htmledit_pre($output) {
- _deprecated_function( __FUNCTION__, '4.3', 'format_for_editor()' );
+ _deprecated_function( __FUNCTION__, '4.3.0', 'format_for_editor()' );
if ( !empty($output) )
$output = htmlspecialchars($output, ENT_NOQUOTES, get_option( 'blog_charset' ) ); // convert only < > &
/**
- * Filter the text before it is formatted for the HTML editor.
+ * Filters the text before it is formatted for the HTML editor.
*
* @since 2.5.0
* @deprecated 4.3.0
* @return string|false
*/
function post_permalink( $post_id = 0 ) {
- _deprecated_function( __FUNCTION__, '4.4', 'get_permalink()' );
+ _deprecated_function( __FUNCTION__, '4.4.0', 'get_permalink()' );
return get_permalink( $post_id );
}
* @return bool|string False on failure and string of headers if HEAD request.
*/
function wp_get_http( $url, $file_path = false, $red = 1 ) {
- _deprecated_function( __FUNCTION__, '4.4', 'WP_Http' );
+ _deprecated_function( __FUNCTION__, '4.4.0', 'WP_Http' );
@set_time_limit( 60 );
* @return bool True if forced, false if not forced.
*/
function force_ssl_login( $force = null ) {
- _deprecated_function( __FUNCTION__, '4.4', 'force_ssl_admin()' );
+ _deprecated_function( __FUNCTION__, '4.4.0', 'force_ssl_admin()' );
return force_ssl_admin( $force );
}
+
+/**
+ * Retrieve path of comment popup template in current or parent template.
+ *
+ * @since 1.5.0
+ * @deprecated 4.5.0
+ *
+ * @return string Full path to comments popup template file.
+ */
+function get_comments_popup_template() {
+ _deprecated_function( __FUNCTION__, '4.5.0' );
+
+ return '';
+}
+
+/**
+ * Whether the current URL is within the comments popup window.
+ *
+ * @since 1.5.0
+ * @deprecated 4.5.0
+ *
+ * @return bool
+ */
+function is_comments_popup() {
+ _deprecated_function( __FUNCTION__, '4.5.0' );
+
+ return false;
+}
+
+/**
+ * Display the JS popup script to show a comment.
+ *
+ * @since 0.71
+ * @deprecated 4.5.0
+ */
+function comments_popup_script() {
+ _deprecated_function( __FUNCTION__, '4.5.0' );
+}
+
+/**
+ * Adds element attributes to open links in new windows.
+ *
+ * @since 0.71
+ * @deprecated 4.5.0
+ *
+ * @param string $text Content to replace links to open in a new window.
+ * @return string Content that has filtered links.
+ */
+function popuplinks( $text ) {
+ _deprecated_function( __FUNCTION__, '4.5.0' );
+ $text = preg_replace('/<a (.+?)>/i', "<a $1 target='_blank' rel='external'>", $text);
+ return $text;
+}
+
+/**
+ * The Google Video embed handler callback.
+ *
+ * Deprecated function that previously assisted in turning Google Video URLs
+ * into embeds but that service has since been shut down.
+ *
+ * @since 2.9.0
+ * @deprecated 4.6.0
+ *
+ * @return string An empty string.
+ */
+function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
+ _deprecated_function( __FUNCTION__, '4.6.0' );
+
+ return '';
+}
+
+/**
+ * Retrieve path of paged template in current or parent template.
+ *
+ * @since 1.5.0
+ * @deprecated 4.7.0 The paged.php template is no longer part of the theme template hierarchy.
+ *
+ * @return string Full path to paged template file.
+ */
+function get_paged_template() {
+ _deprecated_function( __FUNCTION__, '4.7.0' );
+
+ return get_query_template( 'paged' );
+}
+
+/**
+ * Removes the HTML JavaScript entities found in early versions of Netscape 4.
+ *
+ * Previously, this function was pulled in from the original
+ * import of kses and removed a specific vulnerability only
+ * existent in early version of Netscape 4. However, this
+ * vulnerability never affected any other browsers and can
+ * be considered safe for the modern web.
+ *
+ * The regular expression which sanitized this vulnerability
+ * has been removed in consideration of the performance and
+ * energy demands it placed, now merely passing through its
+ * input to the return.
+ *
+ * @since 1.0.0
+ * @deprecated deprecated since 4.7
+ *
+ * @param string $string
+ * @return string
+ */
+function wp_kses_js_entities( $string ) {
+ _deprecated_function( __FUNCTION__, '4.7.0' );
+
+ return preg_replace( '%&\s*\{[^}]*(\}\s*;?|$)%', '', $string );
+}
+
+/**
+ * Sort categories by ID.
+ *
+ * Used by usort() as a callback, should not be used directly. Can actually be
+ * used to sort any term object.
+ *
+ * @since 2.3.0
+ * @deprecated 4.7.0 Use wp_list_sort()
+ * @access private
+ *
+ * @param object $a
+ * @param object $b
+ * @return int
+ */
+function _usort_terms_by_ID( $a, $b ) {
+ _deprecated_function( __FUNCTION__, '4.7.0', 'wp_list_sort' );
+
+ if ( $a->term_id > $b->term_id )
+ return 1;
+ elseif ( $a->term_id < $b->term_id )
+ return -1;
+ else
+ return 0;
+}
+
+/**
+ * Sort categories by name.
+ *
+ * Used by usort() as a callback, should not be used directly. Can actually be
+ * used to sort any term object.
+ *
+ * @since 2.3.0
+ * @deprecated 4.7.0 Use wp_list_sort()
+ * @access private
+ *
+ * @param object $a
+ * @param object $b
+ * @return int
+ */
+function _usort_terms_by_name( $a, $b ) {
+ _deprecated_function( __FUNCTION__, '4.7.0', 'wp_list_sort' );
+
+ return strcmp( $a->name, $b->name );
+}
+
+/**
+ * Sort menu items by the desired key.
+ *
+ * @since 3.0.0
+ * @deprecated 4.7.0 Use wp_list_sort()
+ * @access private
+ *
+ * @global string $_menu_item_sort_prop
+ *
+ * @param object $a The first object to compare
+ * @param object $b The second object to compare
+ * @return int -1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b.
+ */
+function _sort_nav_menu_items( $a, $b ) {
+ global $_menu_item_sort_prop;
+
+ _deprecated_function( __FUNCTION__, '4.7.0', 'wp_list_sort' );
+
+ if ( empty( $_menu_item_sort_prop ) )
+ return 0;
+
+ if ( ! isset( $a->$_menu_item_sort_prop ) || ! isset( $b->$_menu_item_sort_prop ) )
+ return 0;
+
+ $_a = (int) $a->$_menu_item_sort_prop;
+ $_b = (int) $b->$_menu_item_sort_prop;
+
+ if ( $a->$_menu_item_sort_prop == $b->$_menu_item_sort_prop )
+ return 0;
+ elseif ( $_a == $a->$_menu_item_sort_prop && $_b == $b->$_menu_item_sort_prop )
+ return $_a < $_b ? -1 : 1;
+ else
+ return strcmp( $a->$_menu_item_sort_prop, $b->$_menu_item_sort_prop );
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff