X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7f1521bf193b382565eb753043c161f4cb3fcda7..784f914b1e4b1c62d6657e86397c2e83bcee4295:/wp-includes/class-wp-customize-control.php diff --git a/wp-includes/class-wp-customize-control.php b/wp-includes/class-wp-customize-control.php index bf17fb20..52a8a91e 100644 --- a/wp-includes/class-wp-customize-control.php +++ b/wp-includes/class-wp-customize-control.php @@ -20,6 +20,8 @@ class WP_Customize_Control { * Used when sorting two instances whose priorities are equal. * * @since 4.1.0 + * + * @static * @access protected * @var int */ @@ -62,6 +64,18 @@ class WP_Customize_Control { */ public $setting = 'default'; + /** + * Capability required to use this control. + * + * Normally this is empty and the capability is derived from the capabilities + * of the associated `$settings`. + * + * @since 4.5.0 + * @access public + * @var string + */ + public $capability; + /** * @access public * @var int @@ -131,15 +145,42 @@ class WP_Customize_Control { /** * Constructor. * - * Supplied $args override class property defaults. + * Supplied `$args` override class property defaults. * - * If $args['settings'] is not defined, use the $id as the setting ID. + * If `$args['settings']` is not defined, use the $id as the setting ID. * * @since 3.4.0 * - * @param WP_Customize_Manager $manager - * @param string $id - * @param array $args + * @param WP_Customize_Manager $manager Customizer bootstrap instance. + * @param string $id Control ID. + * @param array $args { + * Optional. Arguments to override class property defaults. + * + * @type int $instance_number Order in which this instance was created in relation + * to other instances. + * @type WP_Customize_Manager $manager Customizer bootstrap instance. + * @type string $id Control ID. + * @type array $settings All settings tied to the control. If undefined, `$id` will + * be used. + * @type string $setting The primary setting for the control (if there is one). + * Default 'default'. + * @type int $priority Order priority to load the control. Default 10. + * @type string $section Section the control belongs to. Default empty. + * @type string $label Label for the control. Default empty. + * @type string $description Description for the control. Default empty. + * @type array $choices List of choices for 'radio' or 'select' type controls, where + * values are the keys, and labels are the values. + * Default empty array. + * @type array $input_attrs List of custom input attributes for control output, where + * attribute names are the keys and values are the values. Not + * used for 'checkbox', 'radio', 'select', 'textarea', or + * 'dropdown-pages' control types. Default empty array. + * @type array $json Deprecated. Use {@see WP_Customize_Control->json()} instead. + * @type string $type Control type. Core controls include 'text', 'checkbox', + * 'textarea', 'radio', 'select', and 'dropdown-pages'. Additional + * input types such as 'email', 'url', 'number', 'hidden', and + * 'date' are supported implicitly. Default 'text'. + * } */ public function __construct( $manager, $id, $args = array() ) { $keys = array_keys( get_object_vars( $this ) ); @@ -158,7 +199,7 @@ class WP_Customize_Control { $this->instance_number = self::$instance_count; // Process settings. - if ( empty( $this->settings ) ) { + if ( ! isset( $this->settings ) ) { $this->settings = $id; } @@ -167,7 +208,7 @@ class WP_Customize_Control { foreach ( $this->settings as $key => $setting ) { $settings[ $key ] = $this->manager->get_setting( $setting ); } - } else { + } else if ( is_string( $this->settings ) ) { $this->setting = $this->manager->get_setting( $this->settings ); $settings['default'] = $this->setting; } @@ -215,7 +256,7 @@ class WP_Customize_Control { * @since 4.0.0 * @access public * - * @return bool Always true. + * @return true Always true. */ public function active_callback() { return true; @@ -270,21 +311,32 @@ class WP_Customize_Control { } /** - * Check if the theme supports the control and check user capabilities. + * Checks if the user can use this control. + * + * Returns false if the user cannot manipulate one of the associated settings, + * or if one of the associated settings does not exist. Also returns false if + * the associated section does not exist or if its capability check returns + * false. * * @since 3.4.0 * * @return bool False if theme doesn't support the control or user doesn't have the required permissions, otherwise true. */ final public function check_capabilities() { + if ( ! empty( $this->capability ) && ! current_user_can( $this->capability ) ) { + return false; + } + foreach ( $this->settings as $setting ) { - if ( ! $setting->check_capabilities() ) + if ( ! $setting || ! $setting->check_capabilities() ) { return false; + } } $section = $this->manager->get_section( $this->section ); - if ( isset( $section ) && ! $section->check_capabilities() ) + if ( isset( $section ) && ! $section->check_capabilities() ) { return false; + } return true; } @@ -299,9 +351,7 @@ class WP_Customize_Control { final public function get_content() { ob_start(); $this->maybe_render(); - $template = trim( ob_get_contents() ); - ob_end_clean(); - return $template; + return trim( ob_get_clean() ); } /** @@ -344,7 +394,7 @@ class WP_Customize_Control { * @since 3.4.0 */ protected function render() { - $id = 'customize-control-' . str_replace( '[', '-', str_replace( ']', '', $this->id ) ); + $id = 'customize-control-' . str_replace( array( '[', ']' ), array( '-', '' ), $this->id ); $class = 'customize-control customize-control-' . $this->type; ?>
  • @@ -386,7 +436,7 @@ class WP_Customize_Control { * @access public */ public function input_attrs() { - foreach( $this->input_attrs as $attr => $value ) { + foreach ( $this->input_attrs as $attr => $value ) { echo $attr . '="' . esc_attr( $value ) . '" '; } } @@ -474,7 +524,16 @@ class WP_Customize_Control { + + @@ -542,837 +599,53 @@ class WP_Customize_Control { } -/** - * Customize Color Control class. - * - * @since 3.4.0 - * - * @see WP_Customize_Control - */ -class WP_Customize_Color_Control extends WP_Customize_Control { - /** - * @access public - * @var string - */ - public $type = 'color'; +/** WP_Customize_Color_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php' ); - /** - * @access public - * @var array - */ - public $statuses; +/** WP_Customize_Media_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php' ); - /** - * Constructor. - * - * @since 3.4.0 - * @uses WP_Customize_Control::__construct() - * - * @param WP_Customize_Manager $manager - * @param string $id - * @param array $args - */ - public function __construct( $manager, $id, $args = array() ) { - $this->statuses = array( '' => __('Default') ); - parent::__construct( $manager, $id, $args ); - } +/** WP_Customize_Upload_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php' ); - /** - * Enqueue scripts/styles for the color picker. - * - * @since 3.4.0 - */ - public function enqueue() { - wp_enqueue_script( 'wp-color-picker' ); - wp_enqueue_style( 'wp-color-picker' ); - } +/** WP_Customize_Image_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php' ); - /** - * Refresh the parameters passed to the JavaScript via JSON. - * - * @since 3.4.0 - * @uses WP_Customize_Control::to_json() - */ - public function to_json() { - parent::to_json(); - $this->json['statuses'] = $this->statuses; - $this->json['defaultValue'] = $this->setting->default; - } +/** WP_Customize_Background_Image_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php' ); - /** - * Don't render the control content from PHP, as it's rendered via JS on load. - * - * @since 3.4.0 - */ - public function render_content() {} +/** WP_Customize_Cropped_Image_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php' ); - /** - * Render a JS template for the content of the color picker control. - * - * @since 4.1.0 - */ - public function content_template() { - ?> - <# var defaultValue = ''; - if ( data.defaultValue ) { - if ( '#' !== data.defaultValue.substring( 0, 1 ) ) { - defaultValue = '#' + data.defaultValue; - } else { - defaultValue = data.defaultValue; - } - defaultValue = ' data-default-color=' + defaultValue; // Quotes added automatically. - } #> - - button_labels = array( - 'select' => __( 'Select File' ), - 'change' => __( 'Change File' ), - 'default' => __( 'Default' ), - 'remove' => __( 'Remove' ), - 'placeholder' => __( 'No file selected' ), - 'frame_title' => __( 'Select File' ), - 'frame_button' => __( 'Choose File' ), - ); - } - - /** - * Enqueue control related scripts/styles. - * - * @since 3.4.0 - * @since 4.2.0 Moved from WP_Customize_Upload_Control. - */ - public function enqueue() { - wp_enqueue_media(); - } - - /** - * Refresh the parameters passed to the JavaScript via JSON. - * - * @since 3.4.0 - * @since 4.2.0 Moved from WP_Customize_Upload_Control. - * - * @see WP_Customize_Control::to_json() - */ - public function to_json() { - parent::to_json(); - $this->json['mime_type'] = $this->mime_type; - $this->json['button_labels'] = $this->button_labels; - - $value = $this->value(); - - if ( is_object( $this->setting ) ) { - if ( $this->setting->default ) { - // Fake an attachment model - needs all fields used by template. - // Note that the default value must be a URL, NOT an attachment ID. - $type = in_array( substr( $this->setting->default, -3 ), array( 'jpg', 'png', 'gif', 'bmp' ) ) ? 'image' : 'document'; - $default_attachment = array( - 'id' => 1, - 'url' => $this->setting->default, - 'type' => $type, - 'icon' => wp_mime_type_icon( $type ), - 'title' => basename( $this->setting->default ), - ); +/** WP_Customize_Theme_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php' ); - if ( 'image' === $type ) { - $default_attachment['sizes'] = array( - 'full' => array( 'url' => $this->setting->default ), - ); - } +/** WP_Widget_Area_Customize_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php' ); - $this->json['defaultAttachment'] = $default_attachment; - } - - if ( $value && $this->setting->default && $value === $this->setting->default ) { - // Set the default as the attachment. - $this->json['attachment'] = $this->json['defaultAttachment']; - } elseif ( $value ) { - $this->json['attachment'] = wp_prepare_attachment_for_js( $value ); - } - } - } +/** WP_Widget_Form_Customize_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php' ); - /** - * Don't render any content for this control from PHP. - * - * @since 3.4.0 - * @since 4.2.0 Moved from WP_Customize_Upload_Control. - * - * @see WP_Customize_Media_Control::content_template() - */ - public function render_content() {} +/** WP_Customize_Nav_Menu_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php' ); - /** - * Render a JS template for the content of the media control. - * - * @since 4.1.0 - * @since 4.2.0 Moved from WP_Customize_Upload_Control. - */ - public function content_template() { - ?> - - - <# if ( data.attachment && data.attachment.id ) { #> -
    -
    -
    -
    - <# if ( 'image' === data.attachment.type && data.attachment.sizes && data.attachment.sizes.medium ) { #> - - <# } else if ( 'image' === data.attachment.type && data.attachment.sizes && data.attachment.sizes.full ) { #> - - <# } else if ( 'audio' === data.attachment.type ) { #> - <# if ( data.attachment.image && data.attachment.image.src && data.attachment.image.src !== data.attachment.icon ) { #> - - <# } else { #> - - <# } #> -

    “{{ data.attachment.title }}”

    - <# if ( data.attachment.album || data.attachment.meta.album ) { #> -

    {{ data.attachment.album || data.attachment.meta.album }}

    - <# } #> - <# if ( data.attachment.artist || data.attachment.meta.artist ) { #> -

    {{ data.attachment.artist || data.attachment.meta.artist }}

    - <# } #> - - <# } else if ( 'video' === data.attachment.type ) { #> -
    - -
    - <# } else { #> - -

    {{ data.attachment.title }}

    - <# } #> -
    -
    -
    -
    -
    - - -
    -
    - <# } else { #> -
    -
    -
    -
    - - button_labels['placeholder']; ?> - -
    -
    -
    -
    -
    - <# if ( data.defaultAttachment ) { #> - - <# } #> - -
    -
    - <# } #> - value(); - if ( $value ) { - // Get the attachment model for the existing file. - $attachment_id = attachment_url_to_postid( $value ); - if ( $attachment_id ) { - $this->json['attachment'] = wp_prepare_attachment_for_js( $attachment_id ); - } - } - } -} +/** WP_Customize_Nav_Menu_Name_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php' ); -/** - * Customize Image Control class. - * - * @since 3.4.0 - * - * @see WP_Customize_Upload_Control - */ -class WP_Customize_Image_Control extends WP_Customize_Upload_Control { - public $type = 'image'; - public $mime_type = 'image'; +/** WP_Customize_Nav_Menu_Auto_Add_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php' ); - /** - * Constructor. - * - * @since 3.4.0 - * @uses WP_Customize_Upload_Control::__construct() - * - * @param WP_Customize_Manager $manager - * @param string $id - * @param array $args - */ - public function __construct( $manager, $id, $args = array() ) { - parent::__construct( $manager, $id, $args ); - - $this->button_labels = array( - 'select' => __( 'Select Image' ), - 'change' => __( 'Change Image' ), - 'remove' => __( 'Remove' ), - 'default' => __( 'Default' ), - 'placeholder' => __( 'No image selected' ), - 'frame_title' => __( 'Select Image' ), - 'frame_button' => __( 'Choose Image' ), - ); - } - - /** - * @since 3.4.2 - * @deprecated 4.1.0 - */ - public function prepare_control() {} - - /** - * @since 3.4.0 - * @deprecated 4.1.0 - * - * @param string $id - * @param string $label - * @param mixed $callback - */ - public function add_tab( $id, $label, $callback ) {} - - /** - * @since 3.4.0 - * @deprecated 4.1.0 - * - * @param string $id - */ - public function remove_tab( $id ) {} - - /** - * @since 3.4.0 - * @deprecated 4.1.0 - * - * @param string $url - * @param string $thumbnail_url - */ - public function print_tab_image( $url, $thumbnail_url = null ) {} -} - -/** - * Customize Background Image Control class. - * - * @since 3.4.0 - * - * @see WP_Customize_Image_Control - */ -class WP_Customize_Background_Image_Control extends WP_Customize_Image_Control { - public $type = 'background'; - - /** - * Constructor. - * - * @since 3.4.0 - * @uses WP_Customize_Image_Control::__construct() - * - * @param WP_Customize_Manager $manager - */ - public function __construct( $manager ) { - parent::__construct( $manager, 'background_image', array( - 'label' => __( 'Background Image' ), - 'section' => 'background_image', - ) ); - } - - /** - * Enqueue control related scripts/styles. - * - * @since 4.1.0 - */ - public function enqueue() { - parent::enqueue(); - - wp_localize_script( 'customize-controls', '_wpCustomizeBackground', array( - 'nonces' => array( - 'add' => wp_create_nonce( 'background-add' ), - ), - ) ); - } -} - -/** - * Customize Header Image Control class. - * - * @since 3.4.0 - * - * @see WP_Customize_Image_Control - */ -class WP_Customize_Header_Image_Control extends WP_Customize_Image_Control { - public $type = 'header'; - public $uploaded_headers; - public $default_headers; - - /** - * @param WP_Customize_Manager $manager - */ - public function __construct( $manager ) { - parent::__construct( $manager, 'header_image', array( - 'label' => __( 'Header Image' ), - 'settings' => array( - 'default' => 'header_image', - 'data' => 'header_image_data', - ), - 'section' => 'header_image', - 'removed' => 'remove-header', - 'get_url' => 'get_header_image', - ) ); - - } - - public function enqueue() { - wp_enqueue_media(); - wp_enqueue_script( 'customize-views' ); - - $this->prepare_control(); - - wp_localize_script( 'customize-views', '_wpCustomizeHeader', array( - 'data' => array( - 'width' => absint( get_theme_support( 'custom-header', 'width' ) ), - 'height' => absint( get_theme_support( 'custom-header', 'height' ) ), - 'flex-width' => absint( get_theme_support( 'custom-header', 'flex-width' ) ), - 'flex-height' => absint( get_theme_support( 'custom-header', 'flex-height' ) ), - 'currentImgSrc' => $this->get_current_image_src(), - ), - 'nonces' => array( - 'add' => wp_create_nonce( 'header-add' ), - 'remove' => wp_create_nonce( 'header-remove' ), - ), - 'uploads' => $this->uploaded_headers, - 'defaults' => $this->default_headers - ) ); - - parent::enqueue(); - } - - public function prepare_control() { - global $custom_image_header; - if ( empty( $custom_image_header ) ) { - return; - } - - // Process default headers and uploaded headers. - $custom_image_header->process_default_headers(); - $this->default_headers = $custom_image_header->get_default_header_images(); - $this->uploaded_headers = $custom_image_header->get_uploaded_header_images(); - } - - public function print_header_image_template() { - ?> - - - - value(); - if ( isset( $this->get_url ) ) { - $src = call_user_func( $this->get_url, $src ); - return $src; - } - return null; - } - - public function render_content() { - $this->print_header_image_template(); - $visibility = $this->get_current_image_src() ? '' : ' style="display:none" '; - $width = absint( get_theme_support( 'custom-header', 'width' ) ); - $height = absint( get_theme_support( 'custom-header', 'height' ) ); - ?> - - -
    -

    - Add new image, your theme recommends a header size of %s × %s pixels.' ), $width, $height ); - } elseif ( $width ) { - printf( __( 'While you can crop images to your liking after clicking Add new image, your theme recommends a header width of %s pixels.' ), $width ); - } else { - printf( __( 'While you can crop images to your liking after clicking Add new image, your theme recommends a header height of %s pixels.' ), $height ); - } - ?> -

    -
    - - - -
    -
    -
    -
    - - - - -
    -
    -
    - - - -
    -
    -
    -
    - - - -
    -
    -
    -
    -
    -
    - json['theme'] = $this->theme; - } - - /** - * Don't render the control content from PHP, as it's rendered via JS on load. - * - * @since 4.2.0 - * @access public - */ - public function render_content() {} - - /** - * Render a JS template for theme display. - * - * @since 4.2.0 - * @access public - */ - public function content_template() { - $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); - $active_url = esc_url( remove_query_arg( 'theme', $current_url ) ); - $preview_url = esc_url( add_query_arg( 'theme', '__THEME__', $current_url ) ); // Token because esc_url() strips curly braces. - $preview_url = str_replace( '__THEME__', '{{ data.theme.id }}', $preview_url ); - ?> - <# if ( data.theme.isActiveTheme ) { #> -
    - <# } else { #> -
    - <# } #> - - <# if ( data.theme.screenshot[0] ) { #> -
    - -
    - <# } else { #> -
    - <# } #> - - <# if ( data.theme.isActiveTheme ) { #> - - <# } else { #> - - <# } #> - -
    - - <# if ( data.theme.isActiveTheme ) { #> -

    - Active: %s' ), '{{ data.theme.name }}' ); - ?> -

    - <# } else { #> -

    {{ data.theme.name }}

    -
    - -
    - <# } #> -
    - json[ $key ] = $this->$key; - } - } - - public function render_content() { - ?> - - - - - - - - - json[ $key ] = $this->$key; - } - } - - public function render_content() { - global $wp_registered_widgets; - require_once ABSPATH . '/wp-admin/includes/widgets.php'; - - $widget = $wp_registered_widgets[ $this->widget_id ]; - if ( ! isset( $widget['params'][0] ) ) { - $widget['params'][0] = array(); - } - - $args = array( - 'widget_id' => $widget['id'], - 'widget_name' => $widget['name'], - ); - - $args = wp_list_widget_controls_dynamic_sidebar( array( 0 => $args, 1 => $widget['params'][0] ) ); - echo $this->manager->widgets->get_widget_control( $args ); - } - - /** - * Whether the current widget is rendered on the page. - * - * @since 4.0.0 - * @access public - * - * @return bool Whether the widget is rendered. - */ - public function active_callback() { - return $this->manager->widgets->is_widget_rendered( $this->widget_id ); - } -} +/** WP_Customize_New_Menu_Control class */ +require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-control.php' );