WordPress.org

Make WordPress Core

Changeset 34320


Ignore:
Timestamp:
09/19/2015 06:39:09 AM (4 years ago)
Author:
westonruter
Message:

Customize: Flesh out phpdoc for WP_Customize_Manager.

  • Add missing phpdoc for class member variables.
  • Supply missing @return descriptions from [34269].
  • Add missing @since tags.
  • Remove unused $customized protected class member variable.

Fixes #33898.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-customize-manager.php

    r34269 r34320  
    2525     * An instance of the theme being previewed.
    2626     *
     27     * @since 3.4.0
     28     * @access protected
    2729     * @var WP_Theme
    2830     */
     
    3234     * The directory name of the previously active theme (within the theme_root).
    3335     *
     36     * @since 3.4.0
     37     * @access protected
    3438     * @var string
    3539     */
     
    3943     * Whether this is a Customizer pageload.
    4044     *
     45     * @since 3.4.0
     46     * @access protected
    4147     * @var bool
    4248     */
     
    4450
    4551    /**
    46      * Methods and properties deailing with managing widgets in the Customizer.
    47      *
     52     * Methods and properties dealing with managing widgets in the Customizer.
     53     *
     54     * @since 3.9.0
     55     * @access public
    4856     * @var WP_Customize_Widgets
    4957     */
     
    5159
    5260    /**
    53      * Methods and properties deailing with managing nav menus in the Customizer.
    54      *
     61     * Methods and properties dealing with managing nav menus in the Customizer.
     62     *
     63     * @since 4.3.0
     64     * @access public
    5565     * @var WP_Customize_Nav_Menus
    5666     */
    5767    public $nav_menus;
    5868
    59     protected $settings   = array();
     69    /**
     70     * Registered instances of WP_Customize_Setting.
     71     *
     72     * @since 3.4.0
     73     * @access protected
     74     * @var array
     75     */
     76    protected $settings = array();
     77
     78    /**
     79     * Sorted top-level instances of WP_Customize_Panel and WP_Customize_Section.
     80     *
     81     * @since 4.0.0
     82     * @access protected
     83     * @var array
     84     */
    6085    protected $containers = array();
    61     protected $panels     = array();
    62     protected $sections   = array();
    63     protected $controls   = array();
    64 
     86
     87    /**
     88     * Registered instances of WP_Customize_Panel.
     89     *
     90     * @since 4.0.0
     91     * @access protected
     92     * @var array
     93     */
     94    protected $panels = array();
     95
     96    /**
     97     * Registered instances of WP_Customize_Section.
     98     *
     99     * @since 3.4.0
     100     * @access protected
     101     * @var array
     102     */
     103    protected $sections = array();
     104
     105    /**
     106     * Registered instances of WP_Customize_Control.
     107     *
     108     * @since 3.4.0
     109     * @access protected
     110     * @var array
     111     */
     112    protected $controls = array();
     113
     114    /**
     115     * Return value of check_ajax_referer() in customize_preview_init() method.
     116     *
     117     * @since 3.5.0
     118     * @access protected
     119     * @var false|int
     120     */
    65121    protected $nonce_tick;
    66 
    67     protected $customized;
    68122
    69123    /**
     
    734788     * @since 3.4.0
    735789     *
    736      * @return mixed
     790     * @param mixed $return Value passed through for wp_die_handler filter.
     791     * @return mixed Value passed through for wp_die_handler filter.
    737792     */
    738793    public function remove_preview_signature( $return = null ) {
     
    13141369
    13151370    /**
    1316      * Return whether the user agent is iOS.
     1371     * Determine whether the user agent is iOS.
    13171372     *
    13181373     * @since 4.4.0
    13191374     * @access public
    13201375     *
    1321      * @return bool
     1376     * @return bool Whether the user agent is iOS.
    13221377     */
    13231378    public function is_ios() {
     
    13311386     * @access public
    13321387     *
    1333      * @return string
     1388     * @return string The template string for the document title.
    13341389     */
    13351390    public function get_document_title_template() {
     
    13511406     * @access public
    13521407     *
    1353      * @param string $preview_url  URL to be previewed.
     1408     * @param string $preview_url URL to be previewed.
    13541409     */
    13551410    public function set_preview_url( $preview_url ) {
     
    13631418     * @access public
    13641419     *
    1365      * @return string
     1420     * @return string URL being previewed.
    13661421     */
    13671422    public function get_preview_url() {
     
    13821437     * @access public
    13831438     *
    1384      * @param string $return_url  URL for return link.
     1439     * @param string $return_url URL for return link.
    13851440     */
    13861441    public function set_return_url( $return_url ) {
     
    13961451     * @access public
    13971452     *
    1398      * @return string
     1453     * @return string URL for link to close Customizer.
    13991454     */
    14001455    public function get_return_url() {
     
    14141469     * Set the autofocused constructs.
    14151470     *
     1471     * @since 4.4.0
     1472     * @access public
     1473     *
    14161474     * @param array $autofocus {
    14171475     *     Mapping of 'panel', 'section', 'control' to the ID which should be autofocused.
     
    14471505     * Print JavaScript settings for parent window.
    14481506     *
    1449      * @since 4.3.0
     1507     * @since 4.4.0
    14501508     */
    14511509    public function customize_pane_settings() {
Note: See TracChangeset for help on using the changeset viewer.