sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

4.1 Docs Audit: Improve inline documentation for various properties and methods in the WP_Customize_Panel class.

Browse Source 
See #30469.


git-svn-id: https://develop.svn.wordpress.org/trunk@30607 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-11-28 11:02:49 +00:00
parent 91a0357fe0
commit 28072f473a
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/wp-includes/class-wp-customize-panel.php
View File

@ -110,7 +110,7 @@ class WP_Customize_Panel {
public $type;
/**
* Callback.
* Active callback.
*
* @since 4.1.0
* @access public
@ -118,8 +118,8 @@ class WP_Customize_Panel {
* @see WP_Customize_Section::active()
*
* @var callable Callback is called with one argument, the instance of
* WP_Customize_Section, and returns bool to indicate whether
* the section is active (such as it relates to the URL
* {@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 = '';
@ -173,8 +173,8 @@ class WP_Customize_Panel {
*
* @since 4.1.0
*
* @param bool $active Whether the Customizer panel is active.
* @param WP_Customize_Panel $panel WP_Customize_Panel instance.
* @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 );
@ -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
* provide an 'active_callback' argument to the constructor.
@ -201,7 +201,7 @@ class WP_Customize_Panel {
*
* @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() {
$array = wp_array_slice_assoc( (array) $this, array( 'title', 'description', 'priority', 'type' ) );
@ -236,7 +236,7 @@ class WP_Customize_Panel {
*
* @since 4.1.0
*
* @return string
* @return string Content for the panel.
*/
public final function get_content() {
ob_start();