Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

4.1 Docs Audit: Improve inline documentation for various properties and methods in the `WP_Customize_Section`, `WP_Customize_Section`, and `WP_Customize_Sidebar_Section` classes. 

See #30469.

Built from https://develop.svn.wordpress.org/trunk@30608


git-svn-id: http://core.svn.wordpress.org/trunk@30598 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-28 11:10:22 +00:00
parent a8fcffa02a
commit 49fe81ebeb
2 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
wp-includes/class-wp-customize-section.php
View File

@ -119,7 +119,7 @@ class WP_Customize_Section {
public $type;
/**
* Callback.
* Active callback.
*
* @since 4.1.0
* @access public
@ -127,8 +127,8 @@ class WP_Customize_Section {
* @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 = '';
@ -178,12 +178,12 @@ class WP_Customize_Section {
$active = call_user_func( $this->active_callback, $this );
/**
* Filter response of WP_Customize_Section::active().
* 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 WP_Customize_Section instance.
* @param WP_Customize_Section $section {@see WP_Customize_Section} instance.
*/
$active = apply_filters( 'customize_section_active', $active, $section );
@ -191,10 +191,10 @@ class WP_Customize_Section {
}
/**
* Default callback used when invoking WP_Customize_Section::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.
* 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
@ -210,7 +210,7 @@ class WP_Customize_Section {
*
* @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', 'panel', 'type' ) );
@ -245,7 +245,7 @@ class WP_Customize_Section {
*
* @since 4.1.0
*
* @return string
* @return string Contents of the section.
*/
public final function get_content() {
ob_start();
@ -316,7 +316,10 @@ class WP_Customize_Section {
*
* @package WordPress
* @subpackage Customize
*
* @since 4.1.0
*
* @see WP_Customize_Section
*/
class WP_Customize_Sidebar_Section extends WP_Customize_Section {
@ -341,7 +344,7 @@ class WP_Customize_Sidebar_Section extends WP_Customize_Section {
*
* @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() {
$json = parent::json();

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.1-beta2-30607';
$wp_version = '4.1-beta2-30608';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.