Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WordPress Customize Section classes

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Customize

[5] Fix | Delete

* @since 3.4.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Customize Section class.

[10] Fix | Delete

[11] Fix | Delete

* A UI container for controls, managed by the WP_Customize_Manager class.

[12] Fix | Delete

[13] Fix | Delete

* @since 3.4.0

[14] Fix | Delete

[15] Fix | Delete

* @see WP_Customize_Manager

[16] Fix | Delete

[17] Fix | Delete

#[AllowDynamicProperties]

[18] Fix | Delete

class WP_Customize_Section {

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Incremented with each new class instantiation, then stored in $instance_number.

[22] Fix | Delete

[23] Fix | Delete

* Used when sorting two instances whose priorities are equal.

[24] Fix | Delete

[25] Fix | Delete

* @since 4.1.0

[26] Fix | Delete

* @var int

[27] Fix | Delete

[28] Fix | Delete

protected static $instance_count = 0;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Order in which this instance was created in relation to other instances.

[32] Fix | Delete

[33] Fix | Delete

* @since 4.1.0

[34] Fix | Delete

* @var int

[35] Fix | Delete

[36] Fix | Delete

public $instance_number;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* WP_Customize_Manager instance.

[40] Fix | Delete

[41] Fix | Delete

* @since 3.4.0

[42] Fix | Delete

* @var WP_Customize_Manager

[43] Fix | Delete

[44] Fix | Delete

public $manager;

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Unique identifier.

[48] Fix | Delete

[49] Fix | Delete

* @since 3.4.0

[50] Fix | Delete

* @var string

[51] Fix | Delete

[52] Fix | Delete

public $id;

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Priority of the section which informs load order of sections.

[56] Fix | Delete

[57] Fix | Delete

* @since 3.4.0

[58] Fix | Delete

* @var int

[59] Fix | Delete

[60] Fix | Delete

public $priority = 160;

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Panel in which to show the section, making it a sub-section.

[64] Fix | Delete

[65] Fix | Delete

* @since 4.0.0

[66] Fix | Delete

* @var string

[67] Fix | Delete

[68] Fix | Delete

public $panel = '';

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Capability required for the section.

[72] Fix | Delete

[73] Fix | Delete

* @since 3.4.0

[74] Fix | Delete

* @var string

[75] Fix | Delete

[76] Fix | Delete

public $capability = 'edit_theme_options';

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Theme features required to support the section.

[80] Fix | Delete

[81] Fix | Delete

* @since 3.4.0

[82] Fix | Delete

* @var string|string[]

[83] Fix | Delete

[84] Fix | Delete

public $theme_supports = '';

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Title of the section to show in UI.

[88] Fix | Delete

[89] Fix | Delete

* @since 3.4.0

[90] Fix | Delete

* @var string

[91] Fix | Delete

[92] Fix | Delete

public $title = '';

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Description to show in the UI.

[96] Fix | Delete

[97] Fix | Delete

* @since 3.4.0

[98] Fix | Delete

* @var string

[99] Fix | Delete

[100] Fix | Delete

public $description = '';

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Customizer controls for this section.

[104] Fix | Delete

[105] Fix | Delete

* @since 3.4.0

[106] Fix | Delete

* @var array

[107] Fix | Delete

[108] Fix | Delete

public $controls;

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Type of this section.

[112] Fix | Delete

[113] Fix | Delete

* @since 4.1.0

[114] Fix | Delete

* @var string

[115] Fix | Delete

[116] Fix | Delete

public $type = 'default';

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Active callback.

[120] Fix | Delete

[121] Fix | Delete

* @since 4.1.0

[122] Fix | Delete

[123] Fix | Delete

* @see WP_Customize_Section::active()

[124] Fix | Delete

[125] Fix | Delete

* @var callable Callback is called with one argument, the instance of

[126] Fix | Delete

* WP_Customize_Section, and returns bool to indicate whether

[127] Fix | Delete

* the section is active (such as it relates to the URL currently

[128] Fix | Delete

* being previewed).

[129] Fix | Delete

[130] Fix | Delete

public $active_callback = '';

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Show the description or hide it behind the help icon.

[134] Fix | Delete

[135] Fix | Delete

* @since 4.7.0

[136] Fix | Delete

[137] Fix | Delete

* @var bool Indicates whether the Section's description should be

[138] Fix | Delete

* hidden behind a help icon ("?") in the Section header,

[139] Fix | Delete

* similar to how help icons are displayed on Panels.

[140] Fix | Delete

[141] Fix | Delete

public $description_hidden = false;

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* Constructor.

[145] Fix | Delete

[146] Fix | Delete

* Any supplied $args override class property defaults.

[147] Fix | Delete

[148] Fix | Delete

* @since 3.4.0

[149] Fix | Delete

[150] Fix | Delete

* @param WP_Customize_Manager $manager Customizer bootstrap instance.

[151] Fix | Delete

* @param string $id A specific ID of the section.

[152] Fix | Delete

* @param array $args {

[153] Fix | Delete

* Optional. Array of properties for the new Section object. Default empty array.

[154] Fix | Delete

[155] Fix | Delete

* @type int $priority Priority of the section, defining the display order

[156] Fix | Delete

* of panels and sections. Default 160.

[157] Fix | Delete

* @type string $panel The panel this section belongs to (if any).

[158] Fix | Delete

* Default empty.

[159] Fix | Delete

* @type string $capability Capability required for the section.

[160] Fix | Delete

* Default 'edit_theme_options'

[161] Fix | Delete

* @type string|string[] $theme_supports Theme features required to support the section.

[162] Fix | Delete

* @type string $title Title of the section to show in UI.

[163] Fix | Delete

* @type string $description Description to show in the UI.

[164] Fix | Delete

* @type string $type Type of the section.

[165] Fix | Delete

* @type callable $active_callback Active callback.

[166] Fix | Delete

* @type bool $description_hidden Hide the description behind a help icon,

[167] Fix | Delete

* instead of inline above the first control.

[168] Fix | Delete

* Default false.

[169] Fix | Delete

* }

[170] Fix | Delete

[171] Fix | Delete

public function __construct( $manager, $id, $args = array() ) {

[172] Fix | Delete

$keys = array_keys( get_object_vars( $this ) );

[173] Fix | Delete

foreach ( $keys as $key ) {

[174] Fix | Delete

if ( isset( $args[ $key ] ) ) {

[175] Fix | Delete

$this->$key = $args[ $key ];

[176] Fix | Delete

}

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

$this->manager = $manager;

[180] Fix | Delete

$this->id = $id;

[181] Fix | Delete

if ( empty( $this->active_callback ) ) {

[182] Fix | Delete

$this->active_callback = array( $this, 'active_callback' );

[183] Fix | Delete

}

[184] Fix | Delete

self::$instance_count += 1;

[185] Fix | Delete

$this->instance_number = self::$instance_count;

[186] Fix | Delete

[187] Fix | Delete

$this->controls = array(); // Users cannot customize the $controls array.

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

/**

[191] Fix | Delete

* Check whether section is active to current Customizer preview.

[192] Fix | Delete

[193] Fix | Delete

* @since 4.1.0

[194] Fix | Delete

[195] Fix | Delete

* @return bool Whether the section is active to the current preview.

[196] Fix | Delete

[197] Fix | Delete

final public function active() {

[198] Fix | Delete

$section = $this;

[199] Fix | Delete

$active = call_user_func( $this->active_callback, $this );

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Filters response of WP_Customize_Section::active().

[203] Fix | Delete

[204] Fix | Delete

* @since 4.1.0

[205] Fix | Delete

[206] Fix | Delete

* @param bool $active Whether the Customizer section is active.

[207] Fix | Delete

* @param WP_Customize_Section $section WP_Customize_Section instance.

[208] Fix | Delete

[209] Fix | Delete

$active = apply_filters( 'customize_section_active', $active, $section );

[210] Fix | Delete

[211] Fix | Delete

return $active;

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

/**

[215] Fix | Delete

* Default callback used when invoking WP_Customize_Section::active().

[216] Fix | Delete

[217] Fix | Delete

* Subclasses can override this with their specific logic, or they may provide

[218] Fix | Delete

* an 'active_callback' argument to the constructor.

[219] Fix | Delete

[220] Fix | Delete

* @since 4.1.0

[221] Fix | Delete

[222] Fix | Delete

* @return true Always true.

[223] Fix | Delete

[224] Fix | Delete

public function active_callback() {

[225] Fix | Delete

return true;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Gather the parameters passed to client JavaScript via JSON.

[230] Fix | Delete

[231] Fix | Delete

* @since 4.1.0

[232] Fix | Delete

[233] Fix | Delete

* @return array The array to be exported to the client as JSON.

[234] Fix | Delete

[235] Fix | Delete

public function json() {

[236] Fix | Delete

$array = wp_array_slice_assoc( (array) $this, array( 'id', 'description', 'priority', 'panel', 'type', 'description_hidden' ) );

[237] Fix | Delete

$array['title'] = html_entity_decode( $this->title, ENT_QUOTES, get_bloginfo( 'charset' ) );

[238] Fix | Delete

$array['content'] = $this->get_content();

[239] Fix | Delete

$array['active'] = $this->active();

[240] Fix | Delete

$array['instanceNumber'] = $this->instance_number;

[241] Fix | Delete

[242] Fix | Delete

if ( $this->panel ) {

[243] Fix | Delete

/* translators: ▸ is the unicode right-pointing triangle. %s: Section title in the Customizer. */

[244] Fix | Delete

$array['customizeAction'] = sprintf( __( 'Customizing ▸ %s' ), esc_html( $this->manager->get_panel( $this->panel )->title ) );

[245] Fix | Delete

} else {

[246] Fix | Delete

$array['customizeAction'] = __( 'Customizing' );

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

return $array;

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* Checks required user capabilities and whether the theme has the

[254] Fix | Delete

* feature support required by the section.

[255] Fix | Delete

[256] Fix | Delete

* @since 3.4.0

[257] Fix | Delete

[258] Fix | Delete

* @return bool False if theme doesn't support the section or user doesn't have the capability.

[259] Fix | Delete

[260] Fix | Delete

final public function check_capabilities() {

[261] Fix | Delete

if ( $this->capability && ! current_user_can( $this->capability ) ) {

[262] Fix | Delete

return false;

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

if ( $this->theme_supports && ! current_theme_supports( ...(array) $this->theme_supports ) ) {

[266] Fix | Delete

return false;

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

return true;

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Get the section's content for insertion into the Customizer pane.

[274] Fix | Delete

[275] Fix | Delete

* @since 4.1.0

[276] Fix | Delete

[277] Fix | Delete

* @return string Contents of the section.

[278] Fix | Delete

[279] Fix | Delete

final public function get_content() {

[280] Fix | Delete

ob_start();

[281] Fix | Delete

$this->maybe_render();

[282] Fix | Delete

return trim( ob_get_clean() );

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

/**

[286] Fix | Delete

* Check capabilities and render the section.

[287] Fix | Delete

[288] Fix | Delete

* @since 3.4.0

[289] Fix | Delete

[290] Fix | Delete

final public function maybe_render() {

[291] Fix | Delete

if ( ! $this->check_capabilities() ) {

[292] Fix | Delete

return;

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

/**

[296] Fix | Delete

* Fires before rendering a Customizer section.

[297] Fix | Delete

[298] Fix | Delete

* @since 3.4.0

[299] Fix | Delete

[300] Fix | Delete

* @param WP_Customize_Section $section WP_Customize_Section instance.

[301] Fix | Delete

[302] Fix | Delete

do_action( 'customize_render_section', $this );

[303] Fix | Delete

/**

[304] Fix | Delete

* Fires before rendering a specific Customizer section.

[305] Fix | Delete

[306] Fix | Delete

* The dynamic portion of the hook name, `$this->id`, refers to the ID

[307] Fix | Delete

* of the specific Customizer section to be rendered.

[308] Fix | Delete

[309] Fix | Delete

* @since 3.4.0

[310] Fix | Delete

[311] Fix | Delete

do_action( "customize_render_section_{$this->id}" );

[312] Fix | Delete

[313] Fix | Delete

$this->render();

[314] Fix | Delete

}

[315] Fix | Delete

[316] Fix | Delete

/**

[317] Fix | Delete

* Render the section UI in a subclass.

[318] Fix | Delete

[319] Fix | Delete

* Sections are now rendered in JS by default, see WP_Customize_Section::print_template().

[320] Fix | Delete

[321] Fix | Delete

* @since 3.4.0

[322] Fix | Delete

[323] Fix | Delete

protected function render() {}

[324] Fix | Delete

[325] Fix | Delete

/**

[326] Fix | Delete

* Render the section's JS template.

[327] Fix | Delete

[328] Fix | Delete

* This function is only run for section types that have been registered with

[329] Fix | Delete

* WP_Customize_Manager::register_section_type().

[330] Fix | Delete

[331] Fix | Delete

* @since 4.3.0

[332] Fix | Delete

[333] Fix | Delete

* @see WP_Customize_Manager::render_template()

[334] Fix | Delete

[335] Fix | Delete

public function print_template() {

[336] Fix | Delete

[337] Fix | Delete

[338] Fix | Delete

<?php $this->render_template(); ?>

[339] Fix | Delete

</script>

[340] Fix | Delete

<?php

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

/**

[344] Fix | Delete

* An Underscore (JS) template for rendering this section.

[345] Fix | Delete

[346] Fix | Delete

* Class variables for this section class are available in the `data` JS object;

[347] Fix | Delete

* export custom variables by overriding WP_Customize_Section::json().

[348] Fix | Delete

[349] Fix | Delete

* @since 4.3.0

[350] Fix | Delete

[351] Fix | Delete

* @see WP_Customize_Section::print_template()

[352] Fix | Delete

[353] Fix | Delete

protected function render_template() {

[354] Fix | Delete

[355] Fix | Delete

[356] Fix | Delete

[357] Fix | Delete

[358] Fix | Delete

[359] Fix | Delete

</button>

[360] Fix | Delete

</h3>

[361] Fix | Delete

[362] Fix | Delete

<li class="customize-section-description-container section-meta <# if ( data.description_hidden ) { #>customize-info<# } #>">

[363] Fix | Delete

[364] Fix | Delete

[365] Fix | Delete

[366] Fix | Delete

<?php

[367] Fix | Delete

/* translators: Hidden accessibility text. */

[368] Fix | Delete

_e( 'Back' );

[369] Fix | Delete

[370] Fix | Delete

</span>

[371] Fix | Delete

</button>

[372] Fix | Delete

<h3>

[373] Fix | Delete

[374] Fix | Delete

{{{ data.customizeAction }}}

[375] Fix | Delete

</span>

[376] Fix | Delete

[377] Fix | Delete

</h3>

[378] Fix | Delete

<# if ( data.description && data.description_hidden ) { #>

[379] Fix | Delete

[380] Fix | Delete

<?php

[381] Fix | Delete

/* translators: Hidden accessibility text. */

[382] Fix | Delete

_e( 'Help' );

[383] Fix | Delete

[384] Fix | Delete

</span></button>

[385] Fix | Delete

[386] Fix | Delete

{{{ data.description }}}

[387] Fix | Delete

</div>

[388] Fix | Delete

<# } #>

[389] Fix | Delete

[390] Fix | Delete

[391] Fix | Delete

</div>

[392] Fix | Delete

[393] Fix | Delete

<# if ( data.description && ! data.description_hidden ) { #>

[394] Fix | Delete

[395] Fix | Delete

{{{ data.description }}}

[396] Fix | Delete

</div>

[397] Fix | Delete

<# } #>

[398] Fix | Delete

</li>

[399] Fix | Delete

</ul>

[400] Fix | Delete

</li>

[401] Fix | Delete

<?php

[402] Fix | Delete

}

[403] Fix | Delete

}

[404] Fix | Delete

[405] Fix | Delete

/** WP_Customize_Themes_Section class */

[406] Fix | Delete

require_once ABSPATH . WPINC . '/customize/class-wp-customize-themes-section.php';

[407] Fix | Delete

[408] Fix | Delete

/** WP_Customize_Sidebar_Section class */

[409] Fix | Delete

require_once ABSPATH . WPINC . '/customize/class-wp-customize-sidebar-section.php';

[410] Fix | Delete

[411] Fix | Delete

/** WP_Customize_Nav_Menu_Section class */

[412] Fix | Delete

require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php';

[413] Fix | Delete

[414] Fix | Delete