X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..refs/tags/wordpress-4.3:/wp-includes/class-wp-customize-panel.php?ds=sidebyside diff --git a/wp-includes/class-wp-customize-panel.php b/wp-includes/class-wp-customize-panel.php index 8f85049d..3857d507 100644 --- a/wp-includes/class-wp-customize-panel.php +++ b/wp-includes/class-wp-customize-panel.php @@ -1,15 +1,46 @@ 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->sections = array(); // Users cannot customize the $sections array. + } + + /** + * Check whether panel is active to current Customizer preview. + * + * @since 4.1.0 + * @access public + * + * @return bool Whether the panel is active to the current preview. + */ + final public function active() { + $panel = $this; + $active = call_user_func( $this->active_callback, $this ); + + /** + * Filter response of WP_Customize_Panel::active(). + * + * @since 4.1.0 + * + * @param bool $active Whether the Customizer panel is active. + * @param WP_Customize_Panel $panel {@see WP_Customize_Panel} instance. + */ + $active = apply_filters( 'customize_panel_active', $active, $panel ); - return $this; + return $active; + } + + /** + * Default callback used when invoking {@see WP_Customize_Panel::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( 'id', 'description', 'priority', '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; + return $array; } /** @@ -117,7 +231,7 @@ class WP_Customize_Panel { * * @return bool False if theme doesn't support the panel or the user doesn't have the capability. */ - public final function check_capabilities() { + final public function check_capabilities() { if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) ) { return false; } @@ -129,12 +243,25 @@ class WP_Customize_Panel { return true; } + /** + * Get the panel's content template for insertion into the Customizer pane. + * + * @since 4.1.0 + * + * @return string Content for the panel. + */ + final public function get_content() { + ob_start(); + $this->maybe_render(); + return trim( ob_get_clean() ); + } + /** * Check capabilities and render the panel. * * @since 4.0.0 */ - public final function maybe_render() { + final public function maybe_render() { if ( ! $this->check_capabilities() ) { return; } @@ -151,8 +278,8 @@ class WP_Customize_Panel { /** * Fires before rendering a specific Customizer panel. * - * The dynamic portion of the hook name, $this->id, refers to the ID - * of the specific Customizer panel to be rendered. + * The dynamic portion of the hook name, `$this->id`, refers to + * the ID of the specific Customizer panel to be rendered. * * @since 4.0.0 */ @@ -162,39 +289,194 @@ class WP_Customize_Panel { } /** - * Render the panel, and the sections that have been added to it. + * Render the panel container, and then its contents (via `this->render_content()`) in a subclass. + * + * Panel containers are now rendered in JS by default, see {@see WP_Customize_Panel::print_template()}. * * @since 4.0.0 * @access protected */ - protected function render() { + protected function render() {} + + /** + * Render the panel UI in a subclass. + * + * Panel contents are now rendered in JS by default, see {@see WP_Customize_Panel::print_template()}. + * + * @since 4.1.0 + * @access protected + */ + protected function render_content() {} + + /** + * Render the panel's JS templates. + * + * This function is only run for panel types that have been registered with + * WP_Customize_Manager::register_panel_type(). + * + * @since 4.3.0 + * + * @see WP_Customize_Manager::register_panel_type() + */ + public function print_template() { ?> -
  • + + + +

  • - title ); ?> + {{ data.title }}

    - +
    • +
  • + +
    + {{ data.title }}' ); + ?> + +
    + <# if ( data.description ) { #> +
    + {{{ data.description }}} +
    + <# } #> +
    • + render_screen_options(); + } + + /** + * Returns the advanced options for the nav menus page. + * + * Link title attribute added as it's a relatively advanced concept for new users. + * + * @since 4.3.0 + * @access public + * + * @return array The advanced menu properties. + */ + public function wp_nav_menu_manage_columns() { + return array( + '_title' => __( 'Show advanced menu properties' ), + 'cb' => '', + 'link-target' => __( 'Link Target' ), + 'attr-title' => __( 'Title Attribute' ), + 'css-classes' => __( 'CSS Classes' ), + 'xfn' => __( 'Link Relationship (XFN)' ), + 'description' => __( 'Description' ), + ); + } + + /** + * An Underscore (JS) template for this panel's content (but not its container). + * + * Class variables for this panel class are available in the `data` JS object; + * export custom variables by overriding WP_Customize_Panel::json(). + * + * @since 4.3.0 + * @access protected + * + * @see WP_Customize_Panel::print_template() + */ + protected function content_template() { + ?> +
  • + +
    + + {{ data.title }}' ); + ?> + + + +
    + <# if ( data.description ) { #> +
    {{{ data.description }}}
    + <# } #> + render_screen_options(); ?> +
    • +