Inline documentation cleanup for 4.0 audit.

phpDoc tweaks for methods added in [28861]:
* `WP_Customize_Manager::panels()` method
* `WP_Customize_Manager::add_panel()` method
* `WP_Customize_Manager::get_panel()` method
* `WP_Customize_Manager::remove_panel()` method

Added in [28970]:
* `WP_Customize_Manager::customize_preview_override_404_status()` method

See #27406 and #28885.


git-svn-id: https://develop.svn.wordpress.org/trunk@29157 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-07-14 00:35:43 +00:00
parent e52c954fad
commit f6c14d758e

View File

@ -319,8 +319,9 @@ final class WP_Customize_Manager {
* Get the registered panels. * Get the registered panels.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @return array * @return array Panels.
*/ */
public function panels() { public function panels() {
return $this->panels; return $this->panels;
@ -433,6 +434,7 @@ final class WP_Customize_Manager {
* preview, since it causes the jQuery Ajax to fail. Send 200 instead. * preview, since it causes the jQuery Ajax to fail. Send 200 instead.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
*/ */
public function customize_preview_override_404_status() { public function customize_preview_override_404_status() {
if ( is_404() ) { if ( is_404() ) {
@ -680,9 +682,10 @@ final class WP_Customize_Manager {
* Add a customize panel. * Add a customize panel.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @param WP_Customize_Panel|string $id Customize Panel object, or Panel ID. * @param WP_Customize_Panel|string $id Customize Panel object, or Panel ID.
* @param array $args Panel arguments. * @param array $args Optional. Panel arguments. Default empty array.
*/ */
public function add_panel( $id, $args = array() ) { public function add_panel( $id, $args = array() ) {
if ( is_a( $id, 'WP_Customize_Panel' ) ) { if ( is_a( $id, 'WP_Customize_Panel' ) ) {
@ -699,9 +702,10 @@ final class WP_Customize_Manager {
* Retrieve a customize panel. * Retrieve a customize panel.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @param string $id Panel ID. * @param string $id Panel ID to get.
* @return WP_Customize_Panel * @return WP_Customize_Panel Requested panel instance.
*/ */
public function get_panel( $id ) { public function get_panel( $id ) {
if ( isset( $this->panels[ $id ] ) ) { if ( isset( $this->panels[ $id ] ) ) {
@ -713,8 +717,9 @@ final class WP_Customize_Manager {
* Remove a customize panel. * Remove a customize panel.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* *
* @param string $id Panel ID. * @param string $id Panel ID to remove.
*/ */
public function remove_panel( $id ) { public function remove_panel( $id ) {
unset( $this->panels[ $id ] ); unset( $this->panels[ $id ] );