2010-01-06 21:22:51 -05:00
< ? php
2010-01-07 02:32:44 -05:00
/**
* Deprecated functions from WordPress MU and the multisite feature . You shouldn ' t
* use these functions and look for the alternatives instead . The functions will be
* removed in a later version .
*
* @ package WordPress
* @ subpackage Deprecated
2010-04-04 09:29:35 -04:00
* @ since 3.0 . 0
2010-01-07 02:32:44 -05:00
*/
2010-01-06 21:22:51 -05:00
2010-01-07 02:32:44 -05:00
/*
* Deprecated functions come here to die .
*/
2010-01-15 17:11:12 -05:00
2010-01-07 02:32:44 -05:00
/**
2010-12-20 04:25:21 -05:00
* @ since MU
2010-01-28 11:09:52 -05:00
* @ deprecated 3.0 . 0
2010-01-07 02:32:44 -05:00
* @ deprecated Use wp_generate_password ()
* @ see wp_generate_password ()
*/
2010-01-06 21:22:51 -05:00
function generate_random_password ( $len = 8 ) {
2010-01-07 02:32:44 -05:00
_deprecated_function ( __FUNCTION__ , '3.0' , 'wp_generate_password()' );
2010-01-28 11:09:52 -05:00
return wp_generate_password ( $len );
2010-01-06 21:22:51 -05:00
}
2010-01-07 10:50:46 -05:00
/**
* Determine if user is a site admin .
*
* Plugins should use is_multisite () instead of checking if this function exists
* to determine if multisite is enabled .
*
* This function must reside in a file included only if is_multisite () due to
* legacy function_exists () checks to determine if multisite is enabled .
*
2010-01-28 11:09:52 -05:00
* @ since MU
* @ deprecated 3.0 . 0
2010-01-07 10:50:46 -05:00
* @ deprecated Use is_super_admin ()
* @ see is_super_admin ()
* @ see is_multisite ()
*
*/
function is_site_admin ( $user_login = '' ) {
_deprecated_function ( __FUNCTION__ , '3.0' , 'is_super_admin()' );
if ( empty ( $user_login ) ) {
$user_id = get_current_user_id ();
if ( ! $user_id )
return false ;
} else {
2010-06-25 11:11:36 -04:00
$user = get_user_by ( 'login' , $user_login );
2012-04-06 15:18:45 -04:00
if ( ! $user -> exists () )
2010-01-07 10:50:46 -05:00
return false ;
2010-06-25 11:11:36 -04:00
$user_id = $user -> ID ;
2010-01-07 10:50:46 -05:00
}
return is_super_admin ( $user_id );
}
2010-01-28 11:09:52 -05:00
if ( ! function_exists ( 'graceful_fail' ) ) :
2010-01-25 17:09:43 -05:00
/**
2010-01-28 11:09:52 -05:00
* @ since MU
* @ deprecated 3.0 . 0
* @ deprecated Use wp_die ()
* @ see wp_die ()
2010-01-25 17:09:43 -05:00
*/
function graceful_fail ( $message ) {
_deprecated_function ( __FUNCTION__ , '3.0' , 'wp_die()' );
2010-01-28 11:09:52 -05:00
$message = apply_filters ( 'graceful_fail' , $message );
2010-01-25 17:09:43 -05:00
$message_template = apply_filters ( 'graceful_fail_template' ,
2011-07-21 20:25:41 -04:00
' <! DOCTYPE html >
2010-01-25 17:09:43 -05:00
< html xmlns = " http://www.w3.org/1999/xhtml " >< head profile = " http://gmpg.org/xfn/11 " >
< meta http - equiv = " Content-Type " content = " text/html; charset=UTF-8 " />
< title > Error !</ title >
< style type = " text/css " >
img {
border : 0 ;
}
body {
line - height : 1.6 em ; font - family : Georgia , serif ; width : 390 px ; margin : auto ;
text - align : center ;
}
. message {
font - size : 22 px ;
width : 350 px ;
margin : auto ;
}
</ style >
</ head >
< body >
< p class = " message " >% s </ p >
</ body >
</ html > ' );
die ( sprintf ( $message_template , $message ) );
}
endif ;
2010-01-26 12:16:49 -05:00
/**
2010-01-28 11:09:52 -05:00
* @ since MU
* @ deprecated 3.0 . 0
* @ deprecated Use get_user_by ()
* @ see get_user_by ()
2010-01-26 12:16:49 -05:00
*/
function get_user_details ( $username ) {
_deprecated_function ( __FUNCTION__ , '3.0' , 'get_user_by()' );
return get_user_by ( 'login' , $username );
}
2010-01-26 13:39:12 -05:00
/**
2010-01-28 11:09:52 -05:00
* @ since MU
* @ deprecated 3.0 . 0
* @ deprecated Use clean_post_cache ()
* @ see clean_post_cache ()
2010-01-26 13:39:12 -05:00
*/
function clear_global_post_cache ( $post_id ) {
2010-01-28 11:09:52 -05:00
_deprecated_function ( __FUNCTION__ , '3.0' , 'clean_post_cache()' );
2010-01-26 13:39:12 -05:00
}
2010-01-26 17:46:09 -05:00
/**
2010-01-28 11:09:52 -05:00
* @ since MU
* @ deprecated 3.0 . 0
* @ deprecated Use is_main_site ()
* @ see is_main_site ()
2010-01-26 17:46:09 -05:00
*/
function is_main_blog () {
2010-01-28 11:09:52 -05:00
_deprecated_function ( __FUNCTION__ , '3.0' , 'is_main_site()' );
2010-01-26 17:46:09 -05:00
return is_main_site ();
}
2010-01-26 20:27:25 -05:00
/**
2010-01-28 11:09:52 -05:00
* @ since MU
* @ deprecated 3.0 . 0
* @ deprecated Use is_email ()
* @ see is_email ()
2010-01-26 20:27:25 -05:00
*/
function validate_email ( $email , $check_domain = true ) {
2010-01-27 08:58:29 -05:00
_deprecated_function ( __FUNCTION__ , '3.0' , 'is_email()' );
2010-01-26 20:27:25 -05:00
return is_email ( $email , $check_domain );
}
2010-06-08 09:00:09 -04:00
/**
* @ since MU
* @ deprecated 3.0 . 0
2010-06-28 06:11:41 -04:00
* @ deprecated No alternative available . For performance reasons this function is not recommended .
2010-06-08 09:00:09 -04:00
*/
function get_blog_list ( $start = 0 , $num = 10 , $deprecated = '' ) {
2010-06-28 06:11:41 -04:00
_deprecated_function ( __FUNCTION__ , '3.0' );
2010-06-08 09:56:20 -04:00
global $wpdb ;
$blogs = $wpdb -> get_results ( $wpdb -> prepare ( " SELECT blog_id, domain, path FROM $wpdb->blogs WHERE site_id = %d AND public = '1' AND archived = '0' AND mature = '0' AND spam = '0' AND deleted = '0' ORDER BY registered DESC " , $wpdb -> siteid ), ARRAY_A );
foreach ( ( array ) $blogs as $details ) {
$blog_list [ $details [ 'blog_id' ] ] = $details ;
$blog_list [ $details [ 'blog_id' ] ][ 'postcount' ] = $wpdb -> get_var ( " SELECT COUNT(ID) FROM " . $wpdb -> get_blog_prefix ( $details [ 'blog_id' ] ) . " posts WHERE post_status='publish' AND post_type='post' " );
}
unset ( $blogs );
$blogs = $blog_list ;
if ( false == is_array ( $blogs ) )
return array ();
if ( $num == 'all' )
return array_slice ( $blogs , $start , count ( $blogs ) );
else
return array_slice ( $blogs , $start , $num );
2010-06-08 09:00:09 -04:00
}
/**
* @ since MU
* @ deprecated 3.0 . 0
2010-06-28 06:11:41 -04:00
* @ deprecated No alternative available . For performance reasons this function is not recommended .
2010-06-08 09:00:09 -04:00
*/
function get_most_active_blogs ( $num = 10 , $display = true ) {
2010-06-28 06:11:41 -04:00
_deprecated_function ( __FUNCTION__ , '3.0' );
2010-06-08 09:56:20 -04:00
$blogs = get_blog_list ( 0 , 'all' , false ); // $blog_id -> $details
if ( is_array ( $blogs ) ) {
reset ( $blogs );
foreach ( ( array ) $blogs as $key => $details ) {
$most_active [ $details [ 'blog_id' ] ] = $details [ 'postcount' ];
$blog_list [ $details [ 'blog_id' ] ] = $details ; // array_slice() removes keys!!
}
arsort ( $most_active );
reset ( $most_active );
foreach ( ( array ) $most_active as $key => $details )
$t [ $key ] = $blog_list [ $key ];
unset ( $most_active );
$most_active = $t ;
}
if ( $display == true ) {
if ( is_array ( $most_active ) ) {
reset ( $most_active );
foreach ( ( array ) $most_active as $key => $details ) {
$url = esc_url ( 'http://' . $details [ 'domain' ] . $details [ 'path' ]);
echo '<li>' . $details [ 'postcount' ] . " <a href=' $url '> $url </a></li> " ;
}
}
}
return array_slice ( $most_active , 0 , $num );
2010-06-08 09:00:09 -04:00
}
2011-09-30 11:13:13 -04:00
/**
* Redirect a user based on $_GET or $_POST arguments .
*
* The function looks for redirect arguments in the following order :
* 1 ) $_GET [ 'ref' ]
* 2 ) $_POST [ 'ref' ]
* 3 ) $_SERVER [ 'HTTP_REFERER' ]
* 4 ) $_GET [ 'redirect' ]
* 5 ) $_POST [ 'redirect' ]
* 6 ) $url
*
* @ since MU
* @ deprecated 3.3 . 0
* @ deprecated Use wp_redirect ()
* @ uses wpmu_admin_redirect_add_updated_param ()
*
* @ param string $url
*/
function wpmu_admin_do_redirect ( $url = '' ) {
_deprecated_function ( __FUNCTION__ , '3.3' );
$ref = '' ;
if ( isset ( $_GET [ 'ref' ] ) )
$ref = $_GET [ 'ref' ];
if ( isset ( $_POST [ 'ref' ] ) )
$ref = $_POST [ 'ref' ];
if ( $ref ) {
$ref = wpmu_admin_redirect_add_updated_param ( $ref );
wp_redirect ( $ref );
exit ();
}
if ( empty ( $_SERVER [ 'HTTP_REFERER' ] ) == false ) {
wp_redirect ( $_SERVER [ 'HTTP_REFERER' ] );
exit ();
}
$url = wpmu_admin_redirect_add_updated_param ( $url );
if ( isset ( $_GET [ 'redirect' ] ) ) {
if ( substr ( $_GET [ 'redirect' ], 0 , 2 ) == 's_' )
$url .= '&action=blogs&s=' . esc_html ( substr ( $_GET [ 'redirect' ], 2 ) );
} elseif ( isset ( $_POST [ 'redirect' ] ) ) {
$url = wpmu_admin_redirect_add_updated_param ( $_POST [ 'redirect' ] );
}
wp_redirect ( $url );
exit ();
}
/**
* Adds an 'updated=true' argument to a URL .
*
* @ since MU
* @ deprecated 3.3 . 0
* @ deprecated Use add_query_arg ()
*
* @ param string $url
* @ return string
*/
function wpmu_admin_redirect_add_updated_param ( $url = '' ) {
_deprecated_function ( __FUNCTION__ , '3.3' );
if ( strpos ( $url , 'updated=true' ) === false ) {
if ( strpos ( $url , '?' ) === false )
return $url . '?updated=true' ;
else
return $url . '&updated=true' ;
}
return $url ;
}
2012-08-03 13:51:42 -04:00
/**
* Retrieve option value for a given blog id based on name of option .
*
* If the option does not exist or does not have a value , then the return value
* will be false . This is useful to check whether you need to install an option
* and is commonly used during installation of plugin options and to test
* whether upgrading is required .
*
* If the option was serialized then it will be unserialized when it is returned .
*
* @ since MU
* @ deprecated 3.5 . 0
*
* @ param int $id A blog ID . Can be null to refer to the current blog .
* @ param string $option Name of option to retrieve . Expected to not be SQL - escaped .
* @ param mixed $default Optional . Default value to return if the option does not exist .
* @ return mixed Value set for the option .
*/
function get_blog_option ( $id , $option , $default = false ) {
_deprecated_function ( __FUNCTION__ , '3.5' );
$id = ( int ) $id ;
if ( empty ( $id ) )
$id = get_current_blog_id ();
if ( get_current_blog_id () == $id )
return get_option ( $option , $default );
switch_to_blog ( $id );
$option = get_option ( $option , $default );
restore_current_blog ();
return $option ;
}
/**
* Add a new option for a given blog id .
*
* You do not need to serialize values . If the value needs to be serialized , then
* it will be serialized before it is inserted into the database . Remember ,
* resources can not be serialized or added as an option .
*
* You can create options without values and then update the values later .
* Existing options will not be updated and checks are performed to ensure that you
* aren ' t adding a protected WordPress option . Care should be taken to not name
* options the same as the ones which are protected .
*
* @ since MU
* @ deprecated 3.5 . 0
*
* @ param int $id A blog ID . Can be null to refer to the current blog .
* @ param string $option Name of option to add . Expected to not be SQL - escaped .
* @ param mixed $value Optional . Option value , can be anything . Expected to not be SQL - escaped .
* @ return bool False if option was not added and true if option was added .
*/
function add_blog_option ( $id , $option , $value ) {
_deprecated_function ( __FUNCTION__ , '3.5' );
$id = ( int ) $id ;
if ( empty ( $id ) )
$id = get_current_blog_id ();
if ( get_current_blog_id () == $id )
return add_option ( $option , $value );
switch_to_blog ( $id );
$return = add_option ( $option , $value );
restore_current_blog ();
return $return ;
}
/**
* Removes option by name for a given blog id . Prevents removal of protected WordPress options .
*
* @ since MU
* @ deprecated 3.5 . 0
*
* @ param int $id A blog ID . Can be null to refer to the current blog .
* @ param string $option Name of option to remove . Expected to not be SQL - escaped .
* @ return bool True , if option is successfully deleted . False on failure .
*/
function delete_blog_option ( $id , $option ) {
_deprecated_function ( __FUNCTION__ , '3.5' );
$id = ( int ) $id ;
if ( empty ( $id ) )
$id = get_current_blog_id ();
if ( get_current_blog_id () == $id )
return delete_option ( $option );
switch_to_blog ( $id );
$return = delete_option ( $option );
restore_current_blog ();
return $return ;
}
/**
* Update an option for a particular blog .
*
* @ since MU
* @ deprecated 3.5 . 0
*
* @ param int $id The blog id
* @ param string $option The option key
* @ param mixed $value The option value
* @ return bool True on success , false on failrue .
*/
function update_blog_option ( $id , $option , $value , $deprecated = null ) {
_deprecated_function ( __FUNCTION__ , '3.5' );
$id = ( int ) $id ;
if ( null !== $deprecated )
_deprecated_argument ( __FUNCTION__ , '3.1' );
if ( get_current_blog_id () == $id )
return update_option ( $option , $value );
switch_to_blog ( $id );
$return = update_option ( $option , $value );
restore_current_blog ();
refresh_blog_details ( $id );
return $return ;
}