X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..a7cd4c052013b423c6301153f68c7fdbaa2a447b:/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 e96f3865..b033203e 100644 --- a/wp-includes/class-wp-customize-section.php +++ b/wp-includes/class-wp-customize-section.php @@ -10,6 +10,26 @@ */ class WP_Customize_Section { + /** + * Incremented with each new class instantiation, then stored in $instance_number. + * + * Used when sorting two instances whose priorities are equal. + * + * @since 4.1.0 + * @access protected + * @var int + */ + protected static $instance_count = 0; + + /** + * Order in which this instance was created in relation to other instances. + * + * @since 4.1.0 + * @access public + * @var int + */ + public $instance_number; + /** * WP_Customize_Manager instance. * @@ -35,7 +55,16 @@ class WP_Customize_Section { * @access public * @var integer */ - public $priority = 10; + public $priority = 160; + + /** + * Panel in which to show the section, making it a sub-section. + * + * @since 4.0.0 + * @access public + * @var string + */ + public $panel = ''; /** * Capability required for the section. @@ -82,6 +111,30 @@ class WP_Customize_Section { */ public $controls; + /** + * Type of this section. + * + * @since 4.1.0 + * @access public + * @var string + */ + public $type = 'default'; + + /** + * Active callback. + * + * @since 4.1.0 + * @access public + * + * @see WP_Customize_Section::active() + * + * @var callable Callback is called with one argument, the instance of + * {@see WP_Customize_Section}, and returns bool to indicate + * whether the section is active (such as it relates to the URL + * currently being previewed). + */ + public $active_callback = ''; + /** * Constructor. * @@ -93,21 +146,82 @@ class WP_Customize_Section { * @param string $id An specific ID of the section. * @param array $args Section arguments. */ - function __construct( $manager, $id, $args = array() ) { - $keys = array_keys( get_class_vars( __CLASS__ ) ); + public function __construct( $manager, $id, $args = array() ) { + $keys = array_keys( get_object_vars( $this ) ); foreach ( $keys as $key ) { - if ( isset( $args[ $key ] ) ) + if ( isset( $args[ $key ] ) ) { $this->$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. return $this; } + /** + * 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. + */ + public final function active() { + $section = $this; + $active = call_user_func( $this->active_callback, $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; + } + + /** + * 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 bool 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( 'title', 'description', 'priority', 'panel', 'type' ) ); + $array['content'] = $this->get_content(); + $array['active'] = $this->active(); + $array['instanceNumber'] = $this->instance_number; + return $array; + } + /** * Checks required user capabilities and whether the theme has the * feature support required by the section. @@ -117,23 +231,41 @@ class WP_Customize_Section { * @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 ) ) + 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 template for insertion into the Customizer pane. + * + * @since 4.1.0 + * + * @return string Contents of the section. + */ + public final function get_content() { + ob_start(); + $this->maybe_render(); + $template = trim( ob_get_contents() ); + ob_end_clean(); + return $template; + } + /** * Check capabilities and render the section. * * @since 3.4.0 */ public final function maybe_render() { - if ( ! $this->check_capabilities() ) + if ( ! $this->check_capabilities() ) { return; + } /** * Fires before rendering a Customizer section. @@ -146,7 +278,7 @@ class WP_Customize_Section { /** * Fires before rendering a specific Customizer section. * - * The dynamic portion of the hook name, $this->id, refers to the ID + * 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 @@ -162,19 +294,77 @@ class WP_Customize_Section { * @since 3.4.0 */ protected function render() { + $classes = 'accordion-section control-section control-section-' . $this->type; ?> -
  • -

    title ); ?>

    +
  • +

    + title ); ?> + +

    • 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 ); + } +}