WordPress 4.3
[autoinstalls/wordpress.git] / wp-admin / custom-header.php
index 0e5ffa6b382310cbcb70aa683497172294b68984..e61feb781c3bdd7f3c452103443f44b0eaf14887 100644 (file)
@@ -20,18 +20,16 @@ class Custom_Image_Header {
         *
         * @var callback
         * @since 2.1.0
-        * @access private
         */
-       private $admin_header_callback;
+       public $admin_header_callback;
 
        /**
         * Callback for header div.
         *
         * @var callback
         * @since 3.0.0
-        * @access private
         */
-       private $admin_image_div_callback;
+       public $admin_image_div_callback;
 
        /**
         * Holds default headers.
@@ -40,25 +38,7 @@ class Custom_Image_Header {
         * @since 3.0.0
         * @access private
         */
-       private $default_headers = array();
-
-       /**
-        * Holds custom headers uploaded by the user.
-        *
-        * @var array
-        * @since 3.2.0
-        * @access private
-        */
-       private $uploaded_headers = array();
-
-       /**
-        * Holds the page menu hook.
-        *
-        * @var string
-        * @since 3.0.0
-        * @access private
-        */
-       private $page = '';
+       public $default_headers = array();
 
        /**
         * @var bool
@@ -71,7 +51,6 @@ 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
         */
        public function __construct($admin_header_callback, $admin_image_div_callback = '') {
                $this->admin_header_callback = $admin_header_callback;
@@ -85,77 +64,25 @@ class Custom_Image_Header {
                add_action( 'wp_ajax_custom-header-remove', array( $this, 'ajax_header_remove'      ) );
        }
 
-       /**
-        * Make private properties readable for backwards compatibility.
-        *
-        * @since 4.0.0
-        * @access public
-        *
-        * @param string $name Property to get.
-        * @return mixed Property.
-        */
-       public function __get( $name ) {
-               return $this->$name;
-       }
-
-       /**
-        * Make private properties settable for backwards compatibility.
-        *
-        * @since 4.0.0
-        * @access public
-        *
-        * @param string $name  Property to set.
-        * @param mixed  $value Property value.
-        * @return mixed Newly-set property.
-        */
-       public function __set( $name, $value ) {
-               return $this->$name = $value;
-       }
-
-       /**
-        * Make private properties checkable for backwards compatibility.
-        *
-        * @since 4.0.0
-        * @access public
-        *
-        * @param string $name Property to check if set.
-        * @return bool Whether the property is set.
-        */
-       public function __isset( $name ) {
-               return isset( $this->$name );
-       }
-
-       /**
-        * Make private properties un-settable for backwards compatibility.
-        *
-        * @since 4.0.0
-        * @access public
-        *
-        * @param string $name Property to unset.
-        */
-       public function __unset( $name ) {
-               unset( $this->$name );
-       }
-
        /**
         * Set up the hooks for the Custom Header admin page.
         *
         * @since 2.1.0
         */
        public function init() {
-               if ( ! current_user_can('edit_theme_options') )
+               $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 );
+               }
        }
 
        /**
@@ -193,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>'
                );
        }
@@ -301,6 +228,8 @@ class Custom_Image_Header {
         * Process the default headers
         *
         * @since 3.0.0
+        *
+        * @global array $_wp_default_headers
         */
        public function process_default_headers() {
                global $_wp_default_headers;
@@ -340,7 +269,7 @@ class Custom_Image_Header {
                if ( 1 < count( $headers ) ) {
                        echo '<div class="random-header">';
                        echo '<label><input name="default-header" type="radio" value="random-' . $type . '-image"' . checked( is_random_header_image( $type ), true, false ) . ' />';
-                       echo __( '<strong>Random:</strong> Show a different image on each page.' );
+                       _e( '<strong>Random:</strong> Show a different image on each page.' );
                        echo '</label>';
                        echo '</div>';
                }
@@ -350,12 +279,13 @@ class Custom_Image_Header {
                        $header_thumbnail = $header['thumbnail_url'];
                        $header_url = $header['url'];
                        $header_desc = empty( $header['description'] ) ? '' : $header['description'];
+                       $header_alt_text = empty( $header['alt_text'] ) ? $header_desc : $header['alt_text'];
                        echo '<div class="default-header">';
                        echo '<label><input name="default-header" type="radio" value="' . esc_attr( $header_key ) . '" ' . checked( $header_url, get_theme_mod( 'header_image' ), false ) . ' />';
                        $width = '';
                        if ( !empty( $header['attachment_id'] ) )
                                $width = ' width="230"';
-                       echo '<img src="' . set_url_scheme( $header_thumbnail ) . '" alt="' . esc_attr( $header_desc ) .'" title="' . esc_attr( $header_desc ) . '"' . $width . ' /></label>';
+                       echo '<img src="' . set_url_scheme( $header_thumbnail ) . '" alt="' . esc_attr( $header_alt_text ) .'" title="' . esc_attr( $header_desc ) . '"' . $width . ' /></label>';
                        echo '</div>';
                }
                echo '<div class="clear"></div></div>';
@@ -388,9 +318,7 @@ class Custom_Image_Header {
                        }
                }
                ?>
-
 <script type="text/javascript">
-/* <![CDATA[ */
 (function($){
        var default_color = '<?php echo $default_color; ?>',
                header_text_fields;
@@ -433,7 +361,6 @@ class Custom_Image_Header {
                <?php endif; ?>
        });
 })(jQuery);
-/* ]]> */
 </script>
 <?php
        }
@@ -445,7 +372,6 @@ class Custom_Image_Header {
         */
        public function js_2() { ?>
 <script type="text/javascript">
-/* <![CDATA[ */
        function onEndCrop( coords ) {
                jQuery( '#x1' ).val(coords.x);
                jQuery( '#y1' ).val(coords.y);
@@ -507,7 +433,6 @@ class Custom_Image_Header {
                        }
                });
        });
-/* ]]> */
 </script>
 <?php
        }
@@ -522,7 +447,7 @@ class Custom_Image_Header {
 ?>
 
 <div class="wrap">
-<h2><?php _e( 'Custom Header' ); ?></h2>
+<h1><?php _e( 'Custom Header' ); ?></h1>
 
 <?php if ( current_user_can( 'customize' ) ) { ?>
 <div class="notice notice-info hide-if-no-customize">
@@ -557,7 +482,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 )
@@ -578,7 +510,7 @@ class Custom_Image_Header {
 </tr>
 <?php endif; ?>
 
-<?php if ( current_theme_supports( 'custom-header', 'uploads' ) ) : ?>
+<?php if ( current_user_can( 'upload_files' ) && current_theme_supports( 'custom-header', 'uploads' ) ) : ?>
 <tr>
 <th scope="row"><?php _e( 'Select Image' ); ?></th>
 <td>
@@ -823,11 +755,11 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                ?>
 
 <div class="wrap">
-<h2><?php _e( 'Crop Header Image' ); ?></h2>
+<h1><?php _e( 'Crop Header Image' ); ?></h1>
 
 <form method="post" action="<?php echo esc_url(add_query_arg('step', 3)); ?>">
        <p class="hide-if-no-js"><?php _e('Choose the part of the image you want to use as your header.'); ?></p>
-       <p class="hide-if-js"><strong><?php _e( 'You need Javascript to choose a part of the image.'); ?></strong></p>
+       <p class="hide-if-js"><strong><?php _e( 'You need JavaScript to choose a part of the image.'); ?></strong></p>
 
        <div id="crop_image" style="position: relative">
                <img src="<?php echo esc_url( $url ); ?>" id="upload" width="<?php echo $width; ?>" height="<?php echo $height; ?>" />
@@ -866,7 +798,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                $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.' ) );
 
@@ -952,19 +884,11 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                // 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();
@@ -1001,6 +925,9 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         * Unused since 3.5.0.
         *
         * @since 3.4.0
+        *
+        * @param array $form_fields
+        * @return array $form_fields
         */
        public function attachment_fields_to_edit( $form_fields ) {
                return $form_fields;
@@ -1010,6 +937,9 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         * Unused since 3.5.0.
         *
         * @since 3.4.0
+        *
+        * @param array $tabs
+        * @return array $tabs
         */
        public function filter_upload_tabs( $tabs ) {
                return $tabs;
@@ -1026,6 +956,8 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         *  Or an array of arguments: attachment_id, url, width, height. All are required.
         *
         * @since 3.4.0
+        *
+        * @param array|object|string $choice
         */
        final public function set_header_image( $choice ) {
                if ( is_array( $choice ) || is_object( $choice ) ) {
@@ -1077,7 +1009,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
         * @since 3.4.0
         */
        final public function remove_header_image() {
-               return $this->set_header_image( 'remove-header' );
+               $this->set_header_image( 'remove-header' );
        }
 
        /**
@@ -1091,9 +1023,10 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                $this->process_default_headers();
                $default = get_theme_support( 'custom-header', 'default-image' );
 
-               if ( ! $default )
-                       return $this->remove_header_image();
-
+               if ( ! $default ) {
+                       $this->remove_header_image();
+                       return;
+               }
                $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
 
                $default_data = array();
@@ -1111,6 +1044,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
        /**
         * Calculate width and height based on what the currently selected theme supports.
         *
+        * @param array $dimensions
         * @return array dst_height and dst_width of header image.
         */
        final public function get_header_dimensions( $dimensions ) {
@@ -1160,8 +1094,8 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
        /**
         * Create an attachment 'object'.
         *
-        * @param string $cropped Cropped image URL.
-        * @param int $parent_attachment_id Attachment ID of parent image.
+        * @param string $cropped              Cropped image URL.
+        * @param int    $parent_attachment_id Attachment ID of parent image.
         *
         * @return array Attachment object.
         */
@@ -1188,7 +1122,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
        /**
         * Insert an attachment and its metadata.
         *
-        * @param array $object Attachment object.
+        * @param array  $object  Attachment object.
         * @param string $cropped Cropped image URL.
         *
         * @return int Attachment ID.
@@ -1316,6 +1250,10 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                wp_send_json_success();
        }
 
+       /**
+        *
+        * @param WP_Customize_Manager $wp_customize
+        */
        public function customize_set_last_used( $wp_customize ) {
                $data = $wp_customize->get_setting( 'header_image_data' )->post_value();
 
@@ -1328,6 +1266,10 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                update_post_meta( $attachment_id, $key, time() );
        }
 
+       /**
+        *
+        * @return array
+        */
        public function get_default_header_images() {
                $this->process_default_headers();
 
@@ -1361,10 +1303,13 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
                );
 
                // The rest of the set comes after.
-               $header_images = array_merge( $header_images, $this->default_headers );
-               return $header_images;
+               return array_merge( $header_images, $this->default_headers );
        }
 
+       /**
+        *
+        * @return array
+        */
        public function get_uploaded_header_images() {
                $header_images = get_uploaded_header_images();
                $timestamp_key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();