2006-03-01 22:27:48 -05:00
< ? php
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Deprecated functions from past WordPress versions . You shouldn ' t use these
2010-02-19 14:57:03 -05:00
* functions and look for the alternatives instead . The functions will be
* removed in a later version .
2008-08-27 02:45:13 -04:00
*
2007-12-10 13:52:24 -05:00
* @ package WordPress
* @ subpackage Deprecated
*/
2007-01-13 16:23:41 -05:00
2006-03-01 22:27:48 -05:00
/*
2007-01-23 04:15:17 -05:00
* Deprecated functions come here to die .
2006-03-01 22:27:48 -05:00
*/
2007-12-10 13:52:24 -05:00
/**
2016-02-28 14:32:25 -05:00
* Retrieves all post data for a given post .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 1.5 . 1 Use get_post ()
2007-12-10 13:52:24 -05:00
* @ see get_post ()
*
2016-02-28 14:32:25 -05:00
* @ param int $postid Post ID .
* @ return array Post data .
2007-12-10 13:52:24 -05:00
*/
2006-03-01 22:27:48 -05:00
function get_postdata ( $postid ) {
2009-12-23 13:54:17 -05:00
_deprecated_function ( __FUNCTION__ , '1.5.1' , 'get_post()' );
2007-12-28 16:17:42 -05:00
2012-08-23 16:01:10 -04:00
$post = get_post ( $postid );
2006-03-01 22:27:48 -05:00
$postdata = array (
'ID' => $post -> ID ,
'Author_ID' => $post -> post_author ,
'Date' => $post -> post_date ,
'Content' => $post -> post_content ,
'Excerpt' => $post -> post_excerpt ,
'Title' => $post -> post_title ,
'Category' => $post -> post_category ,
'post_status' => $post -> post_status ,
'comment_status' => $post -> comment_status ,
'ping_status' => $post -> ping_status ,
'post_password' => $post -> post_password ,
'to_ping' => $post -> to_ping ,
'pinged' => $post -> pinged ,
'post_type' => $post -> post_type ,
'post_name' => $post -> post_name
);
return $postdata ;
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Sets up the WordPress Loop .
2007-12-10 13:52:24 -05:00
*
2015-08-20 18:11:26 -04:00
* Use The Loop instead .
*
2019-07-25 18:45:57 -04:00
* @ link https :// developer . wordpress . org / themes / basics / the - loop /
2015-08-20 18:11:26 -04:00
*
2007-12-10 13:52:24 -05:00
* @ since 1.0 . 1
2013-12-24 13:57:12 -05:00
* @ deprecated 1.5 . 0
2007-12-10 13:52:24 -05:00
*/
2006-03-01 22:27:48 -05:00
function start_wp () {
2012-09-04 12:29:28 -04:00
global $wp_query ;
2006-03-01 22:27:48 -05:00
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '1.5.0' , __ ( 'new WordPress Loop' ) );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
// Since the old style loop is being used, advance the query iterator here.
$wp_query -> next_post ();
2012-09-04 12:29:28 -04:00
setup_postdata ( get_post () );
2006-03-01 22:27:48 -05:00
}
2007-12-10 13:52:24 -05:00
/**
2016-02-28 14:32:25 -05:00
* Returns or prints a category ID .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 0.71 Use get_the_category ()
2010-11-12 16:53:15 -05:00
* @ see get_the_category ()
2007-12-10 13:52:24 -05:00
*
2016-02-28 14:32:25 -05:00
* @ param bool $echo Optional . Whether to echo the output . Default true .
* @ return int Category ID .
2007-12-10 13:52:24 -05:00
*/
2006-03-01 22:27:48 -05:00
function the_category_ID ( $echo = true ) {
2010-11-12 16:53:15 -05:00
_deprecated_function ( __FUNCTION__ , '0.71' , 'get_the_category()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
// Grab the first cat in the list.
2010-11-12 16:53:15 -05:00
$categories = get_the_category ();
2007-05-27 15:32:45 -04:00
$cat = $categories [ 0 ] -> term_id ;
2006-03-01 22:27:48 -05:00
if ( $echo )
echo $cat ;
return $cat ;
}
2007-12-10 13:52:24 -05:00
/**
2016-02-28 14:32:25 -05:00
* Prints a category with optional text before and after .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 0.71 Use get_the_category_by_ID ()
2007-12-10 13:52:24 -05:00
* @ see get_the_category_by_ID ()
*
2016-02-28 14:32:25 -05:00
* @ param string $before Optional . Text to display before the category . Default empty .
* @ param string $after Optional . Text to display after the category . Default empty .
2007-12-10 13:52:24 -05:00
*/
2016-02-28 14:32:25 -05:00
function the_category_head ( $before = '' , $after = '' ) {
2006-03-01 22:27:48 -05:00
global $currentcat , $previouscat ;
2007-12-28 16:17:42 -05:00
2009-12-23 13:54:17 -05:00
_deprecated_function ( __FUNCTION__ , '0.71' , 'get_the_category_by_ID()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
// Grab the first cat in the list.
2010-11-12 16:53:15 -05:00
$categories = get_the_category ();
2006-03-01 22:27:48 -05:00
$currentcat = $categories [ 0 ] -> category_id ;
if ( $currentcat != $previouscat ) {
echo $before ;
echo get_the_category_by_ID ( $currentcat );
echo $after ;
$previouscat = $currentcat ;
}
}
2007-12-10 13:52:24 -05:00
/**
2016-02-28 14:32:25 -05:00
* Prints a link to the previous post .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use previous_post_link ()
2007-12-10 13:52:24 -05:00
* @ see previous_post_link ()
*
* @ param string $format
* @ param string $previous
* @ param string $title
* @ param string $in_same_cat
2016-02-28 14:32:25 -05:00
* @ param int $limitprev
2007-12-10 13:52:24 -05:00
* @ param string $excluded_categories
*/
2006-03-01 22:31:43 -05:00
function previous_post ( $format = '%' , $previous = 'previous post: ' , $title = 'yes' , $in_same_cat = 'no' , $limitprev = 1 , $excluded_categories = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'previous_post_link()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:31:43 -05:00
if ( empty ( $in_same_cat ) || 'no' == $in_same_cat )
$in_same_cat = false ;
else
$in_same_cat = true ;
$post = get_previous_post ( $in_same_cat , $excluded_categories );
if ( ! $post )
return ;
$string = '<a href="' . get_permalink ( $post -> ID ) . '">' . $previous ;
if ( 'yes' == $title )
2011-10-06 17:09:37 -04:00
$string .= apply_filters ( 'the_title' , $post -> post_title , $post -> ID );
2006-03-01 22:31:43 -05:00
$string .= '</a>' ;
$format = str_replace ( '%' , $string , $format );
echo $format ;
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Prints link to the next post .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use next_post_link ()
2007-12-10 13:52:24 -05:00
* @ see next_post_link ()
*
* @ param string $format
2010-09-07 07:21:11 -04:00
* @ param string $next
2007-12-10 13:52:24 -05:00
* @ param string $title
* @ param string $in_same_cat
2010-09-07 07:21:11 -04:00
* @ param int $limitnext
2007-12-10 13:52:24 -05:00
* @ param string $excluded_categories
*/
2006-03-01 22:31:43 -05:00
function next_post ( $format = '%' , $next = 'next post: ' , $title = 'yes' , $in_same_cat = 'no' , $limitnext = 1 , $excluded_categories = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'next_post_link()' );
2006-03-01 22:31:43 -05:00
if ( empty ( $in_same_cat ) || 'no' == $in_same_cat )
$in_same_cat = false ;
else
$in_same_cat = true ;
$post = get_next_post ( $in_same_cat , $excluded_categories );
if ( ! $post )
return ;
$string = '<a href="' . get_permalink ( $post -> ID ) . '">' . $next ;
if ( 'yes' == $title )
2011-10-06 17:09:37 -04:00
$string .= apply_filters ( 'the_title' , $post -> post_title , $post -> ID );
2006-03-01 22:31:43 -05:00
$string .= '</a>' ;
$format = str_replace ( '%' , $string , $format );
echo $format ;
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Whether user can create a post .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $blog_id Not Used
* @ param int $category_id Not Used
* @ return bool
*/
2006-03-01 22:27:48 -05:00
function user_can_create_post ( $user_id , $blog_id = 1 , $category_id = 'None' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
$author_data = get_userdata ( $user_id );
return ( $author_data -> user_level > 1 );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Whether user can create a post .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $blog_id Not Used
* @ param int $category_id Not Used
* @ return bool
*/
2006-03-01 22:27:48 -05:00
function user_can_create_draft ( $user_id , $blog_id = 1 , $category_id = 'None' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
$author_data = get_userdata ( $user_id );
return ( $author_data -> user_level >= 1 );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Whether user can edit a post .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $post_id
* @ param int $blog_id Not Used
* @ return bool
*/
2006-03-01 22:27:48 -05:00
function user_can_edit_post ( $user_id , $post_id , $blog_id = 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
$author_data = get_userdata ( $user_id );
$post = get_post ( $post_id );
$post_author_data = get_userdata ( $post -> post_author );
2010-02-13 01:39:51 -05:00
if ( (( $user_id == $post_author_data -> ID ) && ! ( $post -> post_status == 'publish' && $author_data -> user_level < 2 ))
2019-07-05 01:21:56 -04:00
|| ( $author_data -> user_level > $post_author_data -> user_level )
|| ( $author_data -> user_level >= 10 ) ) {
2006-03-01 22:27:48 -05:00
return true ;
} else {
return false ;
}
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Whether user can delete a post .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $post_id
* @ param int $blog_id Not Used
* @ return bool
*/
2006-03-01 22:27:48 -05:00
function user_can_delete_post ( $user_id , $post_id , $blog_id = 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2020-01-28 19:45:18 -05:00
// Right now if one can edit, one can delete.
2006-03-01 22:27:48 -05:00
return user_can_edit_post ( $user_id , $post_id , $blog_id );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Whether user can set new posts ' dates .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $blog_id Not Used
* @ param int $category_id Not Used
* @ return bool
*/
2006-03-01 22:27:48 -05:00
function user_can_set_post_date ( $user_id , $blog_id = 1 , $category_id = 'None' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
$author_data = get_userdata ( $user_id );
return (( $author_data -> user_level > 4 ) && user_can_create_post ( $user_id , $blog_id , $category_id ));
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Whether user can delete a post .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $post_id
* @ param int $blog_id Not Used
2008-08-27 02:45:13 -04:00
* @ return bool returns true if $user_id can edit $post_id ' s date
2007-12-10 13:52:24 -05:00
*/
2006-03-01 22:27:48 -05:00
function user_can_edit_post_date ( $user_id , $post_id , $blog_id = 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
$author_data = get_userdata ( $user_id );
return (( $author_data -> user_level > 4 ) && user_can_edit_post ( $user_id , $post_id , $blog_id ));
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Whether user can delete a post .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $post_id
* @ param int $blog_id Not Used
2008-08-27 02:45:13 -04:00
* @ return bool returns true if $user_id can edit $post_id ' s comments
2007-12-10 13:52:24 -05:00
*/
2006-03-01 22:27:48 -05:00
function user_can_edit_post_comments ( $user_id , $post_id , $blog_id = 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2020-01-28 19:45:18 -05:00
// Right now if one can edit a post, one can edit comments made on it.
2006-03-01 22:27:48 -05:00
return user_can_edit_post ( $user_id , $post_id , $blog_id );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Whether user can delete a post .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $post_id
* @ param int $blog_id Not Used
2008-08-27 02:45:13 -04:00
* @ return bool returns true if $user_id can delete $post_id ' s comments
2007-12-10 13:52:24 -05:00
*/
2006-03-01 22:27:48 -05:00
function user_can_delete_post_comments ( $user_id , $post_id , $blog_id = 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2020-01-28 19:45:18 -05:00
// Right now if one can edit comments, one can delete comments.
2006-03-01 22:27:48 -05:00
return user_can_edit_post_comments ( $user_id , $post_id , $blog_id );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Can user can edit other user .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use current_user_can ()
2007-12-10 13:52:24 -05:00
* @ see current_user_can ()
*
* @ param int $user_id
* @ param int $other_user
* @ return bool
*/
2006-03-01 22:27:48 -05:00
function user_can_edit_user ( $user_id , $other_user ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'current_user_can()' );
2007-12-28 16:17:42 -05:00
2006-03-01 22:27:48 -05:00
$user = get_userdata ( $user_id );
$other = get_userdata ( $other_user );
if ( $user -> user_level > $other -> user_level || $user -> user_level > 8 || $user -> ID == $other -> ID )
return true ;
else
return false ;
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Gets the links associated with category $cat_name .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_bookmarks ()
2009-12-23 13:54:17 -05:00
* @ see get_bookmarks ()
2007-12-10 13:52:24 -05:00
*
2008-08-27 02:45:13 -04:00
* @ param string $cat_name Optional . The category name to use . If no match is found uses all .
* @ param string $before Optional . The html to output before the link .
* @ param string $after Optional . The html to output after the link .
2012-12-20 10:55:32 -05:00
* @ param string $between Optional . The html to output between the link / image and its description . Not used if no image or $show_images is true .
2008-08-27 02:45:13 -04:00
* @ param bool $show_images Optional . Whether to show images ( if defined ) .
* @ param string $orderby Optional . The order to output the links . E . g . 'id' , 'name' , 'url' , 'description' or 'rating' . Or maybe owner .
2007-12-10 13:52:24 -05:00
* If you start the name with an underscore the order will be reversed . You can also specify 'rand' as the order which will return links in a
* random order .
2008-08-27 02:45:13 -04:00
* @ param bool $show_description Optional . Whether to show the description if show_images = false / not defined .
* @ param bool $show_rating Optional . Show rating stars / chars .
* @ param int $limit Optional . Limit to X entries . If not specified , all entries are shown .
* @ param int $show_updated Optional . Whether to show last updated timestamp
2007-12-10 13:52:24 -05:00
*/
function get_linksbyname ( $cat_name = " noname " , $before = '' , $after = '<br />' , $between = " " , $show_images = true , $orderby = 'id' ,
2019-07-05 01:21:56 -04:00
$show_description = true , $show_rating = false ,
$limit = - 1 , $show_updated = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_bookmarks()' );
2007-12-28 16:17:42 -05:00
2007-12-10 13:52:24 -05:00
$cat_id = - 1 ;
2007-05-27 15:32:45 -04:00
$cat = get_term_by ( 'name' , $cat_name , 'link_category' );
2007-12-10 13:52:24 -05:00
if ( $cat )
$cat_id = $cat -> term_id ;
get_links ( $cat_id , $before , $after , $between , $show_images , $orderby , $show_description , $show_rating , $limit , $show_updated );
}
/**
2008-08-27 02:45:13 -04:00
* Gets the links associated with the named category .
2007-12-10 13:52:24 -05:00
*
* @ since 1.0 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_list_bookmarks ()
2009-12-23 13:49:22 -05:00
* @ see wp_list_bookmarks ()
2007-12-10 13:52:24 -05:00
*
* @ param string $category The category to use .
* @ param string $args
2014-11-30 20:34:24 -05:00
* @ return string | null
2007-12-10 13:52:24 -05:00
*/
function wp_get_linksbyname ( $category , $args = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_list_bookmarks()' );
2007-12-28 16:17:42 -05:00
2009-12-23 13:49:22 -05:00
$defaults = array (
'after' => '<br />' ,
'before' => '' ,
'categorize' => 0 ,
'category_after' => '' ,
'category_before' => '' ,
'category_name' => $category ,
'show_description' => 1 ,
'title_li' => '' ,
);
2010-01-15 17:11:12 -05:00
2019-07-24 20:48:58 -04:00
$parsed_args = wp_parse_args ( $args , $defaults );
2006-03-01 22:27:48 -05:00
2019-07-24 20:48:58 -04:00
return wp_list_bookmarks ( $parsed_args );
2007-01-23 04:15:17 -05:00
}
2006-03-01 22:27:48 -05:00
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Gets an array of link objects associated with category $cat_name .
2007-12-10 13:52:24 -05:00
*
2014-11-24 00:19:23 -05:00
* $links = get_linkobjectsbyname ( 'fred' );
* foreach ( $links as $link ) {
* echo '<li>' . $link -> link_name . '</li>' ;
* }
2007-12-10 13:52:24 -05:00
*
* @ since 1.0 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_bookmarks ()
2009-12-23 13:54:17 -05:00
* @ see get_bookmarks ()
2007-12-10 13:52:24 -05:00
*
* @ param string $cat_name The category name to use . If no match is found uses all .
2008-02-05 01:47:27 -05:00
* @ param string $orderby The order to output the links . E . g . 'id' , 'name' , 'url' , 'description' , or 'rating' .
* Or maybe owner . If you start the name with an underscore the order will be reversed . You can also
2007-12-10 13:52:24 -05:00
* specify 'rand' as the order which will return links in a random order .
* @ param int $limit Limit to X entries . If not specified , all entries are shown .
2014-11-03 01:17:22 -05:00
* @ return array
2007-12-10 13:52:24 -05:00
*/
2006-03-01 22:27:48 -05:00
function get_linkobjectsbyname ( $cat_name = " noname " , $orderby = 'name' , $limit = - 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_bookmarks()' );
2007-12-28 16:17:42 -05:00
2007-12-10 13:52:24 -05:00
$cat_id = - 1 ;
$cat = get_term_by ( 'name' , $cat_name , 'link_category' );
if ( $cat )
$cat_id = $cat -> term_id ;
return get_linkobjects ( $cat_id , $orderby , $limit );
}
/**
2008-08-27 02:45:13 -04:00
* Gets an array of link objects associated with category n .
2007-12-10 13:52:24 -05:00
*
* Usage :
2014-11-24 00:19:23 -05:00
*
* $links = get_linkobjects ( 1 );
* if ( $links ) {
* foreach ( $links as $link ) {
* echo '<li>' . $link -> link_name . '<br />' . $link -> link_description . '</li>' ;
* }
* }
2007-12-10 13:52:24 -05:00
*
* Fields are :
2014-11-24 00:19:23 -05:00
*
* - link_id
* - link_url
* - link_name
* - link_image
* - link_target
* - link_category
* - link_description
* - link_visible
* - link_owner
* - link_rating
* - link_updated
* - link_rel
* - link_notes
2007-12-10 13:52:24 -05:00
*
* @ since 1.0 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_bookmarks ()
2007-12-10 13:52:24 -05:00
* @ see get_bookmarks ()
*
* @ param int $category The category to use . If no category supplied uses all
* @ param string $orderby the order to output the links . E . g . 'id' , 'name' , 'url' ,
2008-02-05 01:47:27 -05:00
* 'description' , or 'rating' . Or maybe owner . If you start the name with an
2007-12-10 13:52:24 -05:00
* underscore the order will be reversed . You can also specify 'rand' as the
* order which will return links in a random order .
* @ param int $limit Limit to X entries . If not specified , all entries are shown .
2014-11-03 01:17:22 -05:00
* @ return array
2007-12-10 13:52:24 -05:00
*/
2007-05-27 15:32:45 -04:00
function get_linkobjects ( $category = 0 , $orderby = 'name' , $limit = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_bookmarks()' );
2007-12-28 16:17:42 -05:00
2010-01-08 03:34:39 -05:00
$links = get_bookmarks ( array ( 'category' => $category , 'orderby' => $orderby , 'limit' => $limit ) ) ;
2006-11-19 02:56:05 -05:00
2007-12-10 13:52:24 -05:00
$links_array = array ();
foreach ( $links as $link )
$links_array [] = $link ;
2007-05-27 15:32:45 -04:00
2007-12-10 13:52:24 -05:00
return $links_array ;
}
/**
2008-08-27 02:45:13 -04:00
* Gets the links associated with category 'cat_name' and display rating stars / chars .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_bookmarks ()
2007-12-10 13:52:24 -05:00
* @ see get_bookmarks ()
*
* @ param string $cat_name The category name to use . If no match is found uses all
* @ param string $before The html to output before the link
* @ param string $after The html to output after the link
2012-12-20 10:55:32 -05:00
* @ param string $between The html to output between the link / image and its description . Not used if no image or show_images is true
2007-12-10 13:52:24 -05:00
* @ param bool $show_images Whether to show images ( if defined ) .
* @ param string $orderby the order to output the links . E . g . 'id' , 'name' , 'url' ,
2008-02-05 01:47:27 -05:00
* 'description' , or 'rating' . Or maybe owner . If you start the name with an
2007-12-10 13:52:24 -05:00
* underscore the order will be reversed . You can also specify 'rand' as the
* order which will return links in a random order .
* @ param bool $show_description Whether to show the description if show_images = false / not defined
* @ param int $limit Limit to X entries . If not specified , all entries are shown .
* @ param int $show_updated Whether to show last updated timestamp
*/
function get_linksbyname_withrating ( $cat_name = " noname " , $before = '' , $after = '<br />' , $between = " " ,
$show_images = true , $orderby = 'id' , $show_description = true , $limit = - 1 , $show_updated = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_bookmarks()' );
2007-05-27 15:32:45 -04:00
2007-12-10 13:52:24 -05:00
get_linksbyname ( $cat_name , $before , $after , $between , $show_images , $orderby , $show_description , true , $limit , $show_updated );
}
/**
2008-08-27 02:45:13 -04:00
* Gets the links associated with category n and display rating stars / chars .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_bookmarks ()
2007-12-10 13:52:24 -05:00
* @ see get_bookmarks ()
*
* @ param int $category The category to use . If no category supplied uses all
* @ param string $before The html to output before the link
* @ param string $after The html to output after the link
2012-12-20 10:55:32 -05:00
* @ param string $between The html to output between the link / image and its description . Not used if no image or show_images == true
2007-12-10 13:52:24 -05:00
* @ param bool $show_images Whether to show images ( if defined ) .
* @ param string $orderby The order to output the links . E . g . 'id' , 'name' , 'url' ,
2008-02-05 01:47:27 -05:00
* 'description' , or 'rating' . Or maybe owner . If you start the name with an
2007-12-10 13:52:24 -05:00
* underscore the order will be reversed . You can also specify 'rand' as the
* order which will return links in a random order .
* @ param bool $show_description Whether to show the description if show_images = false / not defined .
2014-11-30 20:34:24 -05:00
* @ param int $limit Limit to X entries . If not specified , all entries are shown .
2007-12-10 13:52:24 -05:00
* @ param int $show_updated Whether to show last updated timestamp
*/
function get_links_withrating ( $category = - 1 , $before = '' , $after = '<br />' , $between = " " , $show_images = true ,
2019-07-05 01:21:56 -04:00
$orderby = 'id' , $show_description = true , $limit = - 1 , $show_updated = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_bookmarks()' );
2007-12-10 13:52:24 -05:00
get_links ( $category , $before , $after , $between , $show_images , $orderby , $show_description , true , $limit , $show_updated );
}
/**
2008-08-27 02:45:13 -04:00
* Gets the auto_toggle setting .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2013-12-24 13:57:12 -05:00
* @ deprecated 2.1 . 0
2007-12-10 13:52:24 -05:00
*
* @ param int $id The category to get . If no category supplied uses 0
* @ return int Only returns 0.
2006-03-01 22:27:48 -05:00
*/
function get_autotoggle ( $id = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' );
2006-11-19 02:56:05 -05:00
return 0 ;
2006-03-01 22:27:48 -05:00
}
2007-12-10 13:52:24 -05:00
/**
2015-08-20 18:11:26 -04:00
* Lists categories .
*
2007-12-10 13:52:24 -05:00
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_list_categories ()
2007-12-10 13:52:24 -05:00
* @ see wp_list_categories ()
*
* @ param int $optionall
* @ param string $all
* @ param string $sort_column
* @ param string $sort_order
* @ param string $file
* @ param bool $list
* @ param int $optiondates
* @ param int $optioncount
* @ param int $hide_empty
* @ param int $use_desc_for_title
* @ param bool $children
* @ param int $child_of
* @ param int $categories
* @ param int $recurse
* @ param string $feed
* @ param string $feed_image
* @ param string $exclude
* @ param bool $hierarchical
2020-01-11 13:32:05 -05:00
* @ return null | false
2007-12-10 13:52:24 -05:00
*/
2008-02-05 01:47:27 -05:00
function list_cats ( $optionall = 1 , $all = 'All' , $sort_column = 'ID' , $sort_order = 'asc' , $file = '' , $list = true , $optiondates = 0 ,
2019-07-05 01:21:56 -04:00
$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 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_list_categories()' );
2007-12-28 16:17:42 -05:00
2006-06-29 21:11:42 -04:00
$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' );
2006-03-01 22:27:48 -05:00
return wp_list_cats ( $query );
}
2007-12-10 13:52:24 -05:00
/**
2015-08-20 18:11:26 -04:00
* Lists categories .
*
2013-12-24 13:57:12 -05:00
* @ since 1.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_list_categories ()
2007-12-10 13:52:24 -05:00
* @ see wp_list_categories ()
*
* @ param string | array $args
2020-01-11 13:32:05 -05:00
* @ return null | string | false
2007-12-10 13:52:24 -05:00
*/
2006-03-03 16:38:36 -05:00
function wp_list_cats ( $args = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_list_categories()' );
2007-12-28 16:17:42 -05:00
2019-07-24 20:48:58 -04:00
$parsed_args = wp_parse_args ( $args );
2006-03-03 16:38:36 -05:00
// Map to new names.
2019-07-24 20:48:58 -04:00
if ( isset ( $parsed_args [ 'optionall' ]) && isset ( $parsed_args [ 'all' ]))
$parsed_args [ 'show_option_all' ] = $parsed_args [ 'all' ];
if ( isset ( $parsed_args [ 'sort_column' ]) )
$parsed_args [ 'orderby' ] = $parsed_args [ 'sort_column' ];
if ( isset ( $parsed_args [ 'sort_order' ]) )
$parsed_args [ 'order' ] = $parsed_args [ 'sort_order' ];
if ( isset ( $parsed_args [ 'optiondates' ]) )
$parsed_args [ 'show_last_update' ] = $parsed_args [ 'optiondates' ];
if ( isset ( $parsed_args [ 'optioncount' ]) )
$parsed_args [ 'show_count' ] = $parsed_args [ 'optioncount' ];
if ( isset ( $parsed_args [ 'list' ]) )
$parsed_args [ 'style' ] = $parsed_args [ 'list' ] ? 'list' : 'break' ;
$parsed_args [ 'title_li' ] = '' ;
2006-03-03 16:38:36 -05:00
2019-07-24 20:48:58 -04:00
return wp_list_categories ( $parsed_args );
2006-03-03 16:38:36 -05:00
}
2007-12-10 13:52:24 -05:00
/**
2015-08-20 18:11:26 -04:00
* Deprecated method for generating a drop - down of categories .
*
2007-12-10 13:52:24 -05:00
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_dropdown_categories ()
2007-12-10 13:52:24 -05:00
* @ see wp_dropdown_categories ()
*
* @ param int $optionall
* @ param string $all
* @ param string $orderby
* @ param string $order
* @ param int $show_last_update
* @ param int $show_count
* @ param int $hide_empty
* @ param bool $optionnone
* @ param int $selected
* @ param int $exclude
2014-11-03 01:17:22 -05:00
* @ return string
2007-12-10 13:52:24 -05:00
*/
2006-03-01 23:51:24 -05:00
function dropdown_cats ( $optionall = 1 , $all = 'All' , $orderby = 'ID' , $order = 'asc' ,
2007-12-10 13:52:24 -05:00
$show_last_update = 0 , $show_count = 0 , $hide_empty = 1 , $optionnone = false ,
2006-03-01 23:51:24 -05:00
$selected = 0 , $exclude = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_dropdown_categories()' );
2006-03-01 23:51:24 -05:00
$show_option_all = '' ;
if ( $optionall )
$show_option_all = $all ;
$show_option_none = '' ;
if ( $optionnone )
$show_option_none = __ ( 'None' );
$vars = compact ( 'show_option_all' , 'show_option_none' , 'orderby' , 'order' ,
2006-03-03 16:38:36 -05:00
'show_last_update' , 'show_count' , 'hide_empty' , 'selected' , 'exclude' );
2006-03-01 23:51:24 -05:00
$query = add_query_arg ( $vars , '' );
return wp_dropdown_categories ( $query );
}
2007-12-10 13:52:24 -05:00
/**
2015-08-20 18:11:26 -04:00
* Lists authors .
2013-12-24 13:57:12 -05:00
*
* @ since 1.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_list_authors ()
2007-12-10 13:52:24 -05:00
* @ see wp_list_authors ()
*
* @ param bool $optioncount
* @ param bool $exclude_admin
* @ param bool $show_fullname
* @ param bool $hide_empty
* @ param string $feed
* @ param string $feed_image
2014-11-03 01:17:22 -05:00
* @ return null | string
2007-12-10 13:52:24 -05:00
*/
2006-06-06 00:50:41 -04:00
function list_authors ( $optioncount = false , $exclude_admin = true , $show_fullname = false , $hide_empty = true , $feed = '' , $feed_image = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_list_authors()' );
2007-12-28 16:17:42 -05:00
2006-06-06 00:50:41 -04:00
$args = compact ( 'optioncount' , 'exclude_admin' , 'show_fullname' , 'hide_empty' , 'feed' , 'feed_image' );
return wp_list_authors ( $args );
}
2007-12-10 13:52:24 -05:00
/**
2015-08-20 18:11:26 -04:00
* Retrieves a list of post categories .
*
2007-12-10 13:52:24 -05:00
* @ since 1.0 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_get_post_categories ()
2007-12-10 13:52:24 -05:00
* @ see wp_get_post_categories ()
*
* @ param int $blogid Not Used
* @ param int $post_ID
2014-11-03 01:17:22 -05:00
* @ return array
2007-12-10 13:52:24 -05:00
*/
2006-06-06 01:04:41 -04:00
function wp_get_post_cats ( $blogid = '1' , $post_ID = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_get_post_categories()' );
2006-06-06 01:04:41 -04:00
return wp_get_post_categories ( $post_ID );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Sets the categories that the post id belongs to .
2007-12-10 13:52:24 -05:00
*
* @ since 1.0 . 1
2013-12-24 13:57:12 -05:00
* @ deprecated 2.1 . 0
2007-12-10 13:52:24 -05:00
* @ deprecated Use wp_set_post_categories ()
* @ see wp_set_post_categories ()
*
* @ param int $blogid Not used
* @ param int $post_ID
* @ param array $post_categories
2014-11-03 01:17:22 -05:00
* @ return bool | mixed
2007-12-10 13:52:24 -05:00
*/
2006-06-06 01:04:41 -04:00
function wp_set_post_cats ( $blogid = '1' , $post_ID = 0 , $post_categories = array ()) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_set_post_categories()' );
2006-06-06 01:04:41 -04:00
return wp_set_post_categories ( $post_ID , $post_categories );
}
2007-12-10 13:52:24 -05:00
/**
2015-08-20 18:11:26 -04:00
* Retrieves a list of archives .
*
2007-12-10 13:52:24 -05:00
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_get_archives ()
2007-12-10 13:52:24 -05:00
* @ see wp_get_archives ()
*
* @ param string $type
* @ param string $limit
* @ param string $format
* @ param string $before
* @ param string $after
* @ param bool $show_post_count
2014-11-03 01:17:22 -05:00
* @ return string | null
2007-12-10 13:52:24 -05:00
*/
2006-06-15 16:28:47 -04:00
function get_archives ( $type = '' , $limit = '' , $format = 'html' , $before = '' , $after = '' , $show_post_count = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_get_archives()' );
2006-06-15 16:28:47 -04:00
$args = compact ( 'type' , 'limit' , 'format' , 'before' , 'after' , 'show_post_count' );
return wp_get_archives ( $args );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Returns or Prints link to the author ' s posts .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_author_posts_url ()
2007-12-10 13:52:24 -05:00
* @ see get_author_posts_url ()
*
2013-04-29 09:26:31 -04:00
* @ param bool $echo
* @ param int $author_id
2007-12-10 13:52:24 -05:00
* @ param string $author_nicename Optional .
* @ return string | null
*/
2013-04-29 09:26:31 -04:00
function get_author_link ( $echo , $author_id , $author_nicename = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_author_posts_url()' );
2007-12-28 16:17:42 -05:00
2006-08-30 20:10:59 -04:00
$link = get_author_posts_url ( $author_id , $author_nicename );
2006-08-30 14:07:49 -04:00
if ( $echo )
echo $link ;
return $link ;
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Print list of pages based on arguments .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_link_pages ()
2007-12-10 13:52:24 -05:00
* @ see wp_link_pages ()
*
* @ param string $before
* @ param string $after
* @ param string $next_or_number
* @ param string $nextpagelink
* @ param string $previouspagelink
* @ param string $pagelink
* @ param string $more_file
* @ return string
*/
2008-02-05 01:47:27 -05:00
function link_pages ( $before = '<br />' , $after = '<br />' , $next_or_number = 'number' , $nextpagelink = 'next page' , $previouspagelink = 'previous page' ,
2007-12-10 13:52:24 -05:00
$pagelink = '%' , $more_file = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_link_pages()' );
2007-12-28 16:17:42 -05:00
2006-08-30 17:00:37 -04:00
$args = compact ( 'before' , 'after' , 'next_or_number' , 'nextpagelink' , 'previouspagelink' , 'pagelink' , 'more_file' );
return wp_link_pages ( $args );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Get value based on option .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_option ()
2007-12-10 13:52:24 -05:00
* @ see get_option ()
*
* @ param string $option
* @ return string
*/
2006-08-30 17:46:31 -04:00
function get_settings ( $option ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_option()' );
2007-12-28 16:17:42 -05:00
2006-08-30 17:46:31 -04:00
return get_option ( $option );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Print the permalink of the current post in the loop .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 1.2 . 0 Use the_permalink ()
2007-12-10 13:52:24 -05:00
* @ see the_permalink ()
*/
2007-05-28 00:39:40 -04:00
function permalink_link () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '1.2.0' , 'the_permalink()' );
2007-05-28 00:39:40 -04:00
the_permalink ();
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Print the permalink to the RSS feed .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.3 . 0 Use the_permalink_rss ()
2007-12-10 13:52:24 -05:00
* @ see the_permalink_rss ()
*
2010-09-07 07:21:11 -04:00
* @ param string $deprecated
2007-12-10 13:52:24 -05:00
*/
2008-01-04 14:36:34 -05:00
function permalink_single_rss ( $deprecated = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.3.0' , 'the_permalink_rss()' );
2007-08-21 14:27:45 -04:00
the_permalink_rss ();
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Gets the links associated with category .
2007-12-10 13:52:24 -05:00
*
* @ since 1.0 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_list_bookmarks ()
2010-02-13 01:39:51 -05:00
* @ see wp_list_bookmarks ()
2007-12-10 13:52:24 -05:00
*
* @ param string $args a query string
* @ return null | string
*/
2007-09-11 21:01:48 -04:00
function wp_get_links ( $args = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_list_bookmarks()' );
2007-12-28 16:17:42 -05:00
2007-09-11 21:01:48 -04:00
if ( strpos ( $args , '=' ) === false ) {
$cat_id = $args ;
$args = add_query_arg ( 'category' , $cat_id , $args );
}
$defaults = array (
2010-01-15 17:11:12 -05:00
'after' => '<br />' ,
2009-12-23 13:49:22 -05:00
'before' => '' ,
'between' => ' ' ,
'categorize' => 0 ,
2010-01-15 17:11:12 -05:00
'category' => '' ,
2009-12-23 13:49:22 -05:00
'echo' => true ,
2010-01-15 17:11:12 -05:00
'limit' => - 1 ,
2009-12-23 13:49:22 -05:00
'orderby' => 'name' ,
2010-01-15 17:11:12 -05:00
'show_description' => true ,
'show_images' => true ,
2009-12-23 13:49:22 -05:00
'show_rating' => false ,
'show_updated' => true ,
'title_li' => '' ,
2007-09-11 21:01:48 -04:00
);
2019-07-24 20:48:58 -04:00
$parsed_args = wp_parse_args ( $args , $defaults );
2010-01-15 17:11:12 -05:00
2019-07-24 20:48:58 -04:00
return wp_list_bookmarks ( $parsed_args );
2007-12-10 13:52:24 -05:00
}
/**
2008-08-27 02:45:13 -04:00
* Gets the links associated with category by id .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_bookmarks ()
2007-12-10 13:52:24 -05:00
* @ see get_bookmarks ()
*
* @ param int $category The category to use . If no category supplied uses all
* @ param string $before the html to output before the link
* @ param string $after the html to output after the link
* @ param string $between the html to output between the link / image and its description .
* Not used if no image or show_images == true
* @ param bool $show_images whether to show images ( if defined ) .
* @ param string $orderby the order to output the links . E . g . 'id' , 'name' , 'url' ,
* 'description' , or 'rating' . Or maybe owner . If you start the name with an
* underscore the order will be reversed . You can also specify 'rand' as the order
* which will return links in a random order .
* @ param bool $show_description whether to show the description if show_images = false / not defined .
* @ param bool $show_rating show rating stars / chars
* @ param int $limit Limit to X entries . If not specified , all entries are shown .
* @ param int $show_updated whether to show last updated timestamp
* @ param bool $echo whether to echo the results , or return them instead
* @ return null | string
*/
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 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_bookmarks()' );
2007-09-11 21:01:48 -04:00
$order = 'ASC' ;
if ( substr ( $orderby , 0 , 1 ) == '_' ) {
$order = 'DESC' ;
$orderby = substr ( $orderby , 1 );
}
2020-01-28 19:45:18 -05:00
if ( $category == - 1 ) // get_bookmarks() uses '' to signify all categories.
2007-09-11 21:01:48 -04:00
$category = '' ;
2009-12-23 10:31:02 -05:00
$results = get_bookmarks ( array ( 'category' => $category , 'orderby' => $orderby , 'order' => $order , 'show_updated' => $show_updated , 'limit' => $limit ));
2007-09-11 21:01:48 -04:00
if ( ! $results )
return ;
$output = '' ;
foreach ( ( array ) $results as $row ) {
if ( ! isset ( $row -> recently_updated ) )
$row -> recently_updated = false ;
$output .= $before ;
if ( $show_updated && $row -> recently_updated )
$output .= get_option ( 'links_recently_updated_prepend' );
$the_link = '#' ;
if ( ! empty ( $row -> link_url ) )
2009-05-18 12:00:33 -04:00
$the_link = esc_url ( $row -> link_url );
2007-09-11 21:01:48 -04:00
$rel = $row -> link_rel ;
if ( '' != $rel )
$rel = ' rel="' . $rel . '"' ;
2009-05-05 15:43:53 -04:00
$desc = esc_attr ( sanitize_bookmark_field ( 'link_description' , $row -> link_description , $row -> link_id , 'display' ));
$name = esc_attr ( sanitize_bookmark_field ( 'link_name' , $row -> link_name , $row -> link_id , 'display' ));
2007-09-11 21:01:48 -04:00
$title = $desc ;
if ( $show_updated )
if ( substr ( $row -> link_updated_f , 0 , 2 ) != '00' )
2019-05-25 20:12:54 -04:00
$title .= ' (' . __ ( 'Last updated' ) . ' ' . gmdate ( get_option ( 'links_updated_date_format' ), $row -> link_updated_f + ( get_option ( 'gmt_offset' ) * HOUR_IN_SECONDS )) . ')' ;
2007-09-11 21:01:48 -04:00
if ( '' != $title )
$title = ' title="' . $title . '"' ;
$alt = ' alt="' . $name . '"' ;
$target = $row -> link_target ;
if ( '' != $target )
$target = ' target="' . $target . '"' ;
$output .= '<a href="' . $the_link . '"' . $rel . $title . $target . '>' ;
if ( $row -> link_image != null && $show_images ) {
if ( strpos ( $row -> link_image , 'http' ) !== false )
$output .= " <img src= \" $row->link_image\ " $alt $title /> " ;
2020-01-28 19:45:18 -05:00
else // If it's a relative path.
2007-09-11 21:01:48 -04:00
$output .= " <img src= \" " . get_option ( 'siteurl' ) . " $row->link_image\ " $alt $title /> " ;
} else {
$output .= $name ;
}
$output .= '</a>' ;
if ( $show_updated && $row -> recently_updated )
$output .= get_option ( 'links_recently_updated_append' );
if ( $show_description && '' != $desc )
$output .= $between . $desc ;
if ( $show_rating ) {
$output .= $between . get_linkrating ( $row );
}
$output .= " $after\n " ;
2020-01-28 19:45:18 -05:00
} // End while.
2007-09-11 21:01:48 -04:00
if ( ! $echo )
return $output ;
echo $output ;
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Output entire list of links by category .
2007-09-11 21:01:48 -04:00
*
2008-08-27 02:45:13 -04:00
* Output a list of all links , listed by category , using the settings in
* $wpdb -> linkcategories and output it as a nested HTML unordered list .
2007-09-11 21:01:48 -04:00
*
2007-12-10 13:52:24 -05:00
* @ since 1.0 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use wp_list_bookmarks ()
2008-07-08 13:38:12 -04:00
* @ see wp_list_bookmarks ()
2007-12-10 13:52:24 -05:00
*
* @ param string $order Sort link categories by 'name' or 'id'
2007-09-11 21:01:48 -04:00
*/
2009-12-23 13:54:17 -05:00
function get_links_list ( $order = 'name' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'wp_list_bookmarks()' );
2007-12-28 16:17:42 -05:00
2007-09-11 21:01:48 -04:00
$order = strtolower ( $order );
2020-01-28 19:45:18 -05:00
// Handle link category sorting.
2007-09-11 21:01:48 -04:00
$direction = 'ASC' ;
if ( '_' == substr ( $order , 0 , 1 ) ) {
$direction = 'DESC' ;
$order = substr ( $order , 1 );
}
if ( ! isset ( $direction ) )
$direction = '' ;
2009-12-23 10:31:02 -05:00
$cats = get_categories ( array ( 'type' => 'link' , 'orderby' => $order , 'order' => $direction , 'hierarchical' => 0 ));
2007-09-11 21:01:48 -04:00
2020-01-28 19:45:18 -05:00
// Display each category.
2007-09-11 21:01:48 -04:00
if ( $cats ) {
foreach ( ( array ) $cats as $cat ) {
// Handle each category.
2020-01-28 19:45:18 -05:00
// Display the category name.
2007-09-23 15:25:15 -04:00
echo ' <li id="linkcat-' . $cat -> term_id . '" class="linkcat"><h2>' . apply_filters ( 'link_category' , $cat -> name ) . " </h2> \n \t <ul> \n " ;
2020-01-28 19:45:18 -05:00
// Call get_links() with all the appropriate params.
2007-09-11 21:01:48 -04:00
get_links ( $cat -> term_id , '<li>' , " </li> " , " \n " , true , 'name' , false );
2020-01-28 19:45:18 -05:00
// Close the last category.
2007-09-11 21:01:48 -04:00
echo " \n \t </ul> \n </li> \n " ;
}
}
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Show the link to the links popup and the number of links .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2013-12-24 13:57:12 -05:00
* @ deprecated 2.1 . 0
2007-12-10 13:52:24 -05:00
*
* @ param string $text the text of the link
* @ param int $width the width of the popup window
* @ param int $height the height of the popup window
* @ param string $file the page to open in the popup window
* @ param bool $count the number of links in the db
2007-09-11 21:01:48 -04:00
*/
function links_popup_script ( $text = 'Links' , $width = 400 , $height = 400 , $file = 'links.all.php' , $count = true ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' );
2007-09-11 21:01:48 -04:00
}
2007-12-10 13:52:24 -05:00
/**
2015-12-19 03:23:26 -05:00
* Legacy function that retrieved the value of a link ' s link_rating field .
*
2007-12-10 13:52:24 -05:00
* @ since 1.0 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use sanitize_bookmark_field ()
2007-12-10 13:52:24 -05:00
* @ see sanitize_bookmark_field ()
*
2015-12-19 03:23:26 -05:00
* @ param object $link Link object .
* @ return mixed Value of the 'link_rating' field , false otherwise .
2007-12-10 13:52:24 -05:00
*/
2015-12-19 03:23:26 -05:00
function get_linkrating ( $link ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'sanitize_bookmark_field()' );
2007-09-23 15:25:15 -04:00
return sanitize_bookmark_field ( 'link_rating' , $link -> link_rating , $link -> link_id , 'display' );
2007-09-11 21:01:48 -04:00
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Gets the name of category by id .
2007-12-10 13:52:24 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_category ()
2007-12-10 13:52:24 -05:00
* @ see get_category ()
*
* @ param int $id The category to get . If no category supplied uses 0
* @ return string
2007-09-11 21:01:48 -04:00
*/
function get_linkcatname ( $id = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_category()' );
2007-12-28 16:17:42 -05:00
2007-09-11 21:01:48 -04:00
$id = ( int ) $id ;
if ( empty ( $id ) )
return '' ;
$cats = wp_get_link_cats ( $id );
if ( empty ( $cats ) || ! is_array ( $cats ) )
return '' ;
$cat_id = ( int ) $cats [ 0 ]; // Take the first cat.
$cat = get_category ( $cat_id );
return $cat -> name ;
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Print RSS comment feed link .
2007-12-10 13:52:24 -05:00
*
* @ since 1.0 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.5 . 0 Use post_comments_feed_link ()
2007-12-10 13:52:24 -05:00
* @ see post_comments_feed_link ()
*
* @ param string $link_text
*/
2009-12-23 13:54:17 -05:00
function comments_rss_link ( $link_text = 'Comments RSS' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.5.0' , 'post_comments_feed_link()' );
2007-12-06 14:58:15 -05:00
post_comments_feed_link ( $link_text );
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Print / Return link to category RSS2 feed .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.5 . 0 Use get_category_feed_link ()
2007-12-10 13:52:24 -05:00
* @ see get_category_feed_link ()
*
* @ param bool $echo
* @ param int $cat_ID
2014-11-30 20:34:24 -05:00
* @ return string
2007-12-10 13:52:24 -05:00
*/
2009-12-23 13:54:17 -05:00
function get_category_rss_link ( $echo = false , $cat_ID = 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.5.0' , 'get_category_feed_link()' );
2007-12-28 16:17:42 -05:00
2008-01-04 14:36:34 -05:00
$link = get_category_feed_link ( $cat_ID , 'rss2' );
2007-12-06 14:58:15 -05:00
if ( $echo )
echo $link ;
return $link ;
}
2007-12-10 13:52:24 -05:00
/**
2008-08-27 02:45:13 -04:00
* Print / Return link to author RSS feed .
2007-12-10 13:52:24 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.5 . 0 Use get_author_feed_link ()
2007-12-10 13:52:24 -05:00
* @ see get_author_feed_link ()
*
* @ param bool $echo
* @ param int $author_id
2014-11-30 20:34:24 -05:00
* @ return string
2007-12-10 13:52:24 -05:00
*/
2009-12-23 13:54:17 -05:00
function get_author_rss_link ( $echo = false , $author_id = 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.5.0' , 'get_author_feed_link()' );
2007-12-28 16:17:42 -05:00
2007-12-06 14:58:15 -05:00
$link = get_author_feed_link ( $author_id );
if ( $echo )
echo $link ;
return $link ;
}
2007-12-28 16:47:54 -05:00
/**
2008-08-27 02:45:13 -04:00
* Return link to the post RSS feed .
2007-12-28 16:47:54 -05:00
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.2 . 0 Use get_post_comments_feed_link ()
2007-12-28 16:47:54 -05:00
* @ see get_post_comments_feed_link ()
*
* @ return string
*/
2009-12-23 13:54:17 -05:00
function comments_rss () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.2.0' , 'get_post_comments_feed_link()' );
2012-11-07 14:56:10 -05:00
return esc_url ( get_post_comments_feed_link () );
2007-12-28 16:47:54 -05:00
}
/**
2008-08-27 02:45:13 -04:00
* An alias of wp_create_user () .
*
2013-12-24 13:57:12 -05:00
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.0 . 0 Use wp_create_user ()
2009-12-23 13:54:17 -05:00
* @ see wp_create_user ()
*
2007-12-28 16:47:54 -05:00
* @ param string $username The user ' s username .
* @ param string $password The user ' s password .
2014-12-06 16:24:45 -05:00
* @ param string $email The user ' s email .
2007-12-28 16:47:54 -05:00
* @ return int The new user ' s ID .
*/
function create_user ( $username , $password , $email ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.0.0' , 'wp_create_user()' );
2007-12-28 16:47:54 -05:00
return wp_create_user ( $username , $password , $email );
}
2008-02-13 06:21:09 -05:00
/**
2008-08-27 02:45:13 -04:00
* Unused function .
2008-03-02 15:17:30 -05:00
*
2013-12-24 13:57:12 -05:00
* @ deprecated 2.5 . 0
2015-12-12 10:37:28 -05:00
*/
2008-02-13 06:21:09 -05:00
function gzip_compression () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.5.0' );
2008-02-13 06:21:09 -05:00
return false ;
}
2008-08-04 18:29:37 -04:00
/**
* Retrieve an array of comment data about comment $comment_ID .
*
2009-12-23 13:54:17 -05:00
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.7 . 0 Use get_comment ()
2008-08-04 18:29:37 -04:00
* @ see get_comment ()
*
* @ param int $comment_ID The ID of the comment
2010-02-26 00:46:08 -05:00
* @ param int $no_cache Whether to use the cache ( cast to bool )
2010-02-24 15:13:23 -05:00
* @ param bool $include_unapproved Whether to include unapproved comments
2008-08-04 18:29:37 -04:00
* @ return array The comment data
*/
function get_commentdata ( $comment_ID , $no_cache = 0 , $include_unapproved = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.7.0' , 'get_comment()' );
2008-08-04 18:29:37 -04:00
return get_comment ( $comment_ID , ARRAY_A );
}
2009-04-16 18:03:45 -04:00
/**
* Retrieve the category name by the category ID .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_cat_name ()
2009-12-23 13:54:17 -05:00
* @ see get_cat_name ()
2009-04-16 18:03:45 -04:00
*
* @ param int $cat_ID Category ID
* @ return string category name
*/
function get_catname ( $cat_ID ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_cat_name()' );
2009-04-16 18:03:45 -04:00
return get_cat_name ( $cat_ID );
}
2009-03-04 14:53:17 -05:00
/**
* Retrieve category children list separated before and after the term IDs .
*
* @ since 1.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_term_children ()
2009-12-23 13:54:17 -05:00
* @ see get_term_children ()
2009-03-04 14:53:17 -05:00
*
* @ param int $id Category ID to retrieve children .
* @ param string $before Optional . Prepend before category term ID .
* @ param string $after Optional , default is empty string . Append after category term ID .
* @ param array $visited Optional . Category Term IDs that have already been added .
* @ return string
*/
function get_category_children ( $id , $before = '/' , $after = '' , $visited = array () ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_term_children()' );
2009-03-04 14:53:17 -05:00
if ( 0 == $id )
return '' ;
$chain = '' ;
2020-01-28 19:45:18 -05:00
/** TODO: Consult hierarchy */
2009-03-04 14:53:17 -05:00
$cat_ids = get_all_category_ids ();
foreach ( ( array ) $cat_ids as $cat_id ) {
if ( $cat_id == $id )
continue ;
$category = get_category ( $cat_id );
if ( is_wp_error ( $category ) )
return $category ;
if ( $category -> parent == $id && ! in_array ( $category -> term_id , $visited ) ) {
$visited [] = $category -> term_id ;
$chain .= $before . $category -> term_id . $after ;
$chain .= get_category_children ( $category -> term_id , $before , $after );
}
}
return $chain ;
}
2014-06-05 12:25:14 -04:00
/**
* Retrieves all category IDs .
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 4.0 . 0 Use get_terms ()
2014-06-05 12:25:14 -04:00
* @ see get_terms ()
2015-08-20 18:11:26 -04:00
*
2019-07-25 18:45:57 -04:00
* @ link https :// developer . wordpress . org / reference / functions / get_all_category_ids /
2014-06-05 12:25:14 -04:00
*
* @ return object List of all of the category IDs .
*/
function get_all_category_ids () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.0.0' , 'get_terms()' );
2014-06-05 12:25:14 -04:00
2019-12-02 09:49:01 -05:00
$cat_ids = get_terms (
array (
'taxonomy' => 'category' ,
'fields' => 'ids' ,
'get' => 'all' ,
)
);
2014-06-05 12:25:14 -04:00
return $cat_ids ;
}
2009-04-30 12:27:17 -04:00
/**
* Retrieve the description of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
* @ return string The author ' s description .
2009-04-30 12:27:17 -04:00
*/
function get_the_author_description () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'description\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'description' );
}
/**
* Display the description of the author of the current post .
*
* @ since 1.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_description () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'description\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'description' );
}
/**
* Retrieve the login name of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
* @ return string The author ' s login name ( username ) .
2009-04-30 12:27:17 -04:00
*/
function get_the_author_login () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'login\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'login' );
}
/**
* Display the login name of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_login () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'login\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'login' );
}
/**
* Retrieve the first name of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
* @ return string The author ' s first name .
2009-04-30 12:27:17 -04:00
*/
function get_the_author_firstname () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'first_name\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'first_name' );
}
/**
* Display the first name of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_firstname () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'first_name\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'first_name' );
}
/**
* Retrieve the last name of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-04-30 12:27:17 -04:00
* @ return string The author ' s last name .
*/
function get_the_author_lastname () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'last_name\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'last_name' );
}
/**
* Display the last name of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_lastname () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'last_name\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'last_name' );
}
/**
* Retrieve the nickname of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-04-30 12:27:17 -04:00
* @ return string The author ' s nickname .
*/
function get_the_author_nickname () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'nickname\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'nickname' );
}
/**
* Display the nickname of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_nickname () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'nickname\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'nickname' );
}
/**
* Retrieve the email of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-04-30 12:27:17 -04:00
* @ return string The author ' s username .
*/
function get_the_author_email () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'email\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'email' );
}
/**
* Display the email of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_email () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'email\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'email' );
}
/**
* Retrieve the ICQ number of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-04-30 12:27:17 -04:00
* @ return string The author ' s ICQ number .
*/
function get_the_author_icq () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'icq\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'icq' );
}
/**
* Display the ICQ number of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_icq () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'icq\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'icq' );
}
/**
* Retrieve the Yahoo ! IM name of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-04-30 12:27:17 -04:00
* @ return string The author ' s Yahoo ! IM name .
*/
function get_the_author_yim () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'yim\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'yim' );
}
/**
* Display the Yahoo ! IM name of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_yim () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'yim\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'yim' );
}
/**
* Retrieve the MSN address of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-04-30 12:27:17 -04:00
* @ return string The author ' s MSN address .
*/
function get_the_author_msn () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'msn\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'msn' );
}
/**
* Display the MSN address of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_msn () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'msn\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'msn' );
}
2009-05-11 13:56:34 -04:00
/**
* Retrieve the AIM address of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-05-11 13:56:34 -04:00
* @ return string The author ' s AIM address .
*/
function get_the_author_aim () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'aim\')' );
2009-05-11 13:56:34 -04:00
return get_the_author_meta ( 'aim' );
}
/**
* Display the AIM address of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ( 'aim' )
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-05-11 13:56:34 -04:00
*/
function the_author_aim () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'aim\')' );
2009-05-11 13:56:34 -04:00
the_author_meta ( 'aim' );
}
2009-04-30 12:27:17 -04:00
/**
* Retrieve the specified author ' s preferred display name .
*
* @ since 1.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-04-30 12:27:17 -04:00
* @ param int $auth_id The ID of the author .
* @ return string The author ' s display name .
*/
function get_author_name ( $auth_id = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'display_name\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'display_name' , $auth_id );
}
/**
* Retrieve the URL to the home page of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2009-04-30 12:27:17 -04:00
* @ return string The URL to the author ' s page .
*/
function get_the_author_url () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'url\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'url' );
}
/**
* Display the URL to the home page of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2009-04-30 12:27:17 -04:00
*/
function the_author_url () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'url\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'url' );
}
/**
* Retrieve the ID of the author of the current post .
*
2013-12-24 13:57:12 -05:00
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use get_the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see get_the_author_meta ()
*
2014-11-30 20:34:24 -05:00
* @ return string | int The author ' s ID .
2009-04-30 12:27:17 -04:00
*/
2009-05-24 19:47:49 -04:00
function get_the_author_ID () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'get_the_author_meta(\'ID\')' );
2009-04-30 12:27:17 -04:00
return get_the_author_meta ( 'ID' );
}
/**
* Display the ID of the author of the current post .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use the_author_meta ()
2009-12-23 13:54:17 -05:00
* @ see the_author_meta ()
2015-12-12 10:37:28 -05:00
*/
2009-05-24 19:47:49 -04:00
function the_author_ID () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'the_author_meta(\'ID\')' );
2009-04-30 12:27:17 -04:00
the_author_meta ( 'ID' );
2009-05-24 19:47:49 -04:00
}
2009-04-30 12:27:17 -04:00
2009-09-28 10:36:48 -04:00
/**
* Display the post content for the feed .
*
* For encoding the html or the $encode_html parameter , there are three possible
* values . '0' will make urls footnotes and use make_url_footnote () . '1' will
* encode special characters and automatically display all of the content . The
* value of '2' will strip all HTML tags from the content .
*
* Also note that you cannot set the amount of words and not set the html
* encoding . If that is the case , then the html encoding will default to 2 ,
* which will strip all HTML tags .
*
* To restrict the amount of words of the content , you can use the cut
* parameter . If the content is less than the amount , then there won ' t be any
* dots added to the end . If there is content left over , then dots will be added
* and the rest of the content will be removed .
*
* @ since 0.71
*
2015-08-20 18:11:26 -04:00
* @ deprecated 2.9 . 0 Use the_content_feed ()
2009-12-23 13:54:17 -05:00
* @ see the_content_feed ()
2009-10-15 16:26:21 -04:00
*
2009-09-28 10:36:48 -04:00
* @ param string $more_link_text Optional . Text to display when more content is available but not displayed .
2014-11-30 20:34:24 -05:00
* @ param int $stripteaser Optional . Default is 0.
2009-09-28 10:36:48 -04:00
* @ param string $more_file Optional .
* @ param int $cut Optional . Amount of words to keep for the content .
* @ 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 ) {
2017-06-24 20:05:44 -04:00
_deprecated_function ( __FUNCTION__ , '2.9.0' , 'the_content_feed()' );
2013-04-29 09:42:56 -04:00
$content = get_the_content ( $more_link_text , $stripteaser );
2017-08-03 10:46:43 -04:00
/**
* Filters the post content in the context of an RSS feed .
*
* @ since 0.71
*
* @ param string $content Content of the current post .
*/
2009-09-28 10:36:48 -04:00
$content = apply_filters ( 'the_content_rss' , $content );
if ( $cut && ! $encode_html )
$encode_html = 2 ;
if ( 1 == $encode_html ) {
$content = esc_html ( $content );
$cut = 0 ;
} elseif ( 0 == $encode_html ) {
$content = make_url_footnote ( $content );
} elseif ( 2 == $encode_html ) {
$content = strip_tags ( $content );
}
if ( $cut ) {
$blah = explode ( ' ' , $content );
if ( count ( $blah ) > $cut ) {
$k = $cut ;
$use_dotdotdot = 1 ;
} else {
$k = count ( $blah );
$use_dotdotdot = 0 ;
}
/** @todo Check performance, might be faster to use array slice instead. */
for ( $i = 0 ; $i < $k ; $i ++ )
$excerpt .= $blah [ $i ] . ' ' ;
$excerpt .= ( $use_dotdotdot ) ? '...' : '' ;
$content = $excerpt ;
}
$content = str_replace ( ']]>' , ']]>' , $content );
echo $content ;
}
2009-11-17 16:11:24 -05:00
/**
* Strip HTML and put links at the bottom of stripped content .
*
* Searches for all of the links , strips them out of the content , and places
* them at the bottom of the content with numbers .
*
* @ since 0.71
* @ deprecated 2.9 . 0
*
* @ param string $content Content to get links
* @ return string HTML stripped out of content with links at the bottom .
*/
function make_url_footnote ( $content ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.9.0' , '' );
2009-11-17 16:11:24 -05:00
preg_match_all ( '/<a(.+?)href=\"(.+?)\"(.*?)>(.+?)<\/a>/' , $content , $matches );
$links_summary = " \n " ;
2015-02-26 00:48:24 -05:00
for ( $i = 0 , $c = count ( $matches [ 0 ] ); $i < $c ; $i ++ ) {
2009-11-17 16:11:24 -05:00
$link_match = $matches [ 0 ][ $i ];
$link_number = '[' . ( $i + 1 ) . ']' ;
$link_url = $matches [ 2 ][ $i ];
$link_text = $matches [ 4 ][ $i ];
$content = str_replace ( $link_match , $link_text . ' ' . $link_number , $content );
$link_url = ( ( strtolower ( substr ( $link_url , 0 , 7 ) ) != 'http://' ) && ( strtolower ( substr ( $link_url , 0 , 8 ) ) != 'https://' ) ) ? get_option ( 'home' ) . $link_url : $link_url ;
$links_summary .= " \n " . $link_number . ' ' . $link_url ;
}
$content = strip_tags ( $content );
$content .= $links_summary ;
return $content ;
}
2009-11-22 07:07:41 -05:00
/**
* Retrieve translated string with vertical bar context
*
* Quite a few times , there will be collisions with similar translatable text
* found in more than two places but with different translated context .
*
* In order to use the separate contexts , the _c () function is used and the
* translatable string uses a pipe ( '|' ) which has the context the string is in .
*
* When the translated string is returned , it is everything before the pipe , not
* including the pipe character . If there is no pipe in the translated text then
* everything is returned .
*
* @ since 2.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.9 . 0 Use _x ()
2009-12-19 05:51:29 -05:00
* @ see _x ()
2009-11-22 07:07:41 -05:00
*
* @ param string $text Text to translate
* @ param string $domain Optional . Domain to retrieve the translated text
* @ return string Translated context string without pipe
*/
function _c ( $text , $domain = 'default' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.9.0' , '_x()' );
2010-02-13 02:28:19 -05:00
return before_last_bar ( translate ( $text , $domain ) );
}
/**
* Translates $text like translate (), but assumes that the text
* contains a context after its last vertical bar .
*
2013-12-24 13:57:12 -05:00
* @ since 2.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use _x ()
2010-02-13 02:28:19 -05:00
* @ see _x ()
*
* @ param string $text Text to translate
* @ param string $domain Domain to retrieve the translated text
* @ return string Translated text
*/
function translate_with_context ( $text , $domain = 'default' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.9.0' , '_x()' );
2010-02-13 02:28:19 -05:00
return before_last_bar ( translate ( $text , $domain ) );
2009-11-22 07:07:41 -05:00
}
2009-12-19 05:51:29 -05:00
/**
2015-12-19 03:48:27 -05:00
* Legacy version of _n (), which supports contexts .
*
2009-12-19 05:51:29 -05:00
* Strips everything from the translation after the last bar .
*
* @ since 2.7 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use _nx ()
2009-12-19 05:51:29 -05:00
* @ see _nx ()
2015-12-19 03:48:27 -05:00
*
* @ 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 .
2009-12-19 05:51:29 -05:00
*/
function _nc ( $single , $plural , $number , $domain = 'default' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.9.0' , '_nx()' );
2009-12-19 05:51:29 -05:00
return before_last_bar ( _n ( $single , $plural , $number , $domain ) );
}
2010-01-08 03:29:55 -05:00
2010-02-13 02:28:19 -05:00
/**
* Retrieve the plural or single form based on the amount .
*
* @ since 1.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use _n ()
2010-02-13 02:28:19 -05:00
* @ see _n ()
*/
2019-09-25 09:47:58 -04:00
function __ngettext ( ... $args ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , '_n()' );
2019-09-15 07:09:54 -04:00
return _n ( ... $args );
2010-02-13 02:28:19 -05:00
}
/**
* Register plural strings in POT file , but don ' t translate them .
*
2013-12-24 13:57:12 -05:00
* @ since 2.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use _n_noop ()
2010-02-13 02:28:19 -05:00
* @ see _n_noop ()
*/
2019-09-25 09:47:58 -04:00
function __ngettext_noop ( ... $args ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , '_n_noop()' );
2019-09-15 07:09:54 -04:00
return _n_noop ( ... $args );
2010-02-13 02:28:19 -05:00
}
2010-01-08 03:29:55 -05:00
/**
* Retrieve all autoload options , or all options if no autoloaded ones exist .
*
* @ since 1.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use wp_load_alloptions ())
2010-01-08 03:29:55 -05:00
* @ see wp_load_alloptions ()
*
* @ return array List of all options .
*/
function get_alloptions () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'wp_load_alloptions()' );
2010-01-08 03:29:55 -05:00
return wp_load_alloptions ();
}
2010-02-13 01:39:51 -05:00
/**
* Retrieve HTML content of attachment image with link .
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.5 . 0 Use wp_get_attachment_link ()
2010-02-13 01:39:51 -05:00
* @ see wp_get_attachment_link ()
*
* @ param int $id Optional . Post ID .
* @ param bool $fullsize Optional , default is false . Whether to use full size image .
* @ param array $max_dims Optional . Max image dimensions .
* @ param bool $permalink Optional , default is false . Whether to include permalink to image .
* @ return string
*/
function get_the_attachment_link ( $id = 0 , $fullsize = false , $max_dims = false , $permalink = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.5.0' , 'wp_get_attachment_link()' );
2010-02-13 01:39:51 -05:00
$id = ( int ) $id ;
2012-08-23 16:01:10 -04:00
$_post = get_post ( $id );
2010-02-13 01:39:51 -05:00
if ( ( 'attachment' != $_post -> post_type ) || ! $url = wp_get_attachment_url ( $_post -> ID ) )
return __ ( 'Missing Attachment' );
if ( $permalink )
$url = get_attachment_link ( $_post -> ID );
$post_title = esc_attr ( $_post -> post_title );
$innerHTML = get_attachment_innerHTML ( $_post -> ID , $fullsize , $max_dims );
return " <a href=' $url ' title=' $post_title '> $innerHTML </a> " ;
}
/**
* Retrieve icon URL and Path .
*
* @ since 2.1 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.5 . 0 Use wp_get_attachment_image_src ()
2010-02-13 01:39:51 -05:00
* @ see wp_get_attachment_image_src ()
*
* @ param int $id Optional . Post ID .
* @ param bool $fullsize Optional , default to false . Whether to have full image .
* @ return array Icon URL and full path to file , respectively .
*/
function get_attachment_icon_src ( $id = 0 , $fullsize = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.5.0' , 'wp_get_attachment_image_src()' );
2010-02-13 01:39:51 -05:00
$id = ( int ) $id ;
2012-08-23 16:01:10 -04:00
if ( ! $post = get_post ( $id ) )
2010-02-13 01:39:51 -05:00
return false ;
$file = get_attached_file ( $post -> ID );
if ( ! $fullsize && $src = wp_get_attachment_thumb_url ( $post -> ID ) ) {
2020-01-28 19:45:18 -05:00
// We have a thumbnail desired, specified and existing.
2010-02-13 01:39:51 -05:00
2019-03-01 15:58:52 -05:00
$src_file = wp_basename ( $src );
2010-02-13 01:39:51 -05:00
} elseif ( wp_attachment_is_image ( $post -> ID ) ) {
2020-01-28 19:45:18 -05:00
// We have an image without a thumbnail.
2010-02-13 01:39:51 -05:00
$src = wp_get_attachment_url ( $post -> ID );
$src_file = & $file ;
} elseif ( $src = wp_mime_type_icon ( $post -> ID ) ) {
// No thumb, no image. We'll look for a mime-related icon instead.
$icon_dir = apply_filters ( 'icon_dir' , get_template_directory () . '/images' );
2019-03-01 15:58:52 -05:00
$src_file = $icon_dir . '/' . wp_basename ( $src );
2010-02-13 01:39:51 -05:00
}
if ( ! isset ( $src ) || ! $src )
return false ;
return array ( $src , $src_file );
}
/**
* Retrieve HTML content of icon attachment image element .
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.5 . 0 Use wp_get_attachment_image ()
2010-02-13 01:39:51 -05:00
* @ see wp_get_attachment_image ()
*
* @ param int $id Optional . Post ID .
* @ param bool $fullsize Optional , default to false . Whether to have full size image .
* @ param array $max_dims Optional . Dimensions of image .
2020-01-11 13:32:05 -05:00
* @ return string | false HTML content .
2010-02-13 01:39:51 -05:00
*/
function get_attachment_icon ( $id = 0 , $fullsize = false , $max_dims = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.5.0' , 'wp_get_attachment_image()' );
2010-02-13 01:39:51 -05:00
$id = ( int ) $id ;
2012-08-23 16:01:10 -04:00
if ( ! $post = get_post ( $id ) )
2010-02-13 01:39:51 -05:00
return false ;
if ( ! $src = get_attachment_icon_src ( $post -> ID , $fullsize ) )
return false ;
list ( $src , $src_file ) = $src ;
// Do we need to constrain the image?
if ( ( $max_dims = apply_filters ( 'attachment_max_dims' , $max_dims )) && file_exists ( $src_file ) ) {
2019-07-09 01:45:58 -04:00
$imagesize = @ getimagesize ( $src_file );
2010-02-13 01:39:51 -05:00
if (( $imagesize [ 0 ] > $max_dims [ 0 ]) || $imagesize [ 1 ] > $max_dims [ 1 ] ) {
$actual_aspect = $imagesize [ 0 ] / $imagesize [ 1 ];
$desired_aspect = $max_dims [ 0 ] / $max_dims [ 1 ];
if ( $actual_aspect >= $desired_aspect ) {
$height = $actual_aspect * $max_dims [ 0 ];
$constraint = " width=' { $max_dims [ 0 ] } ' " ;
$post -> iconsize = array ( $max_dims [ 0 ], $height );
} else {
$width = $max_dims [ 1 ] / $actual_aspect ;
$constraint = " height=' { $max_dims [ 1 ] } ' " ;
$post -> iconsize = array ( $width , $max_dims [ 1 ]);
}
} else {
$post -> iconsize = array ( $imagesize [ 0 ], $imagesize [ 1 ]);
$constraint = '' ;
}
} else {
$constraint = '' ;
}
$post_title = esc_attr ( $post -> post_title );
$icon = " <img src=' $src ' title=' $post_title ' alt=' $post_title ' $constraint /> " ;
return apply_filters ( 'attachment_icon' , $icon , $post -> ID );
}
/**
* Retrieve HTML content of image element .
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.5 . 0 Use wp_get_attachment_image ()
2010-02-13 01:39:51 -05:00
* @ see wp_get_attachment_image ()
*
* @ param int $id Optional . Post ID .
* @ param bool $fullsize Optional , default to false . Whether to have full size image .
* @ param array $max_dims Optional . Dimensions of image .
2020-01-11 13:32:05 -05:00
* @ return string | false
2010-02-13 01:39:51 -05:00
*/
function get_attachment_innerHTML ( $id = 0 , $fullsize = false , $max_dims = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.5.0' , 'wp_get_attachment_image()' );
2010-02-13 01:39:51 -05:00
$id = ( int ) $id ;
2012-08-23 16:01:10 -04:00
if ( ! $post = get_post ( $id ) )
2010-02-13 01:39:51 -05:00
return false ;
if ( $innerHTML = get_attachment_icon ( $post -> ID , $fullsize , $max_dims ))
return $innerHTML ;
$innerHTML = esc_attr ( $post -> post_title );
return apply_filters ( 'attachment_innerHTML' , $innerHTML , $post -> ID );
}
2010-12-16 17:46:13 -05:00
/**
2015-12-19 03:54:26 -05:00
* Retrieves bookmark data based on ID .
2010-02-13 01:39:51 -05:00
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.1 . 0 Use get_bookmark ()
2010-02-13 01:39:51 -05:00
* @ see get_bookmark ()
*
2015-12-19 03:54:26 -05:00
* @ 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` .
2010-02-13 01:39:51 -05:00
*/
2015-12-19 03:54:26 -05:00
function get_link ( $bookmark_id , $output = OBJECT , $filter = 'raw' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.1.0' , 'get_bookmark()' );
2010-02-13 01:39:51 -05:00
return get_bookmark ( $bookmark_id , $output , $filter );
}
2010-02-13 02:28:19 -05:00
/**
* Performs esc_url () for database or redirect usage .
*
* @ since 2.3 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use esc_url_raw ()
2010-02-20 19:03:42 -05:00
* @ see esc_url_raw ()
2010-02-13 02:28:19 -05:00
*
* @ param string $url The URL to be cleaned .
* @ param array $protocols An array of acceptable protocols .
* @ return string The cleaned URL .
*/
function sanitize_url ( $url , $protocols = null ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'esc_url_raw()' );
2010-02-22 13:15:10 -05:00
return esc_url_raw ( $url , $protocols );
2010-02-13 02:28:19 -05:00
}
2010-02-22 13:25:51 -05:00
/**
* Checks and cleans a URL .
*
* A number of characters are removed from the URL . If the URL is for displaying
2011-09-03 12:02:41 -04:00
* ( the default behaviour ) ampersands are also replaced . The 'clean_url' filter
2010-02-22 13:25:51 -05:00
* is applied to the returned cleaned URL .
*
* @ since 1.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use esc_url ()
2016-09-22 05:40:31 -04:00
* @ see esc_url ()
2010-02-22 13:25:51 -05:00
*
* @ 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' .
2016-05-23 14:59:27 -04:00
* @ return string The cleaned $url after the { @ see 'clean_url' } filter is applied .
2010-02-22 13:25:51 -05:00
*/
function clean_url ( $url , $protocols = null , $context = 'display' ) {
if ( $context == 'db' )
2016-07-06 08:40:29 -04:00
_deprecated_function ( 'clean_url( $context = \'db\' )' , '3.0.0' , 'esc_url_raw()' );
2010-02-22 13:25:51 -05:00
else
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'esc_url()' );
2010-02-22 13:25:51 -05:00
return esc_url ( $url , $protocols , $context );
}
2010-02-13 02:28:19 -05:00
/**
* Escape single quotes , specialchar double quotes , and fix line endings .
*
2016-05-23 14:59:27 -04:00
* The filter { @ see 'js_escape' } is also applied by esc_js () .
2010-02-13 02:28:19 -05:00
*
* @ since 2.0 . 4
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use esc_js ()
2010-02-13 02:28:19 -05:00
* @ see esc_js ()
*
* @ param string $text The text to be escaped .
* @ return string Escaped text .
*/
function js_escape ( $text ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'esc_js()' );
2010-02-13 02:28:19 -05:00
return esc_js ( $text );
}
/**
2015-12-19 03:58:25 -05:00
* Legacy escaping for HTML blocks .
2010-02-13 02:28:19 -05:00
*
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use esc_html ()
2010-02-13 02:28:19 -05:00
* @ see esc_html ()
2015-12-19 03:58:25 -05:00
*
* @ 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` .
2010-02-13 02:28:19 -05:00
*/
function wp_specialchars ( $string , $quote_style = ENT_NOQUOTES , $charset = false , $double_encode = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'esc_html()' );
2016-05-13 14:41:31 -04:00
if ( func_num_args () > 1 ) { // Maintain back-compat for people passing additional arguments.
2019-09-15 07:09:54 -04:00
return _wp_specialchars ( $string , $quote_style , $charset , $double_encode );
2010-02-13 02:28:19 -05:00
} else {
return esc_html ( $string );
}
}
/**
* Escaping for HTML attributes .
*
* @ since 2.0 . 6
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use esc_attr ()
2010-02-13 02:28:19 -05:00
* @ see esc_attr ()
*
* @ param string $text
* @ return string
*/
function attribute_escape ( $text ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'esc_attr()' );
2010-02-13 02:28:19 -05:00
return esc_attr ( $text );
}
2010-02-13 02:55:28 -05:00
/**
2016-05-13 14:41:31 -04:00
* Register widget for sidebar with backward compatibility .
2010-02-13 02:55:28 -05:00
*
* 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 .
*
2016-05-13 14:41:31 -04:00
* Passes to wp_register_sidebar_widget () after argument list and backward
* compatibility is complete .
2010-02-13 02:55:28 -05:00
*
* @ since 2.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use wp_register_sidebar_widget ()
2010-02-13 02:55:28 -05:00
* @ see wp_register_sidebar_widget ()
*
2015-12-19 04:00:26 -05:00
* @ param string | int $name Widget ID .
* @ param callable $output_callback Run when widget is called .
* @ param string $classname Optional . Classname widget option . Default empty .
2019-05-25 17:59:51 -04:00
* @ param mixed ... $params Widget parameters .
2010-02-13 02:55:28 -05:00
*/
2019-09-15 07:09:54 -04:00
function register_sidebar_widget ( $name , $output_callback , $classname = '' , ... $params ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'wp_register_sidebar_widget()' );
2020-01-28 19:45:18 -05:00
// Compat.
2019-09-15 07:09:54 -04:00
if ( is_array ( $name ) ) {
if ( count ( $name ) === 3 ) {
$name = sprintf ( $name [ 0 ], $name [ 2 ] );
} else {
2010-02-13 02:55:28 -05:00
$name = $name [ 0 ];
2019-09-15 07:09:54 -04:00
}
2010-02-13 02:55:28 -05:00
}
2019-09-15 07:09:54 -04:00
$id = sanitize_title ( $name );
2010-02-13 02:55:28 -05:00
$options = array ();
2019-09-15 07:09:54 -04:00
if ( ! empty ( $classname ) && is_string ( $classname ) ) {
2010-02-13 02:55:28 -05:00
$options [ 'classname' ] = $classname ;
2019-09-15 07:09:54 -04:00
}
2010-02-13 02:55:28 -05:00
2019-09-15 07:09:54 -04:00
wp_register_sidebar_widget ( $id , $name , $output_callback , $options , ... $params );
2010-02-13 02:55:28 -05:00
}
/**
2016-05-22 13:39:28 -04:00
* Serves as an alias of wp_unregister_sidebar_widget () .
2010-02-13 02:55:28 -05:00
*
* @ since 2.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use wp_unregister_sidebar_widget ()
2010-02-13 02:55:28 -05:00
* @ see wp_unregister_sidebar_widget ()
*
* @ param int | string $id Widget ID .
*/
function unregister_sidebar_widget ( $id ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'wp_unregister_sidebar_widget()' );
2010-02-13 02:55:28 -05:00
return wp_unregister_sidebar_widget ( $id );
}
/**
* Registers widget control callback for customizing options .
*
* 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 .
*
2015-08-20 18:11:26 -04:00
* Passes to wp_register_widget_control () after the argument list has
2010-02-13 02:55:28 -05:00
* been compiled .
*
* @ since 2.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use wp_register_widget_control ()
2010-02-13 02:55:28 -05:00
* @ see wp_register_widget_control ()
*
2019-09-15 07:09:54 -04:00
* @ param int | string $name Sidebar ID .
* @ param callable $control_callback Widget control callback to display and process form .
* @ param int $width Widget width .
* @ param int $height Widget height .
* @ param mixed ... $params Widget parameters .
2010-02-13 02:55:28 -05:00
*/
2019-09-15 07:09:54 -04:00
function register_widget_control ( $name , $control_callback , $width = '' , $height = '' , ... $params ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'wp_register_widget_control()' );
2020-01-28 19:45:18 -05:00
// Compat.
2019-09-15 07:09:54 -04:00
if ( is_array ( $name ) ) {
if ( count ( $name ) === 3 ) {
$name = sprintf ( $name [ 0 ], $name [ 2 ] );
} else {
2010-02-13 02:55:28 -05:00
$name = $name [ 0 ];
2019-09-15 07:09:54 -04:00
}
2010-02-13 02:55:28 -05:00
}
2019-09-15 07:09:54 -04:00
$id = sanitize_title ( $name );
2010-02-13 02:55:28 -05:00
$options = array ();
2019-09-15 07:09:54 -04:00
if ( ! empty ( $width ) ) {
2010-02-13 02:55:28 -05:00
$options [ 'width' ] = $width ;
2019-09-15 07:09:54 -04:00
}
if ( ! empty ( $height ) ) {
2010-02-13 02:55:28 -05:00
$options [ 'height' ] = $height ;
2019-09-15 07:09:54 -04:00
}
2010-02-13 02:55:28 -05:00
2019-09-15 07:09:54 -04:00
wp_register_widget_control ( $id , $name , $control_callback , $options , ... $params );
2010-02-13 02:55:28 -05:00
}
/**
2015-08-20 18:11:26 -04:00
* Alias of wp_unregister_widget_control () .
2010-02-13 02:55:28 -05:00
*
* @ since 2.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 2.8 . 0 Use wp_unregister_widget_control ()
2010-02-13 02:55:28 -05:00
* @ see wp_unregister_widget_control ()
*
* @ param int | string $id Widget ID .
*/
function unregister_widget_control ( $id ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '2.8.0' , 'wp_unregister_widget_control()' );
2010-02-13 02:55:28 -05:00
return wp_unregister_widget_control ( $id );
}
2010-02-22 13:35:35 -05:00
/**
* Remove user meta data .
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use delete_user_meta ()
2010-02-22 13:35:35 -05:00
* @ see delete_user_meta ()
*
* @ 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 = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'delete_user_meta()' );
2010-02-23 04:15:47 -05:00
global $wpdb ;
if ( ! is_numeric ( $user_id ) )
return false ;
$meta_key = preg_replace ( '|[^a-z0-9_]|i' , '' , $meta_key );
if ( is_array ( $meta_value ) || is_object ( $meta_value ) )
$meta_value = serialize ( $meta_value );
$meta_value = trim ( $meta_value );
$cur = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s " , $user_id , $meta_key ) );
if ( $cur && $cur -> umeta_id )
do_action ( 'delete_usermeta' , $cur -> umeta_id , $user_id , $meta_key , $meta_value );
if ( ! empty ( $meta_value ) )
$wpdb -> query ( $wpdb -> prepare ( " DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s AND meta_value = %s " , $user_id , $meta_key , $meta_value ) );
else
$wpdb -> query ( $wpdb -> prepare ( " DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s " , $user_id , $meta_key ) );
2010-11-24 01:47:52 -05:00
clean_user_cache ( $user_id );
wp_cache_delete ( $user_id , 'user_meta' );
2010-02-23 04:15:47 -05:00
if ( $cur && $cur -> umeta_id )
do_action ( 'deleted_usermeta' , $cur -> umeta_id , $user_id , $meta_key , $meta_value );
return true ;
2010-02-22 13:35:35 -05:00
}
/**
* 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 .
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use get_user_meta ()
2010-02-22 13:35:35 -05:00
* @ see get_user_meta ()
*
* @ param int $user_id User ID
* @ param string $meta_key Optional . Metadata key .
* @ return mixed
*/
2010-02-23 04:15:47 -05:00
function get_usermeta ( $user_id , $meta_key = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'get_user_meta()' );
2010-02-23 04:15:47 -05:00
global $wpdb ;
$user_id = ( int ) $user_id ;
if ( ! $user_id )
return false ;
if ( ! empty ( $meta_key ) ) {
$meta_key = preg_replace ( '|[^a-z0-9_]|i' , '' , $meta_key );
$user = wp_cache_get ( $user_id , 'users' );
2020-01-28 19:45:18 -05:00
// Check the cached user object.
2010-02-23 04:15:47 -05:00
if ( false !== $user && isset ( $user -> $meta_key ) )
$metas = array ( $user -> $meta_key );
else
$metas = $wpdb -> get_col ( $wpdb -> prepare ( " SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s " , $user_id , $meta_key ) );
} else {
$metas = $wpdb -> get_col ( $wpdb -> prepare ( " SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d " , $user_id ) );
}
if ( empty ( $metas ) ) {
if ( empty ( $meta_key ) )
return array ();
else
return '' ;
}
$metas = array_map ( 'maybe_unserialize' , $metas );
if ( count ( $metas ) == 1 )
return $metas [ 0 ];
else
return $metas ;
2010-02-22 13:35:35 -05:00
}
/**
* 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 .
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use update_user_meta ()
2010-02-22 13:35:35 -05:00
* @ see update_user_meta ()
*
* @ 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 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'update_user_meta()' );
2010-02-23 04:15:47 -05:00
global $wpdb ;
if ( ! is_numeric ( $user_id ) )
return false ;
$meta_key = preg_replace ( '|[^a-z0-9_]|i' , '' , $meta_key );
/** @todo Might need fix because usermeta data is assumed to be already escaped */
if ( is_string ( $meta_value ) )
2013-03-01 11:28:40 -05:00
$meta_value = stripslashes ( $meta_value );
2010-02-23 04:15:47 -05:00
$meta_value = maybe_serialize ( $meta_value );
if ( empty ( $meta_value )) {
return delete_usermeta ( $user_id , $meta_key );
}
$cur = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s " , $user_id , $meta_key ) );
if ( $cur )
do_action ( 'update_usermeta' , $cur -> umeta_id , $user_id , $meta_key , $meta_value );
if ( ! $cur )
$wpdb -> insert ( $wpdb -> usermeta , compact ( 'user_id' , 'meta_key' , 'meta_value' ) );
2015-01-08 02:05:25 -05:00
elseif ( $cur -> meta_value != $meta_value )
2010-02-23 04:15:47 -05:00
$wpdb -> update ( $wpdb -> usermeta , compact ( 'meta_value' ), compact ( 'user_id' , 'meta_key' ) );
else
return false ;
2010-11-24 01:47:52 -05:00
clean_user_cache ( $user_id );
wp_cache_delete ( $user_id , 'user_meta' );
2010-02-23 04:15:47 -05:00
if ( ! $cur )
do_action ( 'added_usermeta' , $wpdb -> insert_id , $user_id , $meta_key , $meta_value );
else
do_action ( 'updated_usermeta' , $cur -> umeta_id , $user_id , $meta_key , $meta_value );
return true ;
2010-02-25 03:56:19 -05:00
}
2010-12-20 11:25:35 -05:00
/**
2016-01-27 22:35:27 -05:00
* Get users for the site .
2010-12-20 11:25:35 -05:00
*
2016-01-27 22:35:27 -05:00
* For setups that use the multisite feature . Can be used outside of the
* multisite feature .
2010-12-20 11:25:35 -05:00
*
* @ since 2.2 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.1 . 0 Use get_users ()
* @ see get_users ()
2014-10-31 13:56:22 -04:00
*
2019-08-03 21:12:56 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2010-12-20 11:25:35 -05:00
*
2016-01-27 22:35:27 -05:00
* @ param int $id Site ID .
* @ return array List of users that are part of that site ID
2010-12-20 11:25:35 -05:00
*/
function get_users_of_blog ( $id = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.1.0' , 'get_users()' );
2010-12-20 11:25:35 -05:00
2016-08-31 00:55:54 -04:00
global $wpdb ;
if ( empty ( $id ) ) {
$id = get_current_blog_id ();
}
2010-12-20 11:25:35 -05:00
$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 ;
}
2010-02-25 03:56:19 -05:00
/**
2010-02-25 06:09:34 -05:00
* Enable / disable automatic general feed link outputting .
2010-02-25 03:56:19 -05:00
*
* @ since 2.8 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use add_theme_support ()
* @ see add_theme_support ()
2010-02-25 06:09:34 -05:00
*
2015-06-26 21:03:25 -04:00
* @ param bool $add Optional , default is true . Add or remove links . Defaults to true .
2010-02-25 03:56:19 -05:00
*/
2010-02-25 06:09:34 -05:00
function automatic_feed_links ( $add = true ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , " add_theme_support( 'automatic-feed-links' ) " );
2010-02-25 06:09:34 -05:00
if ( $add )
add_theme_support ( 'automatic-feed-links' );
else
2020-01-28 19:45:18 -05:00
remove_action ( 'wp_head' , 'feed_links_extra' , 3 ); // Just do this yourself in 3.0+.
2010-02-27 13:11:45 -05:00
}
/**
* Retrieve user data based on field .
*
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use get_the_author_meta ()
2010-02-27 13:11:45 -05:00
* @ see get_the_author_meta ()
2015-12-19 04:04:26 -05:00
*
* @ 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 .
2010-02-27 13:11:45 -05:00
*/
function get_profile ( $field , $user = false ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'get_the_author_meta()' );
2010-02-27 13:11:45 -05:00
if ( $user ) {
$user = get_user_by ( 'login' , $user );
$user = $user -> ID ;
}
return get_the_author_meta ( $field , $user );
2010-03-18 21:11:21 -04:00
}
/**
2015-12-19 14:41:30 -05:00
* Retrieves the number of posts a user has written .
2010-03-18 21:11:21 -04:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use count_user_posts ()
2010-03-18 21:11:21 -04:00
* @ see count_user_posts ()
2015-12-19 14:41:30 -05:00
*
* @ param int $userid User to count posts for .
* @ return int Number of posts the given user has written .
2010-03-18 21:11:21 -04:00
*/
function get_usernumposts ( $userid ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'count_user_posts()' );
2010-03-18 21:11:21 -04:00
return count_user_posts ( $userid );
2010-04-04 03:11:23 -04:00
}
/**
* Callback used to change % uXXXX to & #YYY; syntax
*
* @ since 2.8 . 0
* @ access private
* @ deprecated 3.0 . 0
*
* @ param array $matches Single Match
* @ return string An HTML entity
*/
function funky_javascript_callback ( $matches ) {
return " &# " . base_convert ( $matches [ 1 ], 16 , 10 ) . " ; " ;
}
/**
2014-12-01 19:31:22 -05:00
* Fixes JavaScript bugs in browsers .
2010-04-04 03:11:23 -04:00
*
* Converts unicode characters to HTML numbered entities .
*
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0
*
2015-12-28 12:18:30 -05:00
* @ global $is_macIE
* @ global $is_winIE
2010-04-04 03:11:23 -04:00
*
* @ param string $text Text to be made safe .
* @ return string Fixed text .
*/
function funky_javascript_fix ( $text ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' );
2014-12-01 19:31:22 -05:00
// Fixes for browsers' JavaScript bugs.
2010-04-04 03:11:23 -04:00
global $is_macIE , $is_winIE ;
if ( $is_winIE || $is_macIE )
$text = preg_replace_callback ( " / \ %u([0-9A-F] { 4,4})/ " ,
" funky_javascript_callback " ,
$text );
return $text ;
}
2010-04-04 06:04:56 -04:00
2010-06-11 11:53:41 -04:00
/**
* Checks that the taxonomy name exists .
*
* @ since 2.3 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use taxonomy_exists ()
2010-06-11 11:53:41 -04:00
* @ see taxonomy_exists ()
*
* @ param string $taxonomy Name of taxonomy object
* @ return bool Whether the taxonomy exists .
*/
function is_taxonomy ( $taxonomy ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'taxonomy_exists()' );
2010-06-11 13:49:35 -04:00
return taxonomy_exists ( $taxonomy );
2010-06-11 11:53:41 -04:00
}
/**
* Check if Term exists .
*
* @ since 2.3 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.0 . 0 Use term_exists ()
2010-06-11 11:53:41 -04:00
* @ see term_exists ()
*
* @ param int | string $term The term to check
* @ param string $taxonomy The taxonomy name to use
* @ param int $parent ID of parent term under which to confine the exists search .
* @ return mixed Get the term id or Term Object , if exists .
*/
function is_term ( $term , $taxonomy = '' , $parent = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.0.0' , 'term_exists()' );
2010-06-11 11:53:41 -04:00
return term_exists ( $term , $taxonomy , $parent );
2010-06-11 13:49:35 -04:00
}
2010-08-18 20:26:48 -04:00
2010-08-25 14:05:33 -04:00
/**
2018-02-13 11:54:31 -05:00
* Determines whether the current admin page is generated by a plugin .
2010-08-25 14:05:33 -04:00
*
2015-08-20 18:11:26 -04:00
* Use global $plugin_page and / or get_plugin_page_hookname () hooks .
2018-02-13 11:54:31 -05:00
*
* For more information on this and similar theme functions , check out
* the { @ link https :// developer . wordpress . org / themes / basics / conditional - tags /
* Conditional Tags } article in the Theme Developer Handbook .
*
2010-08-25 14:05:33 -04:00
* @ since 1.5 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.1 . 0
2010-08-25 14:05:33 -04:00
*
* @ global $plugin_page
*
* @ return bool
*/
function is_plugin_page () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.1.0' );
2010-08-25 14:05:33 -04:00
global $plugin_page ;
2015-01-08 17:52:22 -05:00
if ( isset ( $plugin_page ) )
2010-08-25 14:05:33 -04:00
return true ;
return false ;
}
2010-11-16 19:56:00 -05:00
/**
* Update the categories cache .
*
* This function does not appear to be used anymore or does not appear to be
* needed . It might be a legacy function left over from when there was a need
* for updating the category cache .
*
* @ since 1.5 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.1 . 0
2010-11-16 19:56:00 -05:00
*
* @ return bool Always return True
*/
function update_category_cache () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.1.0' );
2010-11-16 19:56:00 -05:00
return true ;
}
2011-04-13 13:30:02 -04:00
/**
* Check for PHP timezone support
*
* @ since 2.9 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.2 . 0
2011-04-13 13:30:02 -04:00
*
* @ return bool
*/
function wp_timezone_supported () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.2.0' );
2011-06-10 19:01:45 -04:00
2011-04-13 13:30:02 -04:00
return true ;
}
2011-07-24 20:36:06 -04:00
2011-08-03 06:19:00 -04:00
/**
2015-12-20 16:21:27 -05:00
* Displays an editor : TinyMCE , HTML , or both .
2011-08-03 06:19:00 -04:00
*
* @ since 2.1 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.3 . 0 Use wp_editor ()
2012-02-16 19:02:42 -05:00
* @ see wp_editor ()
2011-08-03 06:19:00 -04:00
*
2015-12-20 16:21:27 -05:00
* @ 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 .
2011-08-03 06:19:00 -04:00
*/
function the_editor ( $content , $id = 'content' , $prev_id = 'title' , $media_buttons = true , $tab_index = 2 , $extended = true ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' , 'wp_editor()' );
2011-08-24 15:32:59 -04:00
2011-08-03 06:19:00 -04:00
wp_editor ( $content , $id , array ( 'media_buttons' => $media_buttons ) );
}
2011-08-24 15:32:59 -04:00
/**
* Perform the query to get the $metavalues array ( s ) needed by _fill_user and _fill_many_users
*
* @ since 3.0 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.3 . 0
*
2011-08-24 15:32:59 -04:00
* @ param array $ids User ID numbers list .
* @ return array of arrays . The array is indexed by user_id , containing $metavalues object arrays .
*/
function get_user_metavalues ( $ids ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-08-24 15:32:59 -04:00
$objects = array ();
$ids = array_map ( 'intval' , $ids );
foreach ( $ids as $id )
$objects [ $id ] = array ();
$metas = update_meta_cache ( 'user' , $ids );
foreach ( $metas as $id => $meta ) {
foreach ( $meta as $key => $metavalues ) {
foreach ( $metavalues as $value ) {
$objects [ $id ][] = ( object ) array ( 'user_id' => $id , 'meta_key' => $key , 'meta_value' => $value );
}
}
}
return $objects ;
}
/**
* Sanitize every user field .
*
* If the context is 'raw' , then the user object or array will get minimal santization of the int fields .
*
* @ since 2.3 . 0
* @ deprecated 3.3 . 0
*
* @ param object | array $user The User Object or Array
* @ param string $context Optional , default is 'display' . How to sanitize user fields .
* @ return object | array The now sanitized User Object or Array ( will be the same type as $user )
*/
function sanitize_user_object ( $user , $context = 'display' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-08-24 15:32:59 -04:00
if ( is_object ( $user ) ) {
if ( ! isset ( $user -> ID ) )
$user -> ID = 0 ;
2015-01-15 20:06:24 -05:00
if ( ! ( $user instanceof WP_User ) ) {
2011-08-24 15:32:59 -04:00
$vars = get_object_vars ( $user );
foreach ( array_keys ( $vars ) as $field ) {
if ( is_string ( $user -> $field ) || is_numeric ( $user -> $field ) )
$user -> $field = sanitize_user_field ( $field , $user -> $field , $user -> ID , $context );
}
}
$user -> filter = $context ;
} else {
if ( ! isset ( $user [ 'ID' ]) )
$user [ 'ID' ] = 0 ;
foreach ( array_keys ( $user ) as $field )
$user [ $field ] = sanitize_user_field ( $field , $user [ $field ], $user [ 'ID' ], $context );
$user [ 'filter' ] = $context ;
}
return $user ;
}
2011-09-15 12:54:59 -04:00
/**
* Get boundary post relational link .
*
* Can either be start or end post relational link .
*
* @ since 2.8 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.3 . 0
2011-09-15 12:54:59 -04:00
*
* @ param string $title Optional . Link title format .
2011-09-29 18:57:43 -04:00
* @ param bool $in_same_cat Optional . Whether link should be in a same category .
2011-09-15 12:54:59 -04:00
* @ param string $excluded_categories Optional . Excluded categories IDs .
2011-09-29 18:57:43 -04:00
* @ param bool $start Optional , default is true . Whether to display link to first or last post .
2011-09-15 12:54:59 -04:00
* @ return string
*/
function get_boundary_post_rel_link ( $title = '%title' , $in_same_cat = false , $excluded_categories = '' , $start = true ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-09-15 12:54:59 -04:00
$posts = get_boundary_post ( $in_same_cat , $excluded_categories , $start );
2020-01-28 19:45:18 -05:00
// If there is no post, stop.
2011-09-15 12:54:59 -04:00
if ( empty ( $posts ) )
return ;
2020-01-28 19:45:18 -05:00
// Even though we limited get_posts() to return only 1 item it still returns an array of objects.
2011-09-15 12:54:59 -04:00
$post = $posts [ 0 ];
if ( empty ( $post -> post_title ) )
$post -> post_title = $start ? __ ( 'First Post' ) : __ ( 'Last Post' );
$date = mysql2date ( get_option ( 'date_format' ), $post -> post_date );
$title = str_replace ( '%title' , $post -> post_title , $title );
$title = str_replace ( '%date' , $date , $title );
$title = apply_filters ( 'the_title' , $title , $post -> ID );
$link = $start ? " <link rel='start' title=' " : " <link rel='end' title=' " ;
$link .= esc_attr ( $title );
$link .= " ' href=' " . get_permalink ( $post ) . " ' /> \n " ;
$boundary = $start ? 'start' : 'end' ;
return apply_filters ( " { $boundary } _post_rel_link " , $link );
}
/**
* Display relational link for the first post .
*
* @ since 2.8 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.3 . 0
2011-09-15 12:54:59 -04:00
*
* @ param string $title Optional . Link title format .
2011-09-29 18:57:43 -04:00
* @ param bool $in_same_cat Optional . Whether link should be in a same category .
2011-09-15 12:54:59 -04:00
* @ param string $excluded_categories Optional . Excluded categories IDs .
*/
function start_post_rel_link ( $title = '%title' , $in_same_cat = false , $excluded_categories = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-09-15 12:54:59 -04:00
echo get_boundary_post_rel_link ( $title , $in_same_cat , $excluded_categories , true );
}
/**
* Get site index relational link .
*
* @ since 2.8 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.3 . 0
2011-09-15 12:54:59 -04:00
*
* @ return string
*/
function get_index_rel_link () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-09-15 12:54:59 -04:00
$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 );
}
/**
* Display relational link for the site index .
*
* @ since 2.8 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.3 . 0
2011-09-15 12:54:59 -04:00
*/
function index_rel_link () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-09-15 12:54:59 -04:00
echo get_index_rel_link ();
}
/**
* Get parent post relational link .
*
* @ since 2.8 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.3 . 0
2011-09-15 12:54:59 -04:00
*
2016-02-28 13:16:26 -05:00
* @ param string $title Optional . Link title format . Default '%title' .
2011-09-15 12:54:59 -04:00
* @ return string
*/
2016-02-28 13:16:26 -05:00
function get_parent_post_rel_link ( $title = '%title' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-09-15 12:54:59 -04:00
if ( ! empty ( $GLOBALS [ 'post' ] ) && ! empty ( $GLOBALS [ 'post' ] -> post_parent ) )
2012-08-23 16:01:10 -04:00
$post = get_post ( $GLOBALS [ 'post' ] -> post_parent );
2011-09-15 12:54:59 -04:00
if ( empty ( $post ) )
return ;
$date = mysql2date ( get_option ( 'date_format' ), $post -> post_date );
$title = str_replace ( '%title' , $post -> post_title , $title );
$title = str_replace ( '%date' , $date , $title );
$title = apply_filters ( 'the_title' , $title , $post -> ID );
$link = " <link rel='up' title=' " ;
$link .= esc_attr ( $title );
$link .= " ' href=' " . get_permalink ( $post ) . " ' /> \n " ;
return apply_filters ( " parent_post_rel_link " , $link );
}
/**
* Display relational link for parent item
*
* @ since 2.8 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.3 . 0
2016-02-28 13:16:26 -05:00
*
* @ param string $title Optional . Link title format . Default '%title' .
2011-09-15 12:54:59 -04:00
*/
2016-02-28 13:16:26 -05:00
function parent_post_rel_link ( $title = '%title' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-09-15 12:54:59 -04:00
echo get_parent_post_rel_link ( $title );
2011-09-16 01:01:54 -04:00
}
/**
* Add the " Dashboard " / " Visit Site " menu .
*
* @ since 3.2 . 0
2012-02-16 19:02:42 -05:00
* @ deprecated 3.3 . 0
2016-02-28 13:18:28 -05:00
*
* @ param WP_Admin_Bar $wp_admin_bar WP_Admin_Bar instance .
2011-09-16 01:01:54 -04:00
*/
function wp_admin_bar_dashboard_view_site_menu ( $wp_admin_bar ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' );
2011-09-16 01:01:54 -04:00
$user_id = get_current_user_id ();
if ( 0 != $user_id ) {
if ( is_admin () )
$wp_admin_bar -> add_menu ( array ( 'id' => 'view-site' , 'title' => __ ( 'Visit Site' ), 'href' => home_url () ) );
elseif ( is_multisite () )
$wp_admin_bar -> add_menu ( array ( 'id' => 'dashboard' , 'title' => __ ( 'Dashboard' ), 'href' => get_dashboard_url ( $user_id ) ) );
else
$wp_admin_bar -> add_menu ( array ( 'id' => 'dashboard' , 'title' => __ ( 'Dashboard' ), 'href' => admin_url () ) );
}
}
2011-10-19 18:35:15 -04:00
/**
2016-01-27 22:35:27 -05:00
* Checks if the current user belong to a given site .
2011-10-19 18:35:15 -04:00
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2015-08-20 18:11:26 -04:00
* @ deprecated 3.3 . 0 Use is_user_member_of_blog ()
2011-10-19 18:35:15 -04:00
* @ see is_user_member_of_blog ()
*
2016-01-27 22:35:27 -05:00
* @ param int $blog_id Site ID
2011-10-19 18:35:15 -04:00
* @ return bool True if the current users belong to $blog_id , false if not .
*/
function is_blog_user ( $blog_id = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.3.0' , 'is_user_member_of_blog()' );
2011-10-19 18:35:15 -04:00
return is_user_member_of_blog ( get_current_user_id (), $blog_id );
}
2012-02-16 19:02:42 -05:00
/**
2012-02-27 14:46:52 -05:00
* Open the file handle for debugging .
2012-02-16 19:02:42 -05:00
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use error_log ()
* @ see error_log ()
*
2020-01-19 22:14:06 -05:00
* @ link https :// www . php . net / manual / en / function . error - log . php
2016-02-28 13:20:26 -05:00
*
* @ param string $filename File name .
* @ param string $mode Type of access you required to the stream .
* @ return false Always false .
2012-02-16 19:02:42 -05:00
*/
function debug_fopen ( $filename , $mode ) {
2017-10-06 20:40:52 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'error_log()' );
2012-02-16 19:02:42 -05:00
return false ;
}
/**
* Write contents to the file used for debugging .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use error_log ()
* @ see error_log ()
*
2020-01-19 22:14:06 -05:00
* @ link https :// www . php . net / manual / en / function . error - log . php
2016-02-28 13:30:27 -05:00
*
* @ param mixed $fp Unused .
* @ param string $string Message to log .
2012-02-16 19:02:42 -05:00
*/
function debug_fwrite ( $fp , $string ) {
2017-10-06 20:40:52 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'error_log()' );
2012-02-16 19:02:42 -05:00
if ( ! empty ( $GLOBALS [ 'debug' ] ) )
error_log ( $string );
}
/**
* Close the debugging file handle .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use error_log ()
* @ see error_log ()
*
2020-01-19 22:14:06 -05:00
* @ link https :// www . php . net / manual / en / function . error - log . php
2016-02-28 13:31:26 -05:00
*
* @ param mixed $fp Unused .
2012-02-16 19:02:42 -05:00
*/
function debug_fclose ( $fp ) {
2017-10-06 20:40:52 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'error_log()' );
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 16:24:44 -05:00
}
/**
* Retrieve list of themes with theme data in theme directory .
*
* The theme is broken , if it doesn ' t have a parent theme and is missing either
* style . css and , or index . php . If the theme has a parent theme then it is
* broken , if it is missing style . css ; index . php is optional .
*
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use wp_get_themes ()
2012-02-29 15:07:22 -05:00
* @ see wp_get_themes ()
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 16:24:44 -05:00
*
* @ return array Theme list with theme data .
*/
function get_themes () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'wp_get_themes()' );
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 16:24:44 -05:00
global $wp_themes ;
if ( isset ( $wp_themes ) )
return $wp_themes ;
$themes = wp_get_themes ();
$wp_themes = array ();
foreach ( $themes as $theme ) {
Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after [UT570] [UT578] [UT579]. see #20103.
* ['Template Files'] and ['Stylesheet Files'] need to return files from the parent theme as well.
* Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
* Ensure we are always passing around arrays in get_files/scandir.
* Better inline doc for wp_get_themes() arguments.
* Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
* Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
* Include an old array key in wp_broken_themes().
git-svn-id: http://svn.automattic.com/wordpress/trunk@20193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-03-15 11:39:21 -04:00
$name = $theme -> get ( 'Name' );
if ( isset ( $wp_themes [ $name ] ) )
$wp_themes [ $name . '/' . $theme -> get_stylesheet () ] = $theme ;
else
$wp_themes [ $name ] = $theme ;
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 16:24:44 -05:00
}
return $wp_themes ;
}
/**
* Retrieve theme data .
*
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use wp_get_theme ()
2012-02-29 15:07:22 -05:00
* @ see wp_get_theme ()
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 16:24:44 -05:00
*
* @ param string $theme Theme name .
* @ return array | null Null , if theme name does not exist . Theme data , if exists .
*/
function get_theme ( $theme ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'wp_get_theme( $stylesheet )' );
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 16:24:44 -05:00
$themes = get_themes ();
if ( is_array ( $themes ) && array_key_exists ( $theme , $themes ) )
2012-02-29 15:07:22 -05:00
return $themes [ $theme ];
Introduce WP_Theme, wp_get_themes(), and wp_get_theme() to replace get_themes(), get_theme(), get_theme_data(), current_theme_info(), and others.
* Getters and Helpers: Introduces a series of methods to allow for easy generation of headers for display, and other theme metadata, including page templates.
* Screenshots: Handles support for multiple screenshots. (see # Additional screenshots must be PNG and start with screenshot-2.png, and be sequential to be counted. see #19816.
* Error Handling: Broken themes have a WP_Error object attached to them.
* Caching: Introduces a wp_cache_themes_persistently filter (also in [20020]) to enable persistent caching of all filesystem and sanitization operations normally handled by WP_Theme (and formerly get_file_data() and get_themes()). Themes are cached individually and across five different cache keys for different data pieces.
* Compatibility: A WP_Theme object is backwards compatible with a theme's array formerly returned by get_themes() and get_theme(), and an stdClass object formerly returned by current_theme_info().
* i18n/L10n: Theme headers are now localizable with proper Text Domain and Domain Path headers, like plugins. (Language packs may remove the requirement for headers.) For page templates, see #6007 (not fixed yet, but will be easy now). For headers, fixes #15858.
* PHP and CSS files: New methods that fetch a list of theme files (for the theme editor) only on demand, rather than only loading them into memory. fixes #11214.
Functions deprecated:
* get_themes(), get_allowed_themes() and get_broken_themes() -- use wp_get_themes()
* get_theme() and current_theme_info() -- use wp_get_theme()
* get_site_allowed_themes() -- use WP_Theme::get_allowed_on_network()
* wpmu_get_blog_allowedthemes() -- use WP_theme::get_allowed_on_site()
see also [20016], [20018], [20019], [20020], [20021], [20022], [20025], [20026], [20027]. also fixes #19244.
see #20103.
git-svn-id: http://svn.automattic.com/wordpress/trunk@20029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-02-28 16:24:44 -05:00
return null ;
2012-02-29 15:07:22 -05:00
}
/**
* Retrieve current theme name .
*
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use wp_get_theme ()
2012-02-29 15:07:22 -05:00
* @ see wp_get_theme ()
*
* @ return string
*/
function get_current_theme () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'wp_get_theme()' );
2012-02-29 15:07:22 -05:00
if ( $theme = get_option ( 'current_theme' ) )
return $theme ;
return wp_get_theme () -> get ( 'Name' );
2012-03-19 17:14:41 -04:00
}
2012-03-28 11:43:31 -04:00
/**
* Accepts matches array from preg_replace_callback in wpautop () or a string .
*
2014-11-24 00:19:23 -05:00
* Ensures that the contents of a `<pre>...</pre>` HTML block are not
2012-03-28 11:43:31 -04:00
* converted into paragraphs or line - breaks .
*
* @ since 1.2 . 0
* @ deprecated 3.4 . 0
*
* @ param array | string $matches The array or string
* @ return string The pre block without paragraph / line - break conversion .
*/
function clean_pre ( $matches ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' );
2012-05-03 12:41:59 -04:00
2012-03-28 11:43:31 -04:00
if ( is_array ( $matches ) )
$text = $matches [ 1 ] . $matches [ 2 ] . " </pre> " ;
else
$text = $matches ;
2012-04-09 16:05:47 -04:00
$text = str_replace ( array ( '<br />' , '<br/>' , '<br>' ), array ( '' , '' , '' ), $text );
2012-03-28 11:43:31 -04:00
$text = str_replace ( '<p>' , " \n " , $text );
$text = str_replace ( '</p>' , '' , $text );
return $text ;
}
2012-03-19 17:14:41 -04:00
/**
* Add callbacks for image header display .
*
* @ since 2.1 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use add_theme_support ()
2012-03-19 17:14:41 -04:00
* @ see add_theme_support ()
*
2016-05-23 14:59:27 -04:00
* @ param callable $wp_head_callback Call on the { @ see 'wp_head' } action .
2015-09-25 19:58:25 -04:00
* @ 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 .
2012-03-19 17:14:41 -04:00
*/
2012-05-02 11:16:48 -04:00
function add_custom_image_header ( $wp_head_callback , $admin_head_callback , $admin_preview_callback = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'add_theme_support( \'custom-header\', $args )' );
2012-05-02 11:16:48 -04:00
$args = array (
'wp-head-callback' => $wp_head_callback ,
'admin-head-callback' => $admin_head_callback ,
);
2012-03-21 18:21:22 -04:00
if ( $admin_preview_callback )
$args [ 'admin-preview-callback' ] = $admin_preview_callback ;
2012-03-22 15:31:03 -04:00
return add_theme_support ( 'custom-header' , $args );
2012-03-19 17:14:41 -04:00
}
/**
* Remove image header support .
*
* @ since 3.1 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use remove_theme_support ()
2012-03-19 17:14:41 -04:00
* @ see remove_theme_support ()
*
2014-11-30 20:34:24 -05:00
* @ return null | bool Whether support was removed .
2012-03-19 17:14:41 -04:00
*/
function remove_custom_image_header () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'remove_theme_support( \'custom-header\' )' );
2012-03-19 17:14:41 -04:00
return remove_theme_support ( 'custom-header' );
}
/**
* Add callbacks for background image display .
*
* @ since 3.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use add_theme_support ()
2012-03-20 23:36:17 -04:00
* @ see add_theme_support ()
2012-03-19 17:14:41 -04:00
*
2016-05-23 14:59:27 -04:00
* @ param callable $wp_head_callback Call on the { @ see 'wp_head' } action .
2015-09-25 19:58:25 -04:00
* @ 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 .
2012-03-19 17:14:41 -04:00
*/
2012-03-20 23:36:17 -04:00
function add_custom_background ( $wp_head_callback = '' , $admin_head_callback = '' , $admin_preview_callback = '' ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'add_theme_support( \'custom-background\', $args )' );
2012-03-21 18:21:22 -04:00
$args = array ();
if ( $wp_head_callback )
$args [ 'wp-head-callback' ] = $wp_head_callback ;
if ( $admin_head_callback )
$args [ 'admin-head-callback' ] = $admin_head_callback ;
if ( $admin_preview_callback )
$args [ 'admin-preview-callback' ] = $admin_preview_callback ;
return add_theme_support ( 'custom-background' , $args );
2012-03-19 17:14:41 -04:00
}
/**
* Remove custom background support .
*
* @ since 3.1 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use add_custom_background ()
2012-03-19 17:14:41 -04:00
* @ see add_custom_background ()
*
2014-11-30 20:34:24 -05:00
* @ return null | bool Whether support was removed .
2012-03-19 17:14:41 -04:00
*/
function remove_custom_background () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'remove_theme_support( \'custom-background\' )' );
2012-03-19 17:14:41 -04:00
return remove_theme_support ( 'custom-background' );
2012-03-23 06:21:24 -04:00
}
/**
* Retrieve theme data from parsed theme file .
*
* @ since 1.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use wp_get_theme ()
2012-03-23 06:21:24 -04:00
* @ see wp_get_theme ()
*
* @ param string $theme_file Theme file path .
* @ return array Theme data .
*/
function get_theme_data ( $theme_file ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'wp_get_theme()' );
2019-03-01 15:58:52 -05:00
$theme = new WP_Theme ( wp_basename ( dirname ( $theme_file ) ), dirname ( dirname ( $theme_file ) ) );
2012-03-23 06:21:24 -04:00
$theme_data = array (
'Name' => $theme -> get ( 'Name' ),
'URI' => $theme -> display ( 'ThemeURI' , true , false ),
'Description' => $theme -> display ( 'Description' , true , false ),
'Author' => $theme -> display ( 'Author' , true , false ),
'AuthorURI' => $theme -> display ( 'AuthorURI' , true , false ),
'Version' => $theme -> get ( 'Version' ),
'Template' => $theme -> get ( 'Template' ),
'Status' => $theme -> get ( 'Status' ),
'Tags' => $theme -> get ( 'Tags' ),
'Title' => $theme -> get ( 'Name' ),
2012-06-11 13:30:57 -04:00
'AuthorName' => $theme -> get ( 'Author' ),
2012-03-23 06:21:24 -04:00
);
2012-06-11 13:30:57 -04:00
foreach ( apply_filters ( 'extra_theme_headers' , array () ) as $extra_header ) {
if ( ! isset ( $theme_data [ $extra_header ] ) )
$theme_data [ $extra_header ] = $theme -> get ( $extra_header );
}
2012-03-23 06:21:24 -04:00
return $theme_data ;
2012-04-10 12:09:44 -04:00
}
/**
* Alias of update_post_cache () .
*
* @ see update_post_cache () Posts and pages are the same , alias is intentional
*
* @ since 1.5 . 1
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use update_post_cache ()
* @ see update_post_cache ()
2012-04-10 12:09:44 -04:00
*
* @ param array $pages list of page objects
*/
function update_page_cache ( & $pages ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'update_post_cache()' );
2012-04-10 12:09:44 -04:00
update_post_cache ( $pages );
}
/**
* Will clean the page in the cache .
*
* Clean ( read : delete ) page from cache that matches $id . Will also clean cache
* associated with 'all_page_ids' and 'get_pages' .
*
* @ since 2.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 0 Use clean_post_cache
* @ see clean_post_cache ()
2012-04-10 12:09:44 -04:00
*
* @ param int $id Page ID to clean
*/
function clean_page_cache ( $id ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.0' , 'clean_post_cache()' );
2012-04-10 12:09:44 -04:00
2012-04-23 18:04:35 -04:00
clean_post_cache ( $id );
2012-04-10 12:09:44 -04:00
}
2012-06-26 02:10:07 -04:00
/**
* Retrieve nonce action " Are you sure " message .
*
2012-06-26 17:26:42 -04:00
* Deprecated in 3.4 . 1 and 3.5 . 0. Backported to 3.3 . 3.
*
2012-06-26 02:10:07 -04:00
* @ since 2.0 . 4
2015-08-20 18:11:26 -04:00
* @ deprecated 3.4 . 1 Use wp_nonce_ays ()
2012-06-26 02:10:07 -04:00
* @ see wp_nonce_ays ()
*
* @ param string $action Nonce action .
* @ return string Are you sure message .
*/
function wp_explain_nonce ( $action ) {
2012-06-26 17:26:42 -04:00
_deprecated_function ( __FUNCTION__ , '3.4.1' , 'wp_nonce_ays()' );
2012-06-26 02:10:07 -04:00
return __ ( 'Are you sure you want to do this?' );
2012-07-09 17:10:59 -04:00
}
/**
* Display " sticky " CSS class , if a post is sticky .
*
* @ since 2.7 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.5 . 0 Use post_class ()
2012-07-09 17:10:59 -04:00
* @ see post_class ()
*
* @ param int $post_id An optional post ID .
*/
function sticky_class ( $post_id = null ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.5.0' , 'post_class()' );
2012-07-09 17:10:59 -04:00
if ( is_sticky ( $post_id ) )
echo ' sticky' ;
}
2012-08-20 20:10:05 -04:00
/**
* Retrieve post ancestors .
*
* This is no longer needed as WP_Post lazy - loads the ancestors
* property with get_post_ancestors () .
*
* @ since 2.3 . 4
2015-08-20 18:11:26 -04:00
* @ deprecated 3.5 . 0 Use get_post_ancestors ()
2012-08-20 20:10:05 -04:00
* @ see get_post_ancestors ()
2016-02-28 13:33:25 -05:00
*
2017-10-02 18:03:33 -04:00
* @ param WP_Post $post Post object , passed by reference ( unused ) .
2012-08-20 20:10:05 -04:00
*/
function _get_post_ancestors ( & $post ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.5.0' );
2012-08-28 15:08:28 -04:00
}
2012-10-01 16:59:06 -04:00
/**
* Load an image from a string , if PHP supports it .
*
* @ since 2.1 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.5 . 0 Use wp_get_image_editor ()
2012-11-22 04:52:16 -05:00
* @ see wp_get_image_editor ()
2012-10-01 16:59:06 -04:00
*
* @ param string $file Filename of the image to load .
* @ return resource The resulting image resource on success , Error string on failure .
*/
function wp_load_image ( $file ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.5.0' , 'wp_get_image_editor()' );
2012-10-01 16:59:06 -04:00
if ( is_numeric ( $file ) )
$file = get_attached_file ( $file );
2016-08-23 19:36:28 -04:00
if ( ! is_file ( $file ) ) {
2019-09-02 20:41:05 -04:00
/* translators: %s: File name. */
2016-08-23 19:36:28 -04:00
return sprintf ( __ ( 'File “%s” doesn’t exist?' ), $file );
}
2012-10-01 16:59:06 -04:00
if ( ! function_exists ( 'imagecreatefromstring' ) )
return __ ( 'The GD image library is not installed.' );
2016-05-29 22:14:30 -04:00
// Set artificially high because GD uses uncompressed images in memory.
2016-07-08 10:37:30 -04:00
wp_raise_memory_limit ( 'image' );
2016-05-29 22:14:30 -04:00
2012-10-01 16:59:06 -04:00
$image = imagecreatefromstring ( file_get_contents ( $file ) );
2016-08-23 19:36:28 -04:00
if ( ! is_resource ( $image ) ) {
2019-09-02 20:41:05 -04:00
/* translators: %s: File name. */
2016-08-23 19:36:28 -04:00
return sprintf ( __ ( 'File “%s” is not an image.' ), $file );
}
2012-10-01 16:59:06 -04:00
return $image ;
}
/**
* Scale down an image to fit a particular size and save a new copy of the image .
*
* The PNG transparency will be preserved using the function , as well as the
* image type . If the file going in is PNG , then the resized image is going to
* be PNG . The only supported image types are PNG , GIF , and JPEG .
*
* Some functionality requires API to exist , so some PHP version may lose out
* support . This is not the fault of WordPress ( where functionality is
* downgraded , not actual defects ), but of your PHP version .
*
* @ since 2.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.5 . 0 Use wp_get_image_editor ()
2012-11-22 04:52:16 -05:00
* @ see wp_get_image_editor ()
2012-10-01 16:59:06 -04:00
*
* @ param string $file Image file path .
* @ param int $max_w Maximum width to resize to .
* @ param int $max_h Maximum height to resize to .
* @ param bool $crop Optional . Whether to crop image or resize .
* @ param string $suffix Optional . File suffix .
* @ param string $dest_path Optional . New image file path .
* @ param int $jpeg_quality Optional , default is 90. Image quality percentage .
* @ 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 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.5.0' , 'wp_get_image_editor()' );
2012-10-01 16:59:06 -04:00
2012-11-22 04:52:16 -05:00
$editor = wp_get_image_editor ( $file );
2012-10-01 16:59:06 -04:00
if ( is_wp_error ( $editor ) )
return $editor ;
$editor -> set_quality ( $jpeg_quality );
$resized = $editor -> resize ( $max_w , $max_h , $crop );
if ( is_wp_error ( $resized ) )
return $resized ;
$dest_file = $editor -> generate_filename ( $suffix , $dest_path );
$saved = $editor -> save ( $dest_file );
if ( is_wp_error ( $saved ) )
return $saved ;
return $dest_file ;
}
2012-08-28 15:08:28 -04:00
/**
* Retrieve a single post , based on post ID .
*
* Has categories in 'post_category' property or key . Has tags in 'tags_input'
* property or key .
*
* @ since 1.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.5 . 0 Use get_post ()
2012-08-28 15:08:28 -04:00
* @ see get_post ()
*
* @ param int $postid Post ID .
* @ param string $mode How to return result , either OBJECT , ARRAY_N , or ARRAY_A .
2014-11-30 20:34:24 -05:00
* @ return WP_Post | null Post object or array holding post contents and information
2012-08-28 15:08:28 -04:00
*/
function wp_get_single_post ( $postid = 0 , $mode = OBJECT ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.5.0' , 'get_post()' );
2013-06-19 03:58:28 -04:00
return get_post ( $postid , $mode );
2012-08-28 15:08:28 -04:00
}
2012-09-18 21:35:35 -04:00
/**
* Check that the user login name and password is correct .
*
* @ since 0.71
2015-08-20 18:11:26 -04:00
* @ deprecated 3.5 . 0 Use wp_authenticate ()
2012-09-18 21:35:35 -04:00
* @ see wp_authenticate ()
*
* @ param string $user_login User name .
* @ param string $user_pass User password .
* @ return bool False if does not authenticate , true if username and password authenticates .
*/
function user_pass_ok ( $user_login , $user_pass ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.5.0' , 'wp_authenticate()' );
2012-09-18 21:35:35 -04:00
$user = wp_authenticate ( $user_login , $user_pass );
if ( is_wp_error ( $user ) )
return false ;
return true ;
}
2012-09-21 14:52:15 -04:00
/**
* Callback formerly fired on the save_post hook . No longer needed .
*
* @ since 2.3 . 0
* @ deprecated 3.5 . 0
*/
2012-11-22 04:52:16 -05:00
function _save_post_hook () {}
/**
* Check if the installed version of GD supports particular image type
*
* @ since 2.9 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.5 . 0 Use wp_image_editor_supports ()
2012-12-23 11:22:22 -05:00
* @ see wp_image_editor_supports ()
2012-11-22 04:52:16 -05:00
*
* @ param string $mime_type
* @ return bool
*/
function gd_edit_image_support ( $mime_type ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.5.0' , 'wp_image_editor_supports()' );
2012-11-22 04:52:16 -05:00
if ( function_exists ( 'imagetypes' ) ) {
switch ( $mime_type ) {
case 'image/jpeg' :
return ( imagetypes () & IMG_JPG ) != 0 ;
case 'image/png' :
return ( imagetypes () & IMG_PNG ) != 0 ;
case 'image/gif' :
return ( imagetypes () & IMG_GIF ) != 0 ;
}
} else {
switch ( $mime_type ) {
case 'image/jpeg' :
return function_exists ( 'imagecreatefromjpeg' );
case 'image/png' :
return function_exists ( 'imagecreatefrompng' );
case 'image/gif' :
return function_exists ( 'imagecreatefromgif' );
}
}
return false ;
}
2013-02-15 22:07:56 -05:00
/**
* Converts an integer byte value to a shorthand byte value .
*
* @ since 2.3 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 3.6 . 0 Use size_format ()
* @ see size_format ()
2013-02-15 22:07:56 -05:00
*
* @ param int $bytes An integer byte value .
* @ return string A shorthand byte value .
*/
function wp_convert_bytes_to_hr ( $bytes ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.6.0' , 'size_format()' );
2013-02-28 00:25:15 -05:00
2016-06-14 17:41:28 -04:00
$units = array ( 0 => 'B' , 1 => 'KB' , 2 => 'MB' , 3 => 'GB' , 4 => 'TB' );
2015-10-21 10:03:25 -04:00
$log = log ( $bytes , KB_IN_BYTES );
2013-02-15 22:59:37 -05:00
$power = ( int ) $log ;
2019-09-21 08:49:57 -04:00
$size = KB_IN_BYTES ** ( $log - $power );
2013-02-28 00:25:15 -05:00
2013-03-01 10:59:10 -05:00
if ( ! is_nan ( $size ) && array_key_exists ( $power , $units ) ) {
2013-02-28 00:25:15 -05:00
$unit = $units [ $power ];
} else {
$size = $bytes ;
$unit = $units [ 0 ];
}
return $size . $unit ;
2013-02-15 22:07:56 -05:00
}
2013-09-28 04:25:09 -04:00
/**
* Formerly used internally to tidy up the search terms .
*
* @ since 2.9 . 0
2015-08-20 18:11:26 -04:00
* @ access private
2013-09-28 04:25:09 -04:00
* @ deprecated 3.7 . 0
2016-02-28 13:35:26 -05:00
*
* @ param string $t Search terms to " tidy " , e . g . trim .
* @ return string Trimmed search terms .
2013-09-28 04:25:09 -04:00
*/
function _search_terms_tidy ( $t ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.7.0' );
2013-09-28 04:25:09 -04:00
return trim ( $t , " \" ' \n \r " );
}
2014-01-12 19:00:12 -05:00
/**
* Determine if TinyMCE is available .
*
2014-04-07 18:17:15 -04:00
* Checks to see if the user has deleted the tinymce files to slim down
2017-08-22 07:52:48 -04:00
* their WordPress installation .
2014-01-12 19:00:12 -05:00
*
* @ since 2.1 . 0
* @ deprecated 3.9 . 0
*
* @ return bool Whether TinyMCE exists .
*/
function rich_edit_exists () {
global $wp_rich_edit_exists ;
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.9.0' );
2014-01-12 19:00:12 -05:00
if ( ! isset ( $wp_rich_edit_exists ) )
$wp_rich_edit_exists = file_exists ( ABSPATH . WPINC . '/js/tinymce/tinymce.js' );
return $wp_rich_edit_exists ;
}
2014-03-03 12:29:15 -05:00
/**
* Old callback for tag link tooltips .
*
* @ since 2.7 . 0
* @ access private
2015-08-20 18:11:26 -04:00
* @ deprecated 3.9 . 0
2016-02-28 13:36:27 -05:00
*
* @ param int $count Number of topics .
* @ return int Number of topics .
2014-03-03 12:29:15 -05:00
*/
function default_topic_count_text ( $count ) {
return $count ;
}
2014-03-05 17:48:15 -05:00
/**
2014-04-07 18:23:14 -04:00
* Formerly used to escape strings before inserting into the DB .
2014-04-07 18:17:15 -04:00
*
2014-04-07 18:23:14 -04:00
* Has not performed this function for many , many years . Use wpdb :: prepare () instead .
2014-03-05 17:48:15 -05:00
*
* @ since 0.71
* @ deprecated 3.9 . 0
*
* @ param string $content The text to format .
* @ return string The very same text .
*/
function format_to_post ( $content ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '3.9.0' );
2014-03-05 17:48:15 -05:00
return $content ;
}
2014-06-09 18:03:18 -04:00
2014-06-09 20:30:15 -04:00
/**
* Formerly used to escape strings before searching the DB . It was poorly documented and never worked as described .
*
* @ since 2.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 4.0 . 0 Use wpdb :: esc_like ()
* @ see wpdb :: esc_like ()
2014-06-09 20:30:15 -04:00
*
* @ param string $text The text to be escaped .
* @ return string text , safe for inclusion in LIKE query .
*/
function like_escape ( $text ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.0.0' , 'wpdb::esc_like()' );
2014-06-09 20:30:15 -04:00
return str_replace ( array ( " % " , " _ " ), array ( " \\ % " , " \\ _ " ), $text );
}
2014-06-09 18:03:18 -04:00
/**
* Determines if the URL can be accessed over SSL .
*
* Determines if the URL can be accessed over SSL by using the WordPress HTTP API to access
* the URL using https as the scheme .
*
* @ since 2.5 . 0
* @ deprecated 4.0 . 0
*
* @ param string $url The URL to test .
* @ return bool Whether SSL access is available .
*/
function url_is_accessable_via_ssl ( $url ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.0.0' );
2014-06-09 18:03:18 -04:00
$response = wp_remote_get ( set_url_scheme ( $url , 'https' ) );
if ( ! is_wp_error ( $response ) ) {
$status = wp_remote_retrieve_response_code ( $response );
if ( 200 == $status || 401 == $status ) {
return true ;
}
}
return false ;
}
2015-06-21 18:01:28 -04:00
2015-07-29 14:36:26 -04:00
/**
* Start preview theme output buffer .
*
* Will only perform task if the user has permissions and template and preview
* query variables exist .
*
* @ since 2.6 . 0
* @ deprecated 4.3 . 0
*/
function preview_theme () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.3.0' );
2015-07-29 14:36:26 -04:00
}
/**
* Private function to modify the current template when previewing a theme
*
* @ since 2.9 . 0
* @ deprecated 4.3 . 0
* @ access private
*
* @ return string
*/
function _preview_theme_template_filter () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.3.0' );
2015-07-29 14:36:26 -04:00
return '' ;
}
/**
* Private function to modify the current stylesheet when previewing a theme
*
* @ since 2.9 . 0
* @ deprecated 4.3 . 0
* @ access private
*
* @ return string
*/
function _preview_theme_stylesheet_filter () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.3.0' );
2015-07-29 14:36:26 -04:00
return '' ;
}
/**
* Callback function for ob_start () to capture all links in the theme .
*
* @ since 2.6 . 0
* @ deprecated 4.3 . 0
* @ access private
*
* @ param string $content
* @ return string
*/
function preview_theme_ob_filter ( $content ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.3.0' );
2015-07-29 14:36:26 -04:00
return $content ;
}
/**
* Manipulates preview theme links in order to control and maintain location .
*
* Callback function for preg_replace_callback () to accept and filter matches .
*
* @ since 2.6 . 0
* @ deprecated 4.3 . 0
* @ access private
*
* @ param array $matches
* @ return string
*/
function preview_theme_ob_filter_callback ( $matches ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.3.0' );
2015-07-29 14:36:26 -04:00
return '' ;
}
2015-06-21 18:01:28 -04:00
/**
* Formats text for the rich text editor .
*
2016-05-23 14:59:27 -04:00
* The { @ see 'richedit_pre' } filter is applied here . If $text is empty the filter will
2015-06-21 18:01:28 -04:00
* be applied to an empty string .
*
* @ since 2.0 . 0
2017-06-25 18:10:41 -04:00
* @ deprecated 4.3 . 0 Use format_for_editor ()
* @ see format_for_editor ()
2015-06-21 18:01:28 -04:00
*
* @ param string $text The text to be formatted .
* @ return string The formatted text after filter is applied .
*/
function wp_richedit_pre ( $text ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.3.0' , 'format_for_editor()' );
2015-06-21 18:01:28 -04:00
if ( empty ( $text ) ) {
/**
2016-05-22 14:50:28 -04:00
* Filters text returned for the rich text editor .
2015-06-21 18:01:28 -04:00
*
* 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
* in a break tag and line feed .
*
* If a non - empty string is passed , the filter is evaluated on the wp_richedit_pre ()
* return after being formatted .
*
* @ since 2.0 . 0
* @ deprecated 4.3 . 0
*
* @ param string $output Text for the rich text editor .
*/
return apply_filters ( 'richedit_pre' , '' );
}
$output = convert_chars ( $text );
$output = wpautop ( $output );
$output = htmlspecialchars ( $output , ENT_NOQUOTES , get_option ( 'blog_charset' ) );
/** This filter is documented in wp-includes/deprecated.php */
return apply_filters ( 'richedit_pre' , $output );
}
/**
* Formats text for the HTML editor .
*
* Unless $output is empty it will pass through htmlspecialchars before the
2016-05-23 14:59:27 -04:00
* { @ see 'htmledit_pre' } filter is applied .
2015-06-21 18:01:28 -04:00
*
* @ since 2.5 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 4.3 . 0 Use format_for_editor ()
* @ see format_for_editor ()
2015-06-21 18:01:28 -04:00
*
* @ param string $output The text to be formatted .
* @ return string Formatted text after filter applied .
*/
function wp_htmledit_pre ( $output ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.3.0' , 'format_for_editor()' );
2015-06-21 18:01:28 -04:00
if ( ! empty ( $output ) )
2020-01-28 19:45:18 -05:00
$output = htmlspecialchars ( $output , ENT_NOQUOTES , get_option ( 'blog_charset' ) ); // Convert only '< > &'.
2015-06-21 18:01:28 -04:00
/**
2016-05-22 14:50:28 -04:00
* Filters the text before it is formatted for the HTML editor .
2015-06-21 18:01:28 -04:00
*
* @ since 2.5 . 0
* @ deprecated 4.3 . 0
*
* @ param string $output The HTML - formatted text .
*/
return apply_filters ( 'htmledit_pre' , $output );
}
2015-08-20 02:24:26 -04:00
/**
* Retrieve permalink from post ID .
*
* @ since 1.0 . 0
2015-08-20 18:11:26 -04:00
* @ deprecated 4.4 . 0 Use get_permalink ()
* @ see get_permalink ()
2015-08-20 02:24:26 -04:00
*
* @ param int | WP_Post $post_id Optional . Post ID or WP_Post object . Default is global $post .
* @ return string | false
*/
function post_permalink ( $post_id = 0 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.4.0' , 'get_permalink()' );
2015-08-20 02:24:26 -04:00
return get_permalink ( $post_id );
}
2015-09-09 00:26:25 -04:00
/**
* Perform a HTTP HEAD or GET request .
*
* If $file_path is a writable filename , this will do a GET request and write
* the file to that path .
*
* @ since 2.5 . 0
* @ deprecated 4.4 . 0 Use WP_Http
* @ see WP_Http
*
* @ param string $url URL to fetch .
* @ param string | bool $file_path Optional . File path to write request to . Default false .
* @ param int $red Optional . The number of Redirects followed , Upon 5 being hit ,
* returns false . Default 1.
* @ return bool | string False on failure and string of headers if HEAD request .
*/
function wp_get_http ( $url , $file_path = false , $red = 1 ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.4.0' , 'WP_Http' );
2015-09-09 00:26:25 -04:00
@ set_time_limit ( 60 );
if ( $red > 5 )
return false ;
$options = array ();
$options [ 'redirection' ] = 5 ;
if ( false == $file_path )
$options [ 'method' ] = 'HEAD' ;
else
$options [ 'method' ] = 'GET' ;
$response = wp_safe_remote_request ( $url , $options );
if ( is_wp_error ( $response ) )
return false ;
$headers = wp_remote_retrieve_headers ( $response );
$headers [ 'response' ] = wp_remote_retrieve_response_code ( $response );
// WP_HTTP no longer follows redirects for HEAD requests.
if ( 'HEAD' == $options [ 'method' ] && in_array ( $headers [ 'response' ], array ( 301 , 302 )) && isset ( $headers [ 'location' ] ) ) {
return wp_get_http ( $headers [ 'location' ], $file_path , ++ $red );
}
if ( false == $file_path )
return $headers ;
2020-01-28 19:45:18 -05:00
// GET request - write it to the supplied filename.
2015-09-09 00:26:25 -04:00
$out_fp = fopen ( $file_path , 'w' );
if ( ! $out_fp )
return $headers ;
fwrite ( $out_fp , wp_remote_retrieve_body ( $response ) );
fclose ( $out_fp );
clearstatcache ();
return $headers ;
}
2015-09-29 17:28:50 -04:00
/**
* Whether SSL login should be forced .
*
* @ since 2.6 . 0
* @ deprecated 4.4 . 0 Use force_ssl_admin ()
2015-09-29 18:46:25 -04:00
* @ see force_ssl_admin ()
2015-09-29 17:28:50 -04:00
*
* @ param string | bool $force Optional Whether to force SSL login . Default null .
* @ return bool True if forced , false if not forced .
*/
function force_ssl_login ( $force = null ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.4.0' , 'force_ssl_admin()' );
2015-09-29 17:28:50 -04:00
return force_ssl_admin ( $force );
}
2015-12-09 22:06:30 -05:00
/**
* 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 () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.5.0' );
2015-12-09 22:06:30 -05:00
return '' ;
}
/**
2018-02-13 11:54:31 -05:00
* Determines whether the current URL is within the comments popup window .
*
* For more information on this and similar theme functions , check out
* the { @ link https :// developer . wordpress . org / themes / basics / conditional - tags /
* Conditional Tags } article in the Theme Developer Handbook .
*
2015-12-09 22:06:30 -05:00
* @ since 1.5 . 0
* @ deprecated 4.5 . 0
*
* @ return bool
*/
function is_comments_popup () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.5.0' );
2015-12-09 22:06:30 -05:00
return false ;
}
/**
* Display the JS popup script to show a comment .
*
* @ since 0.71
* @ deprecated 4.5 . 0
*/
function comments_popup_script () {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.5.0' );
2015-12-09 22:06:30 -05:00
}
/**
2018-05-05 05:45:22 -04:00
* Adds element attributes to open links in new tabs .
2015-12-09 22:06:30 -05:00
*
* @ since 0.71
* @ deprecated 4.5 . 0
*
2018-05-05 05:45:22 -04:00
* @ param string $text Content to replace links to open in a new tab .
2015-12-09 22:06:30 -05:00
* @ return string Content that has filtered links .
*/
function popuplinks ( $text ) {
2016-07-06 08:40:29 -04:00
_deprecated_function ( __FUNCTION__ , '4.5.0' );
2015-12-09 22:06:30 -05:00
$text = preg_replace ( '/<a (.+?)>/i' , " <a $ 1 target='_blank' rel='external'> " , $text );
return $text ;
}
2016-06-18 05:47:29 -04:00
/**
* 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 '' ;
}
2016-10-07 17:03:31 -04:00
/**
* Retrieve path of paged template in current or parent template .
*
* @ since 1.5 . 0
2016-10-31 02:28:32 -04:00
* @ deprecated 4.7 . 0 The paged . php template is no longer part of the theme template hierarchy .
2016-10-07 17:03:31 -04:00
*
* @ return string Full path to paged template file .
*/
function get_paged_template () {
_deprecated_function ( __FUNCTION__ , '4.7.0' );
return get_query_template ( 'paged' );
}
2016-10-13 18:25:31 -04:00
/**
* 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
2017-01-10 17:09:42 -05:00
* @ deprecated 4.7 . 0 Officially dropped security support for Netscape 4.
2016-10-13 18:25:31 -04:00
*
* @ param string $string
* @ return string
*/
function wp_kses_js_entities ( $string ) {
_deprecated_function ( __FUNCTION__ , '4.7.0' );
return preg_replace ( '%&\s*\{[^}]*(\}\s*;?|$)%' , '' , $string );
}
2016-10-25 17:26:32 -04:00
/**
* 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 ) {
2017-06-24 20:05:44 -04:00
_deprecated_function ( __FUNCTION__ , '4.7.0' , 'wp_list_sort()' );
2016-10-25 17:26:32 -04:00
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 ) {
2017-06-24 20:05:44 -04:00
_deprecated_function ( __FUNCTION__ , '4.7.0' , 'wp_list_sort()' );
2016-10-25 17:26:32 -04:00
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 ;
2017-06-24 20:05:44 -04:00
_deprecated_function ( __FUNCTION__ , '4.7.0' , 'wp_list_sort()' );
2016-10-25 17:26:32 -04:00
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 );
}
2017-09-24 10:22:54 -04:00
/**
* Retrieves the Press This bookmarklet link .
*
* @ since 2.6 . 0
* @ deprecated 4.9 . 0
*
*/
function get_shortcut_link () {
_deprecated_function ( __FUNCTION__ , '4.9.0' );
$link = '' ;
/**
* Filters the Press This bookmarklet link .
*
* @ since 2.6 . 0
* @ deprecated 4.9 . 0
*
* @ param string $link The Press This bookmarklet link .
*/
return apply_filters ( 'shortcut_link' , $link );
}
/**
* Ajax handler for saving a post from Press This .
*
* @ since 4.2 . 0
* @ deprecated 4.9 . 0
*/
function wp_ajax_press_this_save_post () {
_deprecated_function ( __FUNCTION__ , '4.9.0' );
if ( is_plugin_active ( 'press-this/press-this-plugin.php' ) ) {
2020-02-06 01:33:11 -05:00
include WP_PLUGIN_DIR . '/press-this/class-wp-press-this-plugin.php' ;
2017-09-24 10:22:54 -04:00
$wp_press_this = new WP_Press_This_Plugin ();
$wp_press_this -> save_post ();
} else {
wp_send_json_error ( array ( 'errorMessage' => __ ( 'The Press This plugin is required.' ) ) );
}
}
/**
* Ajax handler for creating new category from Press This .
*
* @ since 4.2 . 0
* @ deprecated 4.9 . 0
*/
function wp_ajax_press_this_add_category () {
_deprecated_function ( __FUNCTION__ , '4.9.0' );
if ( is_plugin_active ( 'press-this/press-this-plugin.php' ) ) {
2020-02-06 01:33:11 -05:00
include WP_PLUGIN_DIR . '/press-this/class-wp-press-this-plugin.php' ;
2017-09-24 10:22:54 -04:00
$wp_press_this = new WP_Press_This_Plugin ();
$wp_press_this -> add_category ();
} else {
wp_send_json_error ( array ( 'errorMessage' => __ ( 'The Press This plugin is required.' ) ) );
}
}