4.1 Docs Audit: Improve inline documentation for various properties and methods in the `WP_Customize_Panel` class.
See #30469. Built from https://develop.svn.wordpress.org/trunk@30607 git-svn-id: http://core.svn.wordpress.org/trunk@30597 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
478f5f1f5d
commit
a8fcffa02a
|
@ -110,7 +110,7 @@ class WP_Customize_Panel {
|
||||||
public $type;
|
public $type;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Callback.
|
* Active callback.
|
||||||
*
|
*
|
||||||
* @since 4.1.0
|
* @since 4.1.0
|
||||||
* @access public
|
* @access public
|
||||||
|
@ -118,8 +118,8 @@ class WP_Customize_Panel {
|
||||||
* @see WP_Customize_Section::active()
|
* @see WP_Customize_Section::active()
|
||||||
*
|
*
|
||||||
* @var callable Callback is called with one argument, the instance of
|
* @var callable Callback is called with one argument, the instance of
|
||||||
* WP_Customize_Section, and returns bool to indicate whether
|
* {@see WP_Customize_Section}, and returns bool to indicate
|
||||||
* the section is active (such as it relates to the URL
|
* whether the section is active (such as it relates to the URL
|
||||||
* currently being previewed).
|
* currently being previewed).
|
||||||
*/
|
*/
|
||||||
public $active_callback = '';
|
public $active_callback = '';
|
||||||
|
@ -173,8 +173,8 @@ class WP_Customize_Panel {
|
||||||
*
|
*
|
||||||
* @since 4.1.0
|
* @since 4.1.0
|
||||||
*
|
*
|
||||||
* @param bool $active Whether the Customizer panel is active.
|
* @param bool $active Whether the Customizer panel is active.
|
||||||
* @param WP_Customize_Panel $panel WP_Customize_Panel instance.
|
* @param WP_Customize_Panel $panel {@see WP_Customize_Panel} instance.
|
||||||
*/
|
*/
|
||||||
$active = apply_filters( 'customize_panel_active', $active, $panel );
|
$active = apply_filters( 'customize_panel_active', $active, $panel );
|
||||||
|
|
||||||
|
@ -182,7 +182,7 @@ class WP_Customize_Panel {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Default callback used when invoking WP_Customize_Panel::active().
|
* Default callback used when invoking {@see WP_Customize_Panel::active()}.
|
||||||
*
|
*
|
||||||
* Subclasses can override this with their specific logic, or they may
|
* Subclasses can override this with their specific logic, or they may
|
||||||
* provide an 'active_callback' argument to the constructor.
|
* provide an 'active_callback' argument to the constructor.
|
||||||
|
@ -201,7 +201,7 @@ class WP_Customize_Panel {
|
||||||
*
|
*
|
||||||
* @since 4.1.0
|
* @since 4.1.0
|
||||||
*
|
*
|
||||||
* @return array The array to be exported to the client as JSON
|
* @return array The array to be exported to the client as JSON.
|
||||||
*/
|
*/
|
||||||
public function json() {
|
public function json() {
|
||||||
$array = wp_array_slice_assoc( (array) $this, array( 'title', 'description', 'priority', 'type' ) );
|
$array = wp_array_slice_assoc( (array) $this, array( 'title', 'description', 'priority', 'type' ) );
|
||||||
|
@ -236,7 +236,7 @@ class WP_Customize_Panel {
|
||||||
*
|
*
|
||||||
* @since 4.1.0
|
* @since 4.1.0
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string Content for the panel.
|
||||||
*/
|
*/
|
||||||
public final function get_content() {
|
public final function get_content() {
|
||||||
ob_start();
|
ob_start();
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
*
|
*
|
||||||
* @global string $wp_version
|
* @global string $wp_version
|
||||||
*/
|
*/
|
||||||
$wp_version = '4.1-beta2-30606';
|
$wp_version = '4.1-beta2-30607';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||||
|
|
Loading…
Reference in New Issue