<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[13041] trunk: First pass at custom background support.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/13041">13041</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2010-02-09 20:37:12 +0000 (Tue, 09 Feb 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>First pass at custom background support. Needs UI love. see <a href="http://trac.wordpress.org/ticket/12186">#12186</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpcontentthemestwentytenfunctionsphp">trunk/wp-content/themes/twentyten/functions.php</a></li>
<li><a href="#trunkwpincludesthemephp">trunk/wp-includes/theme.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkwpadmincustombackgroundphp">trunk/wp-admin/custom-background.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadmincustombackgroundphp"></a>
<div class="addfile"><h4>Added: trunk/wp-admin/custom-background.php (0 => 13041)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/custom-background.php (rev 0)
+++ trunk/wp-admin/custom-background.php 2010-02-09 20:37:12 UTC (rev 13041)
</span><span class="lines">@@ -0,0 +1,245 @@
</span><ins>+<?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();
+ }
+
+}
+?>
</ins><span class="cx">Property changes on: trunk/wp-admin/custom-background.php
</span><span class="cx">___________________________________________________________________
</span><span class="cx">Name: svn:eol-style
</span><span class="cx"> + native
</span></span></pre></div>
<a id="trunkwpcontentthemestwentytenfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-content/themes/twentyten/functions.php (13040 => 13041)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-content/themes/twentyten/functions.php 2010-02-09 18:22:21 UTC (rev 13040)
+++ trunk/wp-content/themes/twentyten/functions.php 2010-02-09 20:37:12 UTC (rev 13041)
</span><span class="lines">@@ -28,6 +28,7 @@
</span><span class="cx"> add_custom_image_header('', 'twentyten_admin_header_style');
</span><span class="cx"> // and thus ends the changeable header business
</span><span class="cx">
</span><ins>+add_custom_background();
</ins><span class="cx">
</span><span class="cx"> // This theme needs post thumbnails
</span><span class="cx"> add_theme_support( 'post-thumbnails' );
</span></span></pre></div>
<a id="trunkwpincludesthemephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/theme.php (13040 => 13041)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/theme.php 2010-02-09 18:22:21 UTC (rev 13040)
+++ trunk/wp-includes/theme.php 2010-02-09 20:37:12 UTC (rev 13041)
</span><span class="lines">@@ -1335,6 +1335,80 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * 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
+}
+
+/**
</ins><span class="cx"> * Allows a theme to register its support of a certain feature
</span><span class="cx"> *
</span><span class="cx"> * Must be called in the themes functions.php file to work.
</span></span></pre>
</div>
</div>
</body>
</html>