]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/custom-header.php
WordPress 4.2.5-scripts
[autoinstalls/wordpress.git] / wp-admin / custom-header.php
index 2a6a2f30834a6d272fca54775ec18eaaf9348e20..a56c7602c685d617975c9af3cd805da993cd30b9 100644 (file)
@@ -20,18 +20,16 @@ class Custom_Image_Header {
         *
         * @var callback
         * @since 2.1.0
-        * @access private
         */
-       var $admin_header_callback;
+       public $admin_header_callback;
 
        /**
         * Callback for header div.
         *
         * @var callback
         * @since 3.0.0
-        * @access private
         */
-       var $admin_image_div_callback;
+       public $admin_image_div_callback;
 
        /**
         * Holds default headers.
@@ -40,25 +38,12 @@ class Custom_Image_Header {
         * @since 3.0.0
         * @access private
         */
-       var $default_headers;
-
-       /**
-        * Holds custom headers uploaded by the user.
-        *
-        * @var array
-        * @since 3.2.0
-        * @access private
-        */
-       var $uploaded_headers = array();
+       public $default_headers = array();
 
        /**
-        * Holds the page menu hook.
-        *
-        * @var string
-        * @since 3.0.0
-        * @access private
+        * @var bool
         */
-       var $page = '';
+       private $updated;
 
        /**
         * Constructor - Register administration header callback.
@@ -66,9 +51,8 @@ class Custom_Image_Header {
         * @since 2.1.0
         * @param callback $admin_header_callback
         * @param callback $admin_image_div_callback Optional custom image div output callback.
-        * @return Custom_Image_Header
         */
-       function __construct($admin_header_callback, $admin_image_div_callback = '') {
+       public function __construct($admin_header_callback, $admin_image_div_callback = '') {
                $this->admin_header_callback = $admin_header_callback;
                $this->admin_image_div_callback = $admin_image_div_callback;
 
@@ -85,20 +69,20 @@ class Custom_Image_Header {
         *
         * @since 2.1.0
         */
-       function init() {
-               if ( ! current_user_can('edit_theme_options') )
+       public function init() {
+               $page = add_theme_page( __( 'Header' ), __( 'Header' ), 'edit_theme_options', 'custom-header', array( $this, 'admin_page' ) );
+               if ( ! $page ) {
                        return;
+               }
 
-               $this->page = $page = add_theme_page(__('Header'), __('Header'), 'edit_theme_options', 'custom-header', array($this, 'admin_page'));
-
-               add_action("admin_print_scripts-$page", array($this, 'js_includes'));
-               add_action("admin_print_styles-$page", array($this, 'css_includes'));
-               add_action("admin_head-$page", array($this, 'help') );
-               add_action("admin_head-$page", array($this, 'take_action'), 50);
-               add_action("admin_head-$page", array($this, 'js'), 50);
-               if ( $this->admin_header_callback )
-                       add_action("admin_head-$page", $this->admin_header_callback, 51);
-
+               add_action( "admin_print_scripts-$page", array( $this, 'js_includes' ) );
+               add_action( "admin_print_styles-$page", array( $this, 'css_includes' ) );
+               add_action( "admin_head-$page", array( $this, 'help' ) );
+               add_action( "admin_head-$page", array( $this, 'take_action' ), 50 );
+               add_action( "admin_head-$page", array( $this, 'js' ), 50 );
+               if ( $this->admin_header_callback ) {
+                       add_action( "admin_head-$page", $this->admin_header_callback, 51 );
+               }
        }
 
        /**
@@ -106,7 +90,7 @@ class Custom_Image_Header {
         *
         * @since 3.0.0
         */
-       function help() {
+       public function help() {
                get_current_screen()->add_help_tab( array(
                        'id'      => 'overview',
                        'title'   => __('Overview'),
@@ -136,7 +120,7 @@ class Custom_Image_Header {
 
                get_current_screen()->set_help_sidebar(
                        '<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
-                       '<p>' . __( '<a href="http://codex.wordpress.org/Appearance_Header_Screen" target="_blank">Documentation on Custom Header</a>' ) . '</p>' .
+                       '<p>' . __( '<a href="https://codex.wordpress.org/Appearance_Header_Screen" target="_blank">Documentation on Custom Header</a>' ) . '</p>' .
                        '<p>' . __( '<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>' ) . '</p>'
                );
        }
@@ -148,7 +132,7 @@ class Custom_Image_Header {
         *
         * @return int Current step
         */
-       function step() {
+       public function step() {
                if ( ! isset( $_GET['step'] ) )
                        return 1;
 
@@ -167,7 +151,7 @@ class Custom_Image_Header {
         *
         * @since 2.1.0
         */
-       function js_includes() {
+       public function js_includes() {
                $step = $this->step();
 
                if ( ( 1 == $step || 3 == $step ) ) {
@@ -185,7 +169,7 @@ class Custom_Image_Header {
         *
         * @since 2.7.0
         */
-       function css_includes() {
+       public function css_includes() {
                $step = $this->step();
 
                if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) )
@@ -199,7 +183,7 @@ class Custom_Image_Header {
         *
         * @since 2.6.0
         */
-       function take_action() {
+       public function take_action() {
                if ( ! current_user_can('edit_theme_options') )
                        return;
 
@@ -245,16 +229,13 @@ class Custom_Image_Header {
         *
         * @since 3.0.0
         */
-       function process_default_headers() {
+       public function process_default_headers() {
                global $_wp_default_headers;
 
-               if ( !empty($this->headers) )
-                       return;
-
                if ( !isset($_wp_default_headers) )
                        return;
 
-               if ( is_array( $this->default_headers ) ) {
+               if ( ! empty( $this->default_headers ) ) {
                        return;
                }
 
@@ -275,7 +256,7 @@ class Custom_Image_Header {
         *
         * @since 3.0.0
         */
-       function show_header_selector( $type = 'default' ) {
+       public function show_header_selector( $type = 'default' ) {
                if ( 'default' == $type ) {
                        $headers = $this->default_headers;
                } else {
@@ -308,11 +289,11 @@ class Custom_Image_Header {
        }
 
        /**
-        * Execute Javascript depending on step.
+        * Execute JavaScript depending on step.
         *
         * @since 2.1.0
         */
-       function js() {
+       public function js() {
                $step = $this->step();
                if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) )
                        $this->js_1();
@@ -321,15 +302,23 @@ class Custom_Image_Header {
        }
 
        /**
-        * Display Javascript based on Step 1 and 3.
+        * Display JavaScript based on Step 1 and 3.
         *
         * @since 2.6.0
         */
-       function js_1() { ?>
+       public function js_1() {
+               $default_color = '';
+               if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) {
+                       $default_color = get_theme_support( 'custom-header', 'default-text-color' );
+                       if ( $default_color && false === strpos( $default_color, '#' ) ) {
+                               $default_color = '#' . $default_color;
+                       }
+               }
+               ?>
+
 <script type="text/javascript">
-/* <![CDATA[ */
 (function($){
-       var default_color = '#<?php echo get_theme_support( 'custom-header', 'default-text-color' ); ?>',
+       var default_color = '<?php echo $default_color; ?>',
                header_text_fields;
 
        function pickColor(color) {
@@ -370,19 +359,17 @@ class Custom_Image_Header {
                <?php endif; ?>
        });
 })(jQuery);
-/* ]]> */
 </script>
 <?php
        }
 
        /**
-        * Display Javascript based on Step 2.
+        * Display JavaScript based on Step 2.
         *
         * @since 2.6.0
         */
-       function js_2() { ?>
+       public function js_2() { ?>
 <script type="text/javascript">
-/* <![CDATA[ */
        function onEndCrop( coords ) {
                jQuery( '#x1' ).val(coords.x);
                jQuery( '#y1' ).val(coords.y);
@@ -444,7 +431,6 @@ class Custom_Image_Header {
                        }
                });
        });
-/* ]]> */
 </script>
 <?php
        }
@@ -454,13 +440,26 @@ class Custom_Image_Header {
         *
         * @since 2.1.0
         */
-       function step_1() {
+       public function step_1() {
                $this->process_default_headers();
 ?>
 
 <div class="wrap">
 <h2><?php _e( 'Custom Header' ); ?></h2>
 
+<?php if ( current_user_can( 'customize' ) ) { ?>
+<div class="notice notice-info hide-if-no-customize">
+       <p>
+               <?php
+               printf(
+                       __( 'You can now manage and live-preview Custom Header in the <a href="%1$s">Customizer</a>.' ),
+                       admin_url( 'customize.php?autofocus[control]=header_image' )
+               );
+               ?>
+       </p>
+</div>
+<?php } ?>
+
 <?php if ( ! empty( $this->updated ) ) { ?>
 <div id="message" class="updated">
 <p><?php printf( __( 'Header updated. <a href="%s">Visit your site</a> to see how it looks.' ), home_url( '/' ) ); ?></p>
@@ -481,7 +480,14 @@ class Custom_Image_Header {
                call_user_func( $this->admin_image_div_callback );
        } else {
                $custom_header = get_custom_header();
-               $header_image_style = 'background-image:url(' . esc_url( get_header_image() ) . ');';
+               $header_image = get_header_image();
+
+               if ( $header_image ) {
+                       $header_image_style = 'background-image:url(' . esc_url( $header_image ) . ');';
+               }  else {
+                       $header_image_style = '';
+               }
+
                if ( $custom_header->width )
                        $header_image_style .= 'max-width:' . $custom_header->width . 'px;';
                if ( $custom_header->height )
@@ -494,7 +500,7 @@ class Custom_Image_Header {
                else
                        $style = ' style="display:none;"';
                ?>
-               <h1><a id="name" class="displaying-header-text" <?php echo $style; ?> onclick="return false;" href="<?php bloginfo('url'); ?>"><?php bloginfo( 'name' ); ?></a></h1>
+               <h1><a id="name" class="displaying-header-text" <?php echo $style; ?> onclick="return false;" href="<?php bloginfo('url'); ?>" tabindex="-1"><?php bloginfo( 'name' ); ?></a></h1>
                <div id="desc" class="displaying-header-text" <?php echo $style; ?>><?php bloginfo( 'description' ); ?></div>
        </div>
        <?php } ?>
@@ -541,10 +547,10 @@ class Custom_Image_Header {
        ?>
        <p>
                <label for="choose-from-library-link"><?php _e( 'Or choose an image from your media library:' ); ?></label><br />
-               <a id="choose-from-library-link" class="button"
+               <button id="choose-from-library-link" class="button"
                        data-update-link="<?php echo esc_attr( $modal_update_href ); ?>"
                        data-choose="<?php esc_attr_e( 'Choose a Custom Header' ); ?>"
-                       data-update="<?php esc_attr_e( 'Set as header' ); ?>"><?php _e( 'Choose Image' ); ?></a>
+                       data-update="<?php esc_attr_e( 'Set as header' ); ?>"><?php _e( 'Choose Image' ); ?></button>
        </p>
        </form>
 </td>
@@ -554,6 +560,7 @@ class Custom_Image_Header {
 </table>
 
 <form method="post" action="<?php echo esc_url( add_query_arg( 'step', 1 ) ) ?>">
+<?php submit_button( null, 'screen-reader-text', 'save-header-options', false ); ?>
 <table class="form-table">
 <tbody>
        <?php if ( get_uploaded_header_images() ) : ?>
@@ -624,17 +631,27 @@ class Custom_Image_Header {
 <th scope="row"><?php _e( 'Text Color' ); ?></th>
 <td>
        <p>
-<?php
-$header_textcolor = display_header_text() ? get_header_textcolor() : get_theme_support( 'custom-header', 'default-text-color' );
-$default_color = '';
-if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) {
-       $default_color = '#' . get_theme_support( 'custom-header', 'default-text-color' );
-       $default_color_attr = ' data-default-color="' . esc_attr( $default_color ) . '"';
-       echo '<input type="text" name="text-color" id="text-color" value="#' . esc_attr( $header_textcolor ) . '"' . $default_color_attr . ' />';
-       if ( $default_color )
-               echo ' <span class="description hide-if-js">' . sprintf( _x( 'Default: %s', 'color' ), $default_color ) . '</span>';
-}
-?>
+       <?php
+       $default_color = '';
+       if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) {
+               $default_color = get_theme_support( 'custom-header', 'default-text-color' );
+               if ( $default_color && false === strpos( $default_color, '#' ) ) {
+                       $default_color = '#' . $default_color;
+               }
+       }
+
+       $default_color_attr = $default_color ? ' data-default-color="' . esc_attr( $default_color ) . '"' : '';
+
+       $header_textcolor = display_header_text() ? get_header_textcolor() : get_theme_support( 'custom-header', 'default-text-color' );
+       if ( $header_textcolor && false === strpos( $header_textcolor, '#' ) ) {
+               $header_textcolor = '#' . $header_textcolor;
+       }
+
+       echo '<input type="text" name="text-color" id="text-color" value="' . esc_attr( $header_textcolor ) . '"' . $default_color_attr . ' />';
+       if ( $default_color ) {
+               echo ' <span class="description hide-if-js">' . sprintf( _x( 'Default: %s', 'color' ), esc_html( $default_color ) ) . '</span>';
+       }
+       ?>
        </p>
 </td>
 </tr>
@@ -662,18 +679,21 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         *
         * @since 2.1.0
         */
-       function step_2() {
+       public function step_2() {
                check_admin_referer('custom-header-upload', '_wpnonce-custom-header-upload');
                if ( ! current_theme_supports( 'custom-header', 'uploads' ) )
-                       wp_die( __( 'Cheatin&#8217; uh?' ) );
+                       wp_die( __( 'Cheatin&#8217; uh?' ), 403 );
 
                if ( empty( $_POST ) && isset( $_GET['file'] ) ) {
                        $attachment_id = absint( $_GET['file'] );
                        $file = get_attached_file( $attachment_id, true );
-                       $url = wp_get_attachment_image_src( $attachment_id, 'full');
+                       $url = wp_get_attachment_image_src( $attachment_id, 'full' );
                        $url = $url[0];
                } elseif ( isset( $_POST ) ) {
-                       extract($this->step_2_manage_upload());
+                       $data = $this->step_2_manage_upload();
+                       $attachment_id = $data['attachment_id'];
+                       $file = $data['file'];
+                       $url = $data['url'];
                }
 
                if ( file_exists( $file ) ) {
@@ -772,11 +792,11 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         *
         * @since 3.4.0
         */
-       function step_2_manage_upload() {
+       public function step_2_manage_upload() {
                $overrides = array('test_form' => false);
 
                $uploaded_file = $_FILES['import'];
-               $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'], false );
+               $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'] );
                if ( ! wp_match_mime_types( 'image', $wp_filetype['type'] ) )
                        wp_die( __( 'The uploaded file is not a valid image. Please try again.' ) );
 
@@ -809,14 +829,14 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         *
         * @since 2.1.0
         */
-       function step_3() {
+       public function step_3() {
                check_admin_referer( 'custom-header-crop-image' );
 
                if ( ! current_theme_supports( 'custom-header', 'uploads' ) )
-                       wp_die( __( 'Cheatin&#8217; uh?' ) );
+                       wp_die( __( 'Cheatin&#8217; uh?' ), 403 );
 
                if ( ! empty( $_POST['skip-cropping'] ) && ! ( current_theme_supports( 'custom-header', 'flex-height' ) || current_theme_supports( 'custom-header', 'flex-width' ) ) )
-                       wp_die( __( 'Cheatin&#8217; uh?' ) );
+                       wp_die( __( 'Cheatin&#8217; uh?' ), 403 );
 
                if ( $_POST['oitar'] > 1 ) {
                        $_POST['x1'] = $_POST['x1'] * $_POST['oitar'];
@@ -859,22 +879,14 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                $url = $object['guid'];
                $this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );
 
-               // cleanup
+               // Cleanup.
                $medium = str_replace( basename( $original ), 'midsize-' . basename( $original ), $original );
                if ( file_exists( $medium ) ) {
-                       /**
-                        * Filter the path of the file to delete.
-                        *
-                        * @since 2.1.0
-                        *
-                        * @param string $medium Path to the file to delete.
-                        */
-                       @unlink( apply_filters( 'wp_delete_file', $medium ) );
+                       wp_delete_file( $medium );
                }
 
                if ( empty( $_POST['create-new-attachment'] ) && empty( $_POST['skip-cropping'] ) ) {
-                       /** This filter is documented in wp-admin/custom-header.php */
-                       @unlink( apply_filters( 'wp_delete_file', $original ) );
+                       wp_delete_file( $original );
                }
 
                return $this->finished();
@@ -885,7 +897,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         *
         * @since 2.1.0
         */
-       function finished() {
+       public function finished() {
                $this->updated = true;
                $this->step_1();
        }
@@ -895,7 +907,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         *
         * @since 2.1.0
         */
-       function admin_page() {
+       public function admin_page() {
                if ( ! current_user_can('edit_theme_options') )
                        wp_die(__('You do not have permission to customize headers.'));
                $step = $this->step();
@@ -912,7 +924,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         *
         * @since 3.4.0
         */
-       function attachment_fields_to_edit( $form_fields ) {
+       public function attachment_fields_to_edit( $form_fields ) {
                return $form_fields;
        }
 
@@ -921,7 +933,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         *
         * @since 3.4.0
         */
-       function filter_upload_tabs( $tabs ) {
+       public function filter_upload_tabs( $tabs ) {
                return $tabs;
        }
 
@@ -1032,7 +1044,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                $has_flex_width = current_theme_supports( 'custom-header', 'flex-width' );
                $has_flex_height = current_theme_supports( 'custom-header', 'flex-height' );
                $has_max_width = current_theme_supports( 'custom-header', 'max-width' ) ;
-               $dst = array( 'dst_height' => null, 'dst_height' => null );
+               $dst = array( 'dst_height' => null, 'dst_width' => null );
 
                // For flex, limit size of image displayed to 1500px unless theme says otherwise
                if ( $has_flex_width ) {
@@ -1096,7 +1108,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
        }
 
        /**
-        * Insert an attachment & its metadata.
+        * Insert an attachment and its metadata.
         *
         * @param array $object Attachment object.
         * @param string $cropped Cropped image URL.
@@ -1107,8 +1119,13 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                $attachment_id = wp_insert_attachment( $object, $cropped );
                $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
                /**
-                * Allows us to insert custom meta data for an attachment.
+                * Filter the header image attachment metadata.
                 *
+                * @since 3.9.0
+                *
+                * @see wp_generate_attachment_metadata()
+                *
+                * @param array $metadata Attachment metadata.
                 */
                $metadata = apply_filters( 'wp_header_image_attachment_metadata', $metadata );
                wp_update_attachment_metadata( $attachment_id, $metadata );
@@ -1119,7 +1136,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         * Gets attachment uploaded by Media Manager, crops it, then saves it as a
         * new object. Returns JSON-encoded object details.
         */
-       function ajax_header_crop() {
+       public function ajax_header_crop() {
                check_ajax_referer( 'image_editor-' . $_POST['id'], 'nonce' );
 
                if ( ! current_user_can( 'edit_theme_options' ) ) {
@@ -1153,6 +1170,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                        wp_send_json_error( array( 'message' => __( 'Image could not be processed. Please go back and try again.' ) ) );
                }
 
+               /** This filter is documented in wp-admin/custom-header.php */
                $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication
 
                $object = $this->create_attachment_object( $cropped, $attachment_id );
@@ -1175,7 +1193,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         * Triggered when the user tries adds a new header image from the
         * Media Manager, even if s/he doesn't save that change.
         */
-       function ajax_header_add() {
+       public function ajax_header_add() {
                check_ajax_referer( 'header-add', 'nonce' );
 
                if ( ! current_user_can( 'edit_theme_options' ) ) {
@@ -1201,7 +1219,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         * Triggered when the user clicks the overlay "X" button next to each image
         * choice in the Customizer's Header tool.
         */
-       function ajax_header_remove() {
+       public function ajax_header_remove() {
                check_ajax_referer( 'header-remove', 'nonce' );
 
                if ( ! current_user_can( 'edit_theme_options' ) ) {
@@ -1220,7 +1238,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                wp_send_json_success();
        }
 
-       function customize_set_last_used( $wp_customize ) {
+       public function customize_set_last_used( $wp_customize ) {
                $data = $wp_customize->get_setting( 'header_image_data' )->post_value();
 
                if ( ! isset( $data['attachment_id'] ) ) {