First pass at custom background support. Needs UI love. see #12186

git-svn-id: http://svn.automattic.com/wordpress/trunk@13041 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
ryan 2010-02-09 20:37:12 +00:00
parent 26d0ba4c75
commit 61859c5f5e
3 changed files with 320 additions and 0 deletions

View File

@ -0,0 +1,245 @@
<?php
/**
* The custom background image script.
*
* @package WordPress
* @subpackage Administration
*/
/**
* The custom background image class.
*
* @since unknown
* @package WordPress
* @subpackage Administration
*/
class Custom_Background {
/**
* Callback for administration header.
*
* @var callback
* @since unknown
* @access private
*/
var $admin_header_callback;
/**
* Callback for header div.
*
* @var callback
* @since unknown
* @access private
*/
var $admin_image_div_callback;
/**
* PHP4 Constructor - Register administration header callback.
*
* @since unknown
* @param callback $admin_header_callback
* @param callback $admin_image_div_callback Optional custom image div output callback.
* @return Custom_Background
*/
function Custom_Background($admin_header_callback = '', $admin_image_div_callback = '') {
$this->admin_header_callback = $admin_header_callback;
$this->admin_image_div_callback = $admin_image_div_callback;
}
/**
* Setup the hooks for the Custom Background admin page.
*
* @since unknown
*/
function init() {
$page = add_theme_page(__('Custom Background'), __('Custom Background'), 'switch_themes', 'custom-background', array(&$this, 'admin_page'));
add_action("admin_head-$page", array(&$this, 'take_action'), 50);
if ( $this->admin_header_callback )
add_action("admin_head-$page", $this->admin_header_callback, 51);
}
/**
* Get the current step.
*
* @since unknown
*
* @return int Current step
*/
function step() {
if ( ! isset( $_GET['step'] ) )
return 1;
$step = (int) $_GET['step'];
if ( $step < 1 || 3 < $step )
$step = 1;
return $step;
}
/**
* Execute custom background modification.
*
* @since unknown
*/
function take_action() {
if ( isset($_POST['reset-background']) ) {
check_admin_referer('custom-background');
remove_theme_mods();
}
if ( isset($_POST['repeat-background']) ) {
check_admin_referer('custom-background');
$repeat = $_POST['repeat-background'] ? true: false;
set_theme_mod('background_repeat', $repeat);
} elseif ( isset($_POST['save-background-options']) ) {
set_theme_mod('background_repeat', false);
}
if ( isset($_POST['remove-background']) ) {
check_admin_referer('custom-background');
set_theme_mod('background_image', '');
}
}
/**
* Display first step of custom background image page.
*
* @since unknown
*/
function step_1() {
if ( isset($_GET['updated']) && $_GET['updated'] ) { ?>
<div id="message" class="updated">
<p><?php printf(__('Background updated. <a href="%s">Visit your site</a> to see how it looks.'), home_url()); ?></p>
</div>
<?php } ?>
<div class="wrap">
<?php screen_icon(); ?>
<h2><?php _e('Custom Background'); ?></h2>
<?php if ( get_background_image() ) { ?>
<p><?php _e('This is your current background image.'); ?></p>
<?php
} else { ?>
<p><?php _e('There is currently no background image.'); ?></p> <?php
}
if ( $this->admin_image_div_callback ) {
call_user_func($this->admin_image_div_callback);
} else {
?>
<div id="background-image">
<img src="<?php background_image(); ?>" />
</div>
<?php } ?>
</div>
<div class="wrap">
<h2><?php _e('Upload New Background Image'); ?></h2><p><?php _e('Here you can upload a new background image.'); ?></p>
<form enctype="multipart/form-data" id="uploadForm" method="POST" action="<?php echo esc_attr(add_query_arg('step', 2)) ?>" style="margin: auto; width: 50%;">
<label for="upload"><?php _e('Choose an image from your computer:'); ?></label><br /><input type="file" id="upload" name="import" />
<input type="hidden" name="action" value="save" />
<?php wp_nonce_field('custom-background') ?>
<p class="submit">
<input type="submit" value="<?php esc_attr_e('Upload'); ?>" />
</p>
</form>
</div>
<div class="wrap">
<h2><?php _e('Change Display Options') ?></h2>
<form method="post" action="<?php echo esc_attr(add_query_arg('step', 1)) ?>">
<label for="repeat-background">
<p><input name="repeat-background" type="checkbox" id="repeat-background" value="1" <?php checked(true, get_theme_mod('background_repeat')); ?> />
<?php _e('Tile the background.') ?></label></p>
<?php wp_nonce_field('custom-background'); ?>
<input type="submit" class="button" name="save-background-options" value="<?php esc_attr_e('Save Changes'); ?>" />
</form>
</div>
<?php if ( get_theme_mod('background_image') ) : ?>
<div class="wrap">
<h2><?php _e('Reset Background Image'); ?></h2>
<p><?php _e('This will restore the original background image. You will not be able to retrieve any customizations.') ?></p>
<form method="post" action="<?php echo esc_attr(add_query_arg('step', 1)) ?>">
<?php wp_nonce_field('custom-background'); ?>
<input type="submit" class="button" name="reset-background" value="<?php esc_attr_e('Restore Original Background'); ?>" />
</form>
</div>
<?php endif;
if ( get_background_image() ) :
?>
<div class="wrap">
<h2><?php _e('Remove Background Image'); ?></h2>
<p><?php _e('This will remove background image. You will not be able to retrieve any customizations.') ?></p>
<form method="post" action="<?php echo esc_attr(add_query_arg('step', 1)) ?>">
<?php wp_nonce_field('custom-background'); ?>
<input type="submit" class="button" name="remove-background" value="<?php esc_attr_e('Remove Background'); ?>" />
</form>
</div>
<?php endif;
}
/**
* Display second step of custom background image page.
*
* @since unknown
*/
function step_2() {
check_admin_referer('custom-background');
$overrides = array('test_form' => false);
$file = wp_handle_upload($_FILES['import'], $overrides);
if ( isset($file['error']) )
die( $file['error'] );
$url = $file['url'];
$type = $file['type'];
$file = $file['file'];
$filename = basename($file);
// Construct the object array
$object = array(
'post_title' => $filename,
'post_content' => $url,
'post_mime_type' => $type,
'guid' => $url);
// Save the data
$id = wp_insert_attachment($object, $file);
// Add the meta-data
wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) );
set_theme_mod('background_image', esc_url($url));
do_action('wp_create_file_in_uploads', $file, $id); // For replication
return $this->finished();
}
/**
* Display last step of custom header image page.
*
* @since unknown
*/
function finished() {
$_GET['updated'] = 1;
$this->step_1();
}
/**
* Display the page based on the current step.
*
* @since unknown
*/
function admin_page() {
$step = $this->step();
if ( 1 == $step )
$this->step_1();
elseif ( 2 == $step )
$this->step_2();
}
}
?>

View File

@ -28,6 +28,7 @@ function twentyten_admin_header_style() {
add_custom_image_header('', 'twentyten_admin_header_style');
// and thus ends the changeable header business
add_custom_background();
// This theme needs post thumbnails
add_theme_support( 'post-thumbnails' );

View File

@ -1334,6 +1334,80 @@ function add_custom_image_header($header_callback, $admin_header_callback, $admi
add_action('admin_menu', array(&$GLOBALS['custom_image_header'], 'init'));
}
/**
* Retrieve background image for custom background.
*
* @since 3.0.0
*
* @return string
*/
function get_background_image() {
$default = defined('BACKGROUND_IMAGE') ? BACKGROUND_IMAGE : '';
return get_theme_mod('background_image', $default);
}
/**
* Display background image path.
*
* @since 3.0.0
*/
function background_image() {
echo get_background_image();
}
/**
* Add callbacks for background image display.
*
* The parameter $header_callback callback will be required to display the
* content for the 'wp_head' action. The parameter $admin_header_callback
* callback will be added to Custom_Background class and that will be added
* to the 'admin_menu' action.
*
* @since 3.0.0
* @uses Custom_Background Sets up for $admin_header_callback for administration panel display.
*
* @param callback $header_callback Call on 'wp_head' action.
* @param callback $admin_header_callback Call on custom background administration screen.
* @param callback $admin_image_div_callback Output a custom background image div on the custom background administration screen. Optional.
*/
function add_custom_background($header_callback = '', $admin_header_callback = '', $admin_image_div_callback = '') {
if ( empty($header_callback) )
$header_callback = '_custom_background_cb';
add_action('wp_head', $header_callback);
if ( ! is_admin() )
return;
require_once(ABSPATH . 'wp-admin/custom-background.php');
$GLOBALS['custom_background'] =& new Custom_Background($admin_header_callback, $admin_image_div_callback);
add_action('admin_menu', array(&$GLOBALS['custom_background'], 'init'));
}
/**
* Default custom background callback.
*
* @since 3.0.0
* @see add_custom_background()
* @access protected
*/
function _custom_background_cb() {
$background = get_background_image();
if ( !$background )
return;
$repeat = get_theme_mod('background_repeat');
$repeat = $repeat ? '' : ' no-repeat';
?>
<style type="text/css">
body {
background: url('<?php background_image(); ?>') fixed <?php echo $repeat ?>;
}
</style>
<?php
}
/**
* Allows a theme to register its support of a certain feature
*