X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/8f374b7233bc2815ccc387e448d208c5434eb961..refs/tags/wordpress-4.3:/wp-includes/class-wp-customize-section.php diff --git a/wp-includes/class-wp-customize-section.php b/wp-includes/class-wp-customize-section.php index b1b7d5f8..7f2d52c6 100644 --- a/wp-includes/class-wp-customize-section.php +++ b/wp-includes/class-wp-customize-section.php @@ -1,93 +1,576 @@ $key = $args[ $key ]; + } } $this->manager = $manager; $this->id = $id; + if ( empty( $this->active_callback ) ) { + $this->active_callback = array( $this, 'active_callback' ); + } + self::$instance_count += 1; + $this->instance_number = self::$instance_count; $this->controls = array(); // Users cannot customize the $controls array. + } + + /** + * Check whether section is active to current Customizer preview. + * + * @since 4.1.0 + * @access public + * + * @return bool Whether the section is active to the current preview. + */ + final public function active() { + $section = $this; + $active = call_user_func( $this->active_callback, $this ); - return $this; + /** + * Filter response of {@see WP_Customize_Section::active()}. + * + * @since 4.1.0 + * + * @param bool $active Whether the Customizer section is active. + * @param WP_Customize_Section $section {@see WP_Customize_Section} instance. + */ + $active = apply_filters( 'customize_section_active', $active, $section ); + + return $active; } /** - * Check if the theme supports the section and check user capabilities. + * Default callback used when invoking {@see WP_Customize_Section::active()}. + * + * Subclasses can override this with their specific logic, or they may provide + * an 'active_callback' argument to the constructor. + * + * @since 4.1.0 + * @access public + * + * @return true Always true. + */ + public function active_callback() { + return true; + } + + /** + * Gather the parameters passed to client JavaScript via JSON. + * + * @since 4.1.0 + * + * @return array The array to be exported to the client as JSON. + */ + public function json() { + $array = wp_array_slice_assoc( (array) $this, array( 'id', 'description', 'priority', 'panel', 'type' ) ); + $array['title'] = html_entity_decode( $this->title, ENT_QUOTES, get_bloginfo( 'charset' ) ); + $array['content'] = $this->get_content(); + $array['active'] = $this->active(); + $array['instanceNumber'] = $this->instance_number; + + if ( $this->panel ) { + /* translators: ▸ is the unicode right-pointing triangle, and %s is the section title in the Customizer */ + $array['customizeAction'] = sprintf( __( 'Customizing ▸ %s' ), esc_html( $this->manager->get_panel( $this->panel )->title ) ); + } else { + $array['customizeAction'] = __( 'Customizing' ); + } + + return $array; + } + + /** + * Checks required user capabilities and whether the theme has the + * feature support required by the section. * * @since 3.4.0 * * @return bool False if theme doesn't support the section or user doesn't have the capability. */ - public final function check_capabilities() { - if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) ) + final public function check_capabilities() { + if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) ) { return false; + } - if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) ) + if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) ) { return false; + } return true; } + /** + * Get the section's content for insertion into the Customizer pane. + * + * @since 4.1.0 + * + * @return string Contents of the section. + */ + final public function get_content() { + ob_start(); + $this->maybe_render(); + return trim( ob_get_clean() ); + } + /** * Check capabilities and render the section. * * @since 3.4.0 */ - public final function maybe_render() { - if ( ! $this->check_capabilities() ) + final public function maybe_render() { + if ( ! $this->check_capabilities() ) { return; + } + /** + * Fires before rendering a Customizer section. + * + * @since 3.4.0 + * + * @param WP_Customize_Section $this WP_Customize_Section instance. + */ do_action( 'customize_render_section', $this ); - do_action( 'customize_render_section_' . $this->id ); + /** + * Fires before rendering a specific Customizer section. + * + * The dynamic portion of the hook name, `$this->id`, refers to the ID + * of the specific Customizer section to be rendered. + * + * @since 3.4.0 + */ + do_action( "customize_render_section_{$this->id}" ); $this->render(); } - /** - * Render the section. + * Render the section UI in a subclass. + * + * Sections are now rendered in JS by default, see {@see WP_Customize_Section::print_template()}. * * @since 3.4.0 */ + protected function render() {} + + /** + * Render the section's JS template. + * + * This function is only run for section types that have been registered with + * WP_Customize_Manager::register_section_type(). + * + * @since 4.3.0 + * @access public + * + * @see WP_Customize_Manager::render_template() + */ + public function print_template() { + ?> + + +
  • +

    + {{ data.title }} + +

    + +
    • + type; ?> -
  • -

    title ); ?>

    - + + + +
    +

    + + + controls ) + 1 /* Active theme */; ?> +

    +

    + manager->is_theme_active() ) { + echo '' . __( 'Active theme' ) . ' ' . $this->title; + } else { + echo '' . __( 'Previewing theme' ) . ' ' . $this->title; + } + ?> + +

    + + + +
    + controls ) > 4 ) : ?> +

    + +
    +
      +
    +
    +
    +
    • +sidebar_id; + return $json; + } + + /** + * Whether the current sidebar is rendered on the page. + * + * @since 4.1.0 + * @access public + * + * @return bool Whether sidebar is rendered. + */ + public function active_callback() { + return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id ); + } +} + +/** + * Customize Menu Section Class + * + * Custom section only needed in JS. + * + * @since 4.3.0 + * + * @see WP_Customize_Section + */ +class WP_Customize_Nav_Menu_Section extends WP_Customize_Section { + + /** + * Control type. + * + * @since 4.3.0 + * @access public + * @var string + */ + public $type = 'nav_menu'; + + /** + * Get section parameters for JS. + * + * @since 4.3.0 + * @access public + * @return array Exported parameters. + */ + public function json() { + $exported = parent::json(); + $exported['menu_id'] = intval( preg_replace( '/^nav_menu\[(\d+)\]/', '$1', $this->id ) ); + + return $exported; + } +} + +/** + * Customize Menu Section Class + * + * Implements the new-menu-ui toggle button instead of a regular section. + * + * @since 4.3.0 + * + * @see WP_Customize_Section + */ +class WP_Customize_New_Menu_Section extends WP_Customize_Section { + + /** + * Control type. + * + * @since 4.3.0 + * @access public + * @var string + */ + public $type = 'new_menu'; + + /** + * Render the section, and the controls that have been added to it. + * + * @since 4.3.0 + * @access protected + */ + protected function render() { + ?> +
  • + +