Make WordPress Core


Ignore:
Timestamp:
07/26/2012 09:45:33 PM (12 years ago)
Author:
ryan
Message:

phpdoc for Customizer classes and methods. Props bananastalktome. see #21303

File:
1 edited

Legend:

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

    r21135 r21354  
    11<?php
    22/**
    3  * Customize
     3 * Customize Manager.
    44 *
    55 * @package WordPress
     
    77 * @since 3.4.0
    88 */
    9 
    109final class WP_Customize_Manager {
    1110    protected $theme;
     
    5756    }
    5857
    59     /**
     58    /**
    6059     * Return true if it's an AJAX request.
    6160     *
    6261     * @since 3.4.0
     62     *
     63     * @return bool
    6364     */
    6465    public function doing_ajax() {
     
    7071     * or the AJAX message.
    7172     *
    72      * @param  mixed $ajax_message AJAX return
    73      * @param  mixed $message      UI message
    74      *
    75      * @since 3.4.0
     73     * @since 3.4.0
     74     *
     75     * @param mixed $ajax_message AJAX return
     76     * @param mixed $message UI message
    7677     */
    7778    protected function wp_die( $ajax_message, $message = null ) {
     
    8990     *
    9091     * @since 3.4.0
     92     *
     93     * @return string
    9194     */
    9295    public function wp_die_handler() {
     
    9699        return '_default_wp_die_handler';
    97100    }
    98     /**
    99     * Start preview and customize theme.
    100     *
    101     * Check if customize query variable exist. Init filters to filter the current theme.
     101   
     102    /**
     103     * Start preview and customize theme.
     104     *
     105     * Check if customize query variable exist. Init filters to filter the current theme.
    102106     *
    103107     * @since 3.4.0
     
    137141        $this->start_previewing_theme();
    138142    }
    139 
     143   
     144    /**
     145     * Callback to validate a theme once it is loaded
     146     *
     147     * @since 3.4.0
     148     */
    140149    function after_setup_theme() {
    141150        if ( ! $this->doing_ajax() && ! validate_current_theme() ) {
     
    280289     *
    281290     * @since 3.4.0
     291     *
     292     * @param $status
     293     * @return int
    282294     */
    283295    public function wp_redirect_status( $status ) {
     
    292304     *
    293305     * @since 3.4.0
     306     *
     307     * @param mixed $setting A WP_Customize_Setting derived object
     308     * @return string Sanitized attribute
    294309     */
    295310    public function post_value( $setting ) {
     
    368383
    369384        if ( 2 == $this->nonce_tick ) {
    370             $settings['nonce'] = array(
    371                 'save' => wp_create_nonce( 'save-customize_' . $this->get_stylesheet() ),
    372                 'preview' => wp_create_nonce( 'preview-customize_' . $this->get_stylesheet() )
    373             );
    374         }
     385            $settings['nonce'] = array(
     386                'save' => wp_create_nonce( 'save-customize_' . $this->get_stylesheet() ),
     387                'preview' => wp_create_nonce( 'preview-customize_' . $this->get_stylesheet() )
     388            );
     389        }
    375390
    376391        foreach ( $this->settings as $id => $setting ) {
     
    465480     * @since 3.4.0
    466481     *
     482     * @param $current_theme {@internal Parameter is not used}
    467483     * @return string Theme name.
    468484     */
     
    631647     * @param object $a Object A.
    632648     * @param object $b Object B.
     649     * @return int
    633650     */
    634651    protected final function _cmp_priority( $a, $b ) {
     
    961978     *
    962979     * @since 3.4.0
     980     *
     981     * @param string $color
     982     * @return string
    963983     */
    964984    public function _sanitize_header_textcolor( $color ) {
     
    974994 *
    975995 * @since 3.4.0
     996 *
     997 * @param string $color
     998 * @return string|null
    976999 */
    9771000function sanitize_hex_color( $color ) {
     
    9961019 *
    9971020 * @since 3.4.0
     1021 * @uses sanitize_hex_color()
     1022 *
     1023 * @param string $color
     1024 * @return string|null
    9981025 */
    9991026function sanitize_hex_color_no_hash( $color ) {
     
    10131040 *
    10141041 * @since 3.4.0
     1042 *
     1043 * @param string $color
     1044 * @return string
    10151045 */
    10161046function maybe_hash_hex_color( $color ) {
Note: See TracChangeset for help on using the changeset viewer.