WordPress.org

Make WordPress Core

Ticket #41452: 41452.diff

File 41452.diff, 195.6 KB (added by DrewAPicture, 3 years ago)
  • src/wp-includes/cache.php

     
    291291         * Holds the cached objects.
    292292         *
    293293         * @since 2.0.0
    294          * @access private
    295294         * @var array
    296295         */
    297296        private $cache = array();
     
    300299         * The amount of times the cache data was already stored in the cache.
    301300         *
    302301         * @since 2.5.0
    303          * @access public
    304302         * @var int
    305303         */
    306304        public $cache_hits = 0;
     
    309307         * Amount of times the cache did not have the request in cache.
    310308         *
    311309         * @since 2.0.0
    312          * @access public
    313310         * @var int
    314311         */
    315312        public $cache_misses = 0;
     
    318315         * List of global cache groups.
    319316         *
    320317         * @since 3.0.0
    321          * @access protected
    322318         * @var array
    323319         */
    324320        protected $global_groups = array();
     
    327323         * The blog prefix to prepend to keys in non-global groups.
    328324         *
    329325         * @since 3.5.0
    330          * @access private
    331326         * @var int
    332327         */
    333328        private $blog_prefix;
     
    336331         * Holds the value of is_multisite().
    337332         *
    338333         * @since 3.5.0
    339          * @access private
    340334         * @var bool
    341335         */
    342336        private $multisite;
     
    345339         * Makes private properties readable for backward compatibility.
    346340         *
    347341         * @since 4.0.0
    348          * @access public
    349342         *
    350343         * @param string $name Property to get.
    351344         * @return mixed Property.
     
    358351         * Makes private properties settable for backward compatibility.
    359352         *
    360353         * @since 4.0.0
    361          * @access public
    362354         *
    363355         * @param string $name  Property to set.
    364356         * @param mixed  $value Property value.
     
    372364         * Makes private properties checkable for backward compatibility.
    373365         *
    374366         * @since 4.0.0
    375          * @access public
    376367         *
    377368         * @param string $name Property to check if set.
    378369         * @return bool Whether the property is set.
     
    385376         * Makes private properties un-settable for backward compatibility.
    386377         *
    387378         * @since 4.0.0
    388          * @access public
    389379         *
    390380         * @param string $name Property to unset.
    391381         */
     
    397387         * Adds data to the cache if it doesn't already exist.
    398388         *
    399389         * @since 2.0.0
    400          * @access public
    401390         *
    402391         * @uses WP_Object_Cache::_exists() Checks to see if the cache already has data.
    403392         * @uses WP_Object_Cache::set()     Sets the data after the checking the cache
     
    430419         * Sets the list of global cache groups.
    431420         *
    432421         * @since 3.0.0
    433          * @access public
    434422         *
    435423         * @param array $groups List of groups that are global.
    436424         */
     
    445433         * Decrements numeric cache item's value.
    446434         *
    447435         * @since 3.3.0
    448          * @access public
    449436         *
    450437         * @param int|string $key    The cache key to decrement.
    451438         * @param int        $offset Optional. The amount by which to decrement the item's value. Default 1.
     
    481468         * If the cache key does not exist in the group, then nothing will happen.
    482469         *
    483470         * @since 2.0.0
    484          * @access public
    485471         *
    486472         * @param int|string $key        What the contents in the cache are called.
    487473         * @param string     $group      Optional. Where the cache contents are grouped. Default 'default'.
     
    506492         * Clears the object cache of all data.
    507493         *
    508494         * @since 2.0.0
    509          * @access public
    510495         *
    511496         * @return true Always returns true.
    512497         */
     
    526511         * On failure, the number of cache misses will be incremented.
    527512         *
    528513         * @since 2.0.0
    529          * @access public
    530514         *
    531515         * @param int|string $key    What the contents in the cache are called.
    532516         * @param string     $group  Optional. Where the cache contents are grouped. Default 'default'.
     
    561545         * Increments numeric cache item's value.
    562546         *
    563547         * @since 3.3.0
    564          * @access public
    565548         *
    566549         * @param int|string $key    The cache key to increment
    567550         * @param int        $offset Optional. The amount by which to increment the item's value. Default 1.
     
    595578         * Replaces the contents in the cache, if contents already exist.
    596579         *
    597580         * @since 2.0.0
    598          * @access public
    599581         *
    600582         * @see WP_Object_Cache::set()
    601583         *
     
    623605         * Resets cache keys.
    624606         *
    625607         * @since 3.0.0
    626          * @access public
    627608         *
    628609         * @deprecated 3.5.0 Use switch_to_blog()
    629610         * @see switch_to_blog()
     
    651632         * more for cache plugins which use files.
    652633         *
    653634         * @since 2.0.0
    654          * @access public
    655635         *
    656636         * @param int|string $key    What to call the contents in the cache.
    657637         * @param mixed      $data   The contents to store in the cache.
     
    680660         * key and the data.
    681661         *
    682662         * @since 2.0.0
    683          * @access public
    684663         */
    685664        public function stats() {
    686665                echo "<p>";
     
    700679         * This changes the blog ID used to create keys in blog specific groups.
    701680         *
    702681         * @since 3.5.0
    703          * @access public
    704682         *
    705683         * @param int $blog_id Blog ID.
    706684         */
     
    713691         * Serves as a utility function to determine whether a key exists in the cache.
    714692         *
    715693         * @since 3.4.0
    716          * @access protected
    717694         *
    718695         * @param int|string $key   Cache key to check for existence.
    719696         * @param string     $group Cache group for the key existence check.
  • src/wp-includes/class-http.php

     
    9898         * Please note: The only URI that are supported in the HTTP Transport implementation
    9999         * are the HTTP and HTTPS protocols.
    100100         *
    101          * @access public
    102101         * @since 2.7.0
    103102         *
    104103         * @param string       $url  The request URL.
     
    428427         * Normalizes cookies for using in Requests.
    429428         *
    430429         * @since 4.6.0
    431          * @access public
    432430         * @static
    433431         *
    434432         * @param array $cookies List of cookies to send with the request.
     
    456454         * specification for compatibility purposes.
    457455         *
    458456         * @since 4.6.0
    459          * @access public
    460457         * @static
    461458         *
    462459         * @param string            $location URL to redirect to.
     
    489486         * Tests which transports are capable of supporting the request.
    490487         *
    491488         * @since 3.2.0
    492          * @access public
    493489         *
    494490         * @param array $args Request arguments
    495491         * @param string $url URL to Request
     
    539535         * @since 3.2.0
    540536         *
    541537         * @static
    542          * @access private
    543538         *
    544539         * @param string $url URL to Request
    545540         * @param array $args Request arguments
     
    581576         *
    582577         * Used for sending data that is expected to be in the body.
    583578         *
    584          * @access public
    585579         * @since 2.7.0
    586580         *
    587581         * @param string       $url  The request URL.
     
    599593         *
    600594         * Used for sending data that is expected to be in the body.
    601595         *
    602          * @access public
    603596         * @since 2.7.0
    604597         *
    605598         * @param string $url The request URL.
     
    617610         *
    618611         * Used for sending data that is expected to be in the body.
    619612         *
    620          * @access public
    621613         * @since 2.7.0
    622614         *
    623615         * @param string $url The request URL.
     
    633625        /**
    634626         * Parses the responses and splits the parts into headers and body.
    635627         *
    636          * @access public
    637628         * @static
    638629         * @since 2.7.0
    639630         *
     
    652643         * If an array is given then it is assumed to be raw header data with numeric keys with the
    653644         * headers as the values. No headers must be passed that were already processed.
    654645         *
    655          * @access public
    656646         * @static
    657647         * @since 2.7.0
    658648         *
     
    730720         * which are each parsed into strings and added to the Cookie: header (within the arguments array).
    731721         * Edits the array by reference.
    732722         *
    733          * @access public
    734723         * @since 2.8.0
    735724         * @static
    736725         *
     
    761750         *
    762751         * @link https://tools.ietf.org/html/rfc2616#section-19.4.6 Process for chunked decoding.
    763752         *
    764          * @access public
    765753         * @since 2.7.0
    766754         * @static
    767755         *
     
    811799         * are supported, eg *.wordpress.org will allow for all subdomains of wordpress.org to be contacted.
    812800         *
    813801         * @since 2.8.0
    814          * @access public
    815802         * @link https://core.trac.wordpress.org/ticket/8927 Allow preventing external requests.
    816803         * @link https://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_ACCESSIBLE_HOSTS
    817804         *
     
    871858        /**
    872859         * Used as a wrapper for PHP's parse_url() function that handles edgecases in < PHP 5.4.7.
    873860         *
    874          * @access protected
    875861         * @deprecated 4.4.0 Use wp_parse_url()
    876862         * @see wp_parse_url()
    877863         *
     
    892878         * @since 3.4.0
    893879         *
    894880         * @static
    895          * @access public
    896881         *
    897882         * @param string $maybe_relative_path The URL which might be relative
    898883         * @param string $url                 The URL which $maybe_relative_path is relative to
     
    963948         * Handles HTTP Redirects and follows them if appropriate.
    964949         *
    965950         * @since 3.7.0
    966          * @access public
    967951         * @static
    968952         *
    969953         * @param string $url The URL which was requested.
     
    10201004         * @link http://home.deds.nl/~aeron/regex/ for IPv6 regex
    10211005         *
    10221006         * @since 3.7.0
    1023          * @access public
    10241007         * @static
    10251008         *
    10261009         * @param string $maybe_ip A suspected IP address
  • src/wp-includes/class-oembed.php

     
    2222         * A list of oEmbed providers.
    2323         *
    2424         * @since 2.9.0
    25          * @access public
    2625         * @var array
    2726         */
    2827        public $providers = array();
     
    3130         * A list of an early oEmbed providers.
    3231         *
    3332         * @since 4.0.0
    34          * @access public
    3533         * @static
    3634         * @var array
    3735         */
     
    4139         * A list of private/protected methods, used for backward compatibility.
    4240         *
    4341         * @since 4.2.0
    44          * @access private
    4542         * @var array
    4643         */
    4744        private $compat_methods = array( '_fetch_with_format', '_parse_json', '_parse_xml', '_parse_xml_body' );
     
    5047         * Constructor.
    5148         *
    5249         * @since 2.9.0
    53          * @access public
    5450         */
    5551        public function __construct() {
    5652                $host = urlencode( home_url() );
     
    211207         * Exposes private/protected methods for backward compatibility.
    212208         *
    213209         * @since 4.0.0
    214          * @access public
    215210         *
    216211         * @param callable $name      Method to call.
    217212         * @param array    $arguments Arguments to pass when calling.
     
    228223         * Takes a URL and returns the corresponding oEmbed provider's URL, if there is one.
    229224         *
    230225         * @since 4.0.0
    231          * @access public
    232226         *
    233227         * @see WP_oEmbed::discover()
    234228         *
     
    275269         *
    276270         * @static
    277271         * @since 4.0.0
    278          * @access public
    279272         *
    280273         * @see wp_oembed_add_provider()
    281274         *
     
    302295         * The just-in-time removal is for the benefit of the {@see 'oembed_providers'} filter.
    303296         *
    304297         * @since 4.0.0
    305          * @access public
    306298         * @static
    307299         *
    308300         * @see wp_oembed_remove_provider()
     
    324316         * @see WP_oEmbed::fetch()
    325317         *
    326318         * @since 4.8.0
    327          * @access public
    328319         *
    329320         * @param string       $url  The URL to the content that should be attempted to be embedded.
    330321         * @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
     
    355346         * @see WP_oEmbed::data2html()
    356347         *
    357348         * @since 2.9.0
    358          * @access public
    359349         *
    360350         * @param string       $url  The URL to the content that should be attempted to be embedded.
    361351         * @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
     
    405395         * Attempts to discover link tags at the given URL for an oEmbed provider.
    406396         *
    407397         * @since 2.9.0
    408          * @access public
    409398         *
    410399         * @param string $url The URL that should be inspected for discovery `<link>` tags.
    411400         * @return false|string False on failure, otherwise the oEmbed provider URL.
     
    489478         * Connects to a oEmbed provider and returns the result.
    490479         *
    491480         * @since 2.9.0
    492          * @access public
    493481         *
    494482         * @param string       $provider The URL to the oEmbed provider.
    495483         * @param string       $url      The URL to the content that is desired to be embedded.
     
    527515         * Fetches result from an oEmbed provider for a specific format and complete provider URL
    528516         *
    529517         * @since 3.0.0
    530          * @access private
    531518         *
    532519         * @param string $provider_url_with_args URL to the provider with full arguments list (url, maxheight, etc.)
    533520         * @param string $format Format to use
     
    552539         * Parses a json response body.
    553540         *
    554541         * @since 3.0.0
    555          * @access private
    556542         *
    557543         * @param string $response_body
    558544         * @return object|false
     
    566552         * Parses an XML response body.
    567553         *
    568554         * @since 3.0.0
    569          * @access private
    570555         *
    571556         * @param string $response_body
    572557         * @return object|false
     
    590575         * Serves as a helper function for parsing an XML response body.
    591576         *
    592577         * @since 3.6.0
    593          * @access private
    594578         *
    595579         * @param string $response_body
    596580         * @return stdClass|false
     
    628612         * Converts a data object from WP_oEmbed::fetch() and returns the HTML.
    629613         *
    630614         * @since 2.9.0
    631          * @access public
    632615         *
    633616         * @param object $data A data object result from an oEmbed provider.
    634617         * @param string $url The URL to the content that is desired to be embedded.
     
    685668         *
    686669         * @since 2.9.0 as strip_scribd_newlines()
    687670         * @since 3.0.0
    688          * @access public
    689671         *
    690672         * @param string $html Existing HTML.
    691673         * @param object $data Data object from WP_oEmbed::data2html()
  • src/wp-includes/class-walker-category-dropdown.php

     
    2020         * What the class handles.
    2121         *
    2222         * @since 2.1.0
    23          * @access private
    2423         * @var string
    2524         *
    2625         * @see Walker::$tree_type
     
    3130         * Database fields to use.
    3231         *
    3332         * @since 2.1.0
    34          * @access public
    3533         * @todo Decouple this
    3634         * @var array
    3735         *
     
    4341         * Starts the element output.
    4442         *
    4543         * @since 2.1.0
    46          * @access public
    4744         *
    4845         * @see Walker::start_el()
    4946         *
  • src/wp-includes/class-walker-category.php

     
    2020         * What the class handles.
    2121         *
    2222         * @since 2.1.0
    23          * @access public
    2423         * @var string
    2524         *
    2625         * @see Walker::$tree_type
     
    3130         * Database fields to use.
    3231         *
    3332         * @since 2.1.0
    34          * @access public
    3533         * @var array
    3634         *
    3735         * @see Walker::$db_fields
     
    4341         * Starts the list before the elements are added.
    4442         *
    4543         * @since 2.1.0
    46          * @access public
    4744         *
    4845         * @see Walker::start_lvl()
    4946         *
     
    6461         * Ends the list of after the elements are added.
    6562         *
    6663         * @since 2.1.0
    67          * @access public
    6864         *
    6965         * @see Walker::end_lvl()
    7066         *
     
    8581         * Starts the element output.
    8682         *
    8783         * @since 2.1.0
    88          * @access public
    8984         *
    9085         * @see Walker::start_el()
    9186         *
     
    215210         * Ends the element output, if needed.
    216211         *
    217212         * @since 2.1.0
    218          * @access public
    219213         *
    220214         * @see Walker::end_el()
    221215         *
  • src/wp-includes/class-walker-comment.php

     
    2020         * What the class handles.
    2121         *
    2222         * @since 2.7.0
    23          * @access public
    2423         * @var string
    2524         *
    2625         * @see Walker::$tree_type
     
    3130         * Database fields to use.
    3231         *
    3332         * @since 2.7.0
    34          * @access public
    3533         * @var array
    3634         *
    3735         * @see Walker::$db_fields
     
    4341         * Starts the list before the elements are added.
    4442         *
    4543         * @since 2.7.0
    46          * @access public
    4744         *
    4845         * @see Walker::start_lvl()
    4946         * @global int $comment_depth
     
    7269         * Ends the list of items after the elements are added.
    7370         *
    7471         * @since 2.7.0
    75          * @access public
    7672         *
    7773         * @see Walker::end_lvl()
    7874         * @global int $comment_depth
     
    118114         *      2.2
    119115         *
    120116         * @since 2.7.0
    121          * @access public
    122117         *
    123118         * @see Walker::display_element()
    124119         * @see wp_list_comments()
     
    157152         * Starts the element output.
    158153         *
    159154         * @since 2.7.0
    160          * @access public
    161155         *
    162156         * @see Walker::start_el()
    163157         * @see wp_list_comments()
     
    201195         * Ends the element output, if needed.
    202196         *
    203197         * @since 2.7.0
    204          * @access public
    205198         *
    206199         * @see Walker::end_el()
    207200         * @see wp_list_comments()
     
    228221         * Outputs a pingback comment.
    229222         *
    230223         * @since 3.6.0
    231          * @access protected
    232224         *
    233225         * @see wp_list_comments()
    234226         *
     
    250242         * Outputs a single comment.
    251243         *
    252244         * @since 3.6.0
    253          * @access protected
    254245         *
    255246         * @see wp_list_comments()
    256247         *
     
    314305         * Outputs a comment in the HTML5 format.
    315306         *
    316307         * @since 3.6.0
    317          * @access protected
    318308         *
    319309         * @see wp_list_comments()
    320310         *
  • src/wp-includes/class-walker-nav-menu.php

     
    1919         * What the class handles.
    2020         *
    2121         * @since 3.0.0
    22          * @access public
    2322         * @var string
    2423         *
    2524         * @see Walker::$tree_type
     
    3029         * Database fields to use.
    3130         *
    3231         * @since 3.0.0
    33          * @access public
    3432         * @todo Decouple this.
    3533         * @var array
    3634         *
  • src/wp-includes/class-walker-page-dropdown.php

     
    2020         * What the class handles.
    2121         *
    2222         * @since 2.1.0
    23          * @access public
    2423         * @var string
    2524         *
    2625         * @see Walker::$tree_type
     
    3130         * Database fields to use.
    3231         *
    3332         * @since 2.1.0
    34          * @access public
    3533         * @var array
    3634         *
    3735         * @see Walker::$db_fields
     
    4341         * Starts the element output.
    4442         *
    4543         * @since 2.1.0
    46          * @access public
    4744         *
    4845         * @see Walker::start_el()
    4946         *
  • src/wp-includes/class-walker-page.php

     
    2020         * What the class handles.
    2121         *
    2222         * @since 2.1.0
    23          * @access public
    2423         * @var string
    2524         *
    2625         * @see Walker::$tree_type
     
    3130         * Database fields to use.
    3231         *
    3332         * @since 2.1.0
    34          * @access private
    3533         * @var array
    3634         *
    3735         * @see Walker::$db_fields
     
    4341         * Outputs the beginning of the current level in the tree before elements are output.
    4442         *
    4543         * @since 2.1.0
    46          * @access public
    4744         *
    4845         * @see Walker::start_lvl()
    4946         *
     
    6865         * Outputs the end of the current level in the tree after elements are output.
    6966         *
    7067         * @since 2.1.0
    71          * @access public
    7268         *
    7369         * @see Walker::end_lvl()
    7470         *
     
    9490         *
    9591         * @see Walker::start_el()
    9692         * @since 2.1.0
    97          * @access public
    9893         *
    9994         * @param string  $output       Used to append additional content. Passed by reference.
    10095         * @param WP_Post $page         Page data object.
     
    214209         * Outputs the end of the current element in the tree.
    215210         *
    216211         * @since 2.1.0
    217          * @access public
    218212         *
    219213         * @see Walker::end_el()
    220214         *
  • src/wp-includes/class-wp-admin-bar.php

     
    3333        }
    3434
    3535        /**
    36          * @access public
    3736         */
    3837        public function initialize() {
    3938                $this->user = new stdClass;
     
    10099         *
    101100         * @since 3.1.0
    102101         * @since 4.5.0 Added the ability to pass 'lang' and 'dir' meta data.
    103          * @access public
    104102         *
    105103         * @param array $args {
    106104         *     Arguments for adding a node.
     
    258256        }
    259257
    260258        /**
    261          * @access public
    262259         */
    263260        public function render() {
    264261                $root = $this->_bind();
     
    572569        }
    573570
    574571        /**
    575          * @access public
    576572         */
    577573        public function add_menus() {
    578574                // User related, aligned right.
  • src/wp-includes/class-wp-ajax-response.php

     
    3939         *     </response>
    4040         *
    4141         * @since 2.1.0
    42          * @access public
    4342         *
    4443         * @param string|array $args {
    4544         *     Optional. An array or string of XML response arguments.
  • src/wp-includes/class-wp-comment-query.php

     
    2020         * SQL for database query.
    2121         *
    2222         * @since 4.0.1
    23          * @access public
    2423         * @var string
    2524         */
    2625        public $request;
     
    2928         * Metadata query container
    3029         *
    3130         * @since 3.5.0
    32          * @access public
    3331         * @var object WP_Meta_Query
    3432         */
    3533        public $meta_query = false;
     
    3836         * Metadata query clauses.
    3937         *
    4038         * @since 4.4.0
    41          * @access protected
    4239         * @var array
    4340         */
    4441        protected $meta_query_clauses;
     
    4744         * SQL query clauses.
    4845         *
    4946         * @since 4.4.0
    50          * @access protected
    5147         * @var array
    5248         */
    5349        protected $sql_clauses = array(
     
    6561         * Stored after the {@see 'comments_clauses'} filter is run on the compiled WHERE sub-clauses.
    6662         *
    6763         * @since 4.4.2
    68          * @access protected
    6964         * @var string
    7065         */
    7166        protected $filtered_where_clause;
     
    7469         * Date query container
    7570         *
    7671         * @since 3.7.0
    77          * @access public
    7872         * @var object WP_Date_Query
    7973         */
    8074        public $date_query = false;
     
    8377         * Query vars set by the user.
    8478         *
    8579         * @since 3.1.0
    86          * @access public
    8780         * @var array
    8881         */
    8982        public $query_vars;
     
    9285         * Default values for query vars.
    9386         *
    9487         * @since 4.2.0
    95          * @access public
    9688         * @var array
    9789         */
    9890        public $query_var_defaults;
     
    10193         * List of comments located by the query.
    10294         *
    10395         * @since 4.0.0
    104          * @access public
    10596         * @var array
    10697         */
    10798        public $comments;
     
    110101         * The amount of found comments for the current query.
    111102         *
    112103         * @since 4.4.0
    113          * @access public
    114104         * @var int
    115105         */
    116106        public $found_comments = 0;
     
    119109         * The number of pages.
    120110         *
    121111         * @since 4.4.0
    122          * @access public
    123112         * @var int
    124113         */
    125114        public $max_num_pages = 0;
     
    128117         * Make private/protected methods readable for backward compatibility.
    129118         *
    130119         * @since 4.0.0
    131          * @access public
    132120         *
    133121         * @param callable $name      Method to call.
    134122         * @param array    $arguments Arguments to pass when calling.
     
    152140         *              `$hierarchical`, and `$update_comment_post_cache` were added.
    153141         * @since 4.5.0 Introduced the `$author_url` argument.
    154142         * @since 4.6.0 Introduced the `$cache_domain` argument.
    155          * @access public
    156143         *
    157144         * @param string|array $query {
    158145         *     Optional. Array or query string of comment query parameters. Default empty.
     
    317304         *
    318305         * @since 4.2.0 Extracted from WP_Comment_Query::query().
    319306         *
    320          * @access public
    321307         *
    322308         * @param string|array $query WP_Comment_Query arguments. See WP_Comment_Query::__construct()
    323309         */
     
    347333         *              'post__not_in', 'include_unapproved', 'type__in', and 'type__not_in'
    348334         *              arguments to $query_vars.
    349335         * @since 4.2.0 Moved parsing to WP_Comment_Query::parse_query().
    350          * @access public
    351336         *
    352337         * @param string|array $query Array or URL query string of parameters.
    353338         * @return array|int List of comments, or number of comments when 'count' is passed as a query var.
     
    361346         * Get a list of comments matching the query vars.
    362347         *
    363348         * @since 4.2.0
    364          * @access public
    365349         *
    366350         * @global wpdb $wpdb WordPress database abstraction object.
    367351         *
     
    476460         * Used internally to get a list of comment IDs matching the query vars.
    477461         *
    478462         * @since 4.4.0
    479          * @access protected
    480463         *
    481464         * @global wpdb $wpdb WordPress database abstraction object.
    482465         */
     
    906889         * query if the limit clause was used.
    907890         *
    908891         * @since 4.6.0
    909          * @access private
    910892         *
    911893         * @global wpdb $wpdb WordPress database abstraction object.
    912894         */
     
    935917         * the descendant trees for all matched top-level comments.
    936918         *
    937919         * @since 4.4.0
    938          * @access protected
    939          *
     920         *
    940921         * @global wpdb $wpdb WordPress database abstraction object.
    941922         *
    942923         * @param array $comments Array of top-level comments whose descendants should be filled in.
     
    10501031         * Used internally to generate an SQL string for searching across multiple columns
    10511032         *
    10521033         * @since 3.1.0
    1053          * @access protected
    10541034         *
    10551035         * @global wpdb $wpdb WordPress database abstraction object.
    10561036         *
     
    10751055         * Parse and sanitize 'orderby' keys passed to the comment query.
    10761056         *
    10771057         * @since 4.2.0
    1078          * @access protected
    10791058         *
    10801059         * @global wpdb $wpdb WordPress database abstraction object.
    10811060         *
     
    11391118         * Parse an 'order' query variable and cast it to ASC or DESC as necessary.
    11401119         *
    11411120         * @since 4.2.0
    1142          * @access protected
    11431121         *
    11441122         * @param string $order The 'order' query variable.
    11451123         * @return string The sanitized 'order' query variable.
  • src/wp-includes/class-wp-comment.php

     
    1818         * Comment ID.
    1919         *
    2020         * @since 4.4.0
    21          * @access public
    2221         * @var int
    2322         */
    2423        public $comment_ID;
     
    2726         * ID of the post the comment is associated with.
    2827         *
    2928         * @since 4.4.0
    30          * @access public
    3129         * @var int
    3230         */
    3331        public $comment_post_ID = 0;
     
    3634         * Comment author name.
    3735         *
    3836         * @since 4.4.0
    39          * @access public
    4037         * @var string
    4138         */
    4239        public $comment_author = '';
     
    4542         * Comment author email address.
    4643         *
    4744         * @since 4.4.0
    48          * @access public
    4945         * @var string
    5046         */
    5147        public $comment_author_email = '';
     
    5450         * Comment author URL.
    5551         *
    5652         * @since 4.4.0
    57          * @access public
    5853         * @var string
    5954         */
    6055        public $comment_author_url = '';
     
    6358         * Comment author IP address (IPv4 format).
    6459         *
    6560         * @since 4.4.0
    66          * @access public
    6761         * @var string
    6862         */
    6963        public $comment_author_IP = '';
     
    7266         * Comment date in YYYY-MM-DD HH:MM:SS format.
    7367         *
    7468         * @since 4.4.0
    75          * @access public
    7669         * @var string
    7770         */
    7871        public $comment_date = '0000-00-00 00:00:00';
     
    8174         * Comment GMT date in YYYY-MM-DD HH::MM:SS format.
    8275         *
    8376         * @since 4.4.0
    84          * @access public
    8577         * @var string
    8678         */
    8779        public $comment_date_gmt = '0000-00-00 00:00:00';
     
    9082         * Comment content.
    9183         *
    9284         * @since 4.4.0
    93          * @access public
    9485         * @var string
    9586         */
    9687        public $comment_content;
     
    9990         * Comment karma count.
    10091         *
    10192         * @since 4.4.0
    102          * @access public
    10393         * @var int
    10494         */
    10595        public $comment_karma = 0;
     
    10898         * Comment approval status.
    10999         *
    110100         * @since 4.4.0
    111          * @access public
    112101         * @var string
    113102         */
    114103        public $comment_approved = '1';
     
    117106         * Comment author HTTP user agent.
    118107         *
    119108         * @since 4.4.0
    120          * @access public
    121109         * @var string
    122110         */
    123111        public $comment_agent = '';
     
    126114         * Comment type.
    127115         *
    128116         * @since 4.4.0
    129          * @access public
    130117         * @var string
    131118         */
    132119        public $comment_type = '';
     
    135122         * Parent comment ID.
    136123         *
    137124         * @since 4.4.0
    138          * @access public
    139125         * @var int
    140126         */
    141127        public $comment_parent = 0;
     
    144130         * Comment author ID.
    145131         *
    146132         * @since 4.4.0
    147          * @access public
    148133         * @var int
    149134         */
    150135        public $user_id = 0;
     
    153138         * Comment children.
    154139         *
    155140         * @since 4.4.0
    156          * @access protected
    157141         * @var array
    158142         */
    159143        protected $children;
     
    162146         * Whether children have been populated for this comment object.
    163147         *
    164148         * @since 4.4.0
    165          * @access protected
    166149         * @var bool
    167150         */
    168151        protected $populated_children = false;
     
    171154         * Post fields.
    172155         *
    173156         * @since 4.4.0
    174          * @access protected
    175157         * @var array
    176158         */
    177159        protected $post_fields = array( 'post_author', 'post_date', 'post_date_gmt', 'post_content', 'post_title', 'post_excerpt', 'post_status', 'comment_status', 'ping_status', 'post_name', 'to_ping', 'pinged', 'post_modified', 'post_modified_gmt', 'post_content_filtered', 'post_parent', 'guid', 'menu_order', 'post_type', 'post_mime_type', 'comment_count' );
     
    180162         * Retrieves a WP_Comment instance.
    181163         *
    182164         * @since 4.4.0
    183          * @access public
    184165         * @static
    185166         *
    186167         * @global wpdb $wpdb WordPress database abstraction object.
     
    217198         * Populates properties with object vars.
    218199         *
    219200         * @since 4.4.0
    220          * @access public
    221201         *
    222202         * @param WP_Comment $comment Comment object.
    223203         */
     
    231211         * Convert object to array.
    232212         *
    233213         * @since 4.4.0
    234          * @access public
    235214         *
    236215         * @return array Object as array.
    237216         */
     
    243222         * Get the children of a comment.
    244223         *
    245224         * @since 4.4.0
    246          * @access public
    247225         *
    248226         * @param array $args {
    249227         *     Array of arguments used to pass to get_comments() and determine format.
     
    318296         * Used by `WP_Comment_Query` when bulk-filling descendants.
    319297         *
    320298         * @since 4.4.0
    321          * @access public
    322299         *
    323300         * @param WP_Comment $child Child comment.
    324301         */
     
    330307         * Get a child comment by ID.
    331308         *
    332309         * @since 4.4.0
    333          * @access public
    334310         *
    335311         * @param int $child_id ID of the child.
    336312         * @return WP_Comment|bool Returns the comment object if found, otherwise false.
     
    363339         * If `$name` matches a post field, the comment post will be loaded and the post's value checked.
    364340         *
    365341         * @since 4.4.0
    366          * @access public
    367342         *
    368343         * @param string $name Property name.
    369344         * @return bool
     
    381356         * If `$name` matches a post field, the comment post will be loaded and the post's value returned.
    382357         *
    383358         * @since 4.4.0
    384          * @access public
    385359         *
    386360         * @param string $name
    387361         * @return mixed
  • src/wp-includes/class-wp-customize-control.php

     
    2222         * @since 4.1.0
    2323         *
    2424         * @static
    25          * @access protected
    2625         * @var int
    2726         */
    2827        protected static $instance_count = 0;
     
    3130         * Order in which this instance was created in relation to other instances.
    3231         *
    3332         * @since 4.1.0
    34          * @access public
    3533         * @var int
    3634         */
    3735        public $instance_number;
     
    4038         * Customizer manager.
    4139         *
    4240         * @since 3.4.0
    43          * @access public
    4441         * @var WP_Customize_Manager
    4542         */
    4643        public $manager;
     
    4946         * Control ID.
    5047         *
    5148         * @since 3.4.0
    52          * @access public
    5349         * @var string
    5450         */
    5551        public $id;
     
    5854         * All settings tied to the control.
    5955         *
    6056         * @since 3.4.0
    61          * @access public
    6257         * @var array
    6358         */
    6459        public $settings;
     
    6762         * The primary setting for the control (if there is one).
    6863         *
    6964         * @since 3.4.0
    70          * @access public
    7165         * @var string
    7266         */
    7367        public $setting = 'default';
     
    7973         * of the associated `$settings`.
    8074         *
    8175         * @since 4.5.0
    82          * @access public
    8376         * @var string
    8477         */
    8578        public $capability;
     
    8881         * Order priority to load the control in Customizer.
    8982         *
    9083         * @since 3.4.0
    91          * @access public
    9284         * @var int
    9385         */
    9486        public $priority = 10;
     
    9789         * Section the control belongs to.
    9890         *
    9991         * @since 3.4.0
    100          * @access public
    10192         * @var string
    10293         */
    10394        public $section = '';
     
    10697         * Label for the control.
    10798         *
    10899         * @since 3.4.0
    109          * @access public
    110100         * @var string
    111101         */
    112102        public $label = '';
     
    115105         * Description for the control.
    116106         *
    117107         * @since 4.0.0
    118          * @access public
    119108         * @var string
    120109         */
    121110        public $description = '';
     
    124113         * List of choices for 'radio' or 'select' type controls, where values are the keys, and labels are the values.
    125114         *
    126115         * @since 3.4.0
    127          * @access public
    128116         * @var array
    129117         */
    130118        public $choices = array();
     
    135123         * Not used for 'checkbox', 'radio', 'select', 'textarea', or 'dropdown-pages' control types.
    136124         *
    137125         * @since 4.0.0
    138          * @access public
    139126         * @var array
    140127         */
    141128        public $input_attrs = array();
     
    144131         * Show UI for adding new content, currently only used for the dropdown-pages control.
    145132         *
    146133         * @since 4.7.0
    147          * @access public
    148134         * @var bool
    149135         */
    150136        public $allow_addition = false;
     
    152138        /**
    153139         * @deprecated It is better to just call the json() method
    154140         * @since 3.4.0
    155          * @access public
    156141         * @var array
    157142         */
    158143        public $json = array();
     
    161146         * Control's Type.
    162147         *
    163148         * @since 3.4.0
    164          * @access public
    165149         * @var string
    166150         */
    167151        public $type = 'text';
     
    170154         * Callback.
    171155         *
    172156         * @since 4.0.0
    173          * @access public
    174157         *
    175158         * @see WP_Customize_Control::active()
    176159         *
  • src/wp-includes/class-wp-customize-manager.php

     
    2525         * An instance of the theme being previewed.
    2626         *
    2727         * @since 3.4.0
    28          * @access protected
    2928         * @var WP_Theme
    3029         */
    3130        protected $theme;
     
    3433         * The directory name of the previously active theme (within the theme_root).
    3534         *
    3635         * @since 3.4.0
    37          * @access protected
    3836         * @var string
    3937         */
    4038        protected $original_stylesheet;
     
    4341         * Whether this is a Customizer pageload.
    4442         *
    4543         * @since 3.4.0
    46          * @access protected
    4744         * @var bool
    4845         */
    4946        protected $previewing = false;
     
    5249         * Methods and properties dealing with managing widgets in the Customizer.
    5350         *
    5451         * @since 3.9.0
    55          * @access public
    5652         * @var WP_Customize_Widgets
    5753         */
    5854        public $widgets;
     
    6157         * Methods and properties dealing with managing nav menus in the Customizer.
    6258         *
    6359         * @since 4.3.0
    64          * @access public
    6560         * @var WP_Customize_Nav_Menus
    6661         */
    6762        public $nav_menus;
     
    7065         * Methods and properties dealing with selective refresh in the Customizer preview.
    7166         *
    7267         * @since 4.5.0
    73          * @access public
    7468         * @var WP_Customize_Selective_Refresh
    7569         */
    7670        public $selective_refresh;
     
    7973         * Registered instances of WP_Customize_Setting.
    8074         *
    8175         * @since 3.4.0
    82          * @access protected
    8376         * @var array
    8477         */
    8578        protected $settings = array();
     
    8881         * Sorted top-level instances of WP_Customize_Panel and WP_Customize_Section.
    8982         *
    9083         * @since 4.0.0
    91          * @access protected
    9284         * @var array
    9385         */
    9486        protected $containers = array();
     
    9789         * Registered instances of WP_Customize_Panel.
    9890         *
    9991         * @since 4.0.0
    100          * @access protected
    10192         * @var array
    10293         */
    10394        protected $panels = array();
     
    10697         * List of core components.
    10798         *
    10899         * @since 4.5.0
    109          * @access protected
    110100         * @var array
    111101         */
    112102        protected $components = array( 'widgets', 'nav_menus' );
     
    115105         * Registered instances of WP_Customize_Section.
    116106         *
    117107         * @since 3.4.0
    118          * @access protected
    119108         * @var array
    120109         */
    121110        protected $sections = array();
     
    124113         * Registered instances of WP_Customize_Control.
    125114         *
    126115         * @since 3.4.0
    127          * @access protected
    128116         * @var array
    129117         */
    130118        protected $controls = array();
     
    133121         * Panel types that may be rendered from JS templates.
    134122         *
    135123         * @since 4.3.0
    136          * @access protected
    137124         * @var array
    138125         */
    139126        protected $registered_panel_types = array();
     
    142129         * Section types that may be rendered from JS templates.
    143130         *
    144131         * @since 4.3.0
    145          * @access protected
    146132         * @var array
    147133         */
    148134        protected $registered_section_types = array();
     
    151137         * Control types that may be rendered from JS templates.
    152138         *
    153139         * @since 4.1.0
    154          * @access protected
    155140         * @var array
    156141         */
    157142        protected $registered_control_types = array();
     
    160145         * Initial URL being previewed.
    161146         *
    162147         * @since 4.4.0
    163          * @access protected
    164148         * @var string
    165149         */
    166150        protected $preview_url;
     
    169153         * URL to link the user to when closing the Customizer.
    170154         *
    171155         * @since 4.4.0
    172          * @access protected
    173156         * @var string
    174157         */
    175158        protected $return_url;
     
    178161         * Mapping of 'panel', 'section', 'control' to the ID which should be autofocused.
    179162         *
    180163         * @since 4.4.0
    181          * @access protected
    182164         * @var array
    183165         */
    184166        protected $autofocus = array();
     
    187169         * Messenger channel.
    188170         *
    189171         * @since 4.7.0
    190          * @access protected
    191172         * @var string
    192173         */
    193174        protected $messenger_channel;
     
    203184         * Changeset UUID.
    204185         *
    205186         * @since 4.7.0
    206          * @access private
    207187         * @var string
    208188         */
    209189        private $_changeset_uuid;
     
    212192         * Changeset post ID.
    213193         *
    214194         * @since 4.7.0
    215          * @access private
    216195         * @var int|false
    217196         */
    218197        private $_changeset_post_id;
     
    221200         * Changeset data loaded from a customize_changeset post.
    222201         *
    223202         * @since 4.7.0
    224          * @access private
    225203         * @var array
    226204         */
    227205        private $_changeset_data;
     
    373351         *
    374352         * @since 3.4.0
    375353         * @since 4.2.0 Added `$action` param.
    376          * @access public
    377354         *
    378355         * @param string|null $action Whether the supplied Ajax action is being run.
    379356         * @return bool True if it's an Ajax request, false otherwise.
     
    648625         * Get the changeset UUID.
    649626         *
    650627         * @since 4.7.0
    651          * @access public
    652628         *
    653629         * @return string UUID.
    654630         */
     
    718694         * Get the registered panels.
    719695         *
    720696         * @since 4.0.0
    721          * @access public
    722697         *
    723698         * @return array Panels.
    724699         */
     
    798773         * Find the changeset post ID for a given changeset UUID.
    799774         *
    800775         * @since 4.7.0
    801          * @access public
    802776         *
    803777         * @param string $uuid Changeset UUID.
    804778         * @return int|null Returns post ID on success and null on failure.
     
    835809         * Get the changeset post id for the loaded changeset.
    836810         *
    837811         * @since 4.7.0
    838          * @access public
    839812         *
    840813         * @return int|null Post ID on success or null if there is no post yet saved.
    841814         */
     
    857830         * Get the data stored in a changeset post.
    858831         *
    859832         * @since 4.7.0
    860          * @access protected
    861833         *
    862834         * @param int $post_id Changeset post ID.
    863835         * @return array|WP_Error Changeset data or WP_Error on error.
     
    887859         * Get changeset data.
    888860         *
    889861         * @since 4.7.0
    890          * @access public
    891862         *
    892863         * @return array Changeset data.
    893864         */
     
    913884         * Starter content setting IDs.
    914885         *
    915886         * @since 4.7.0
    916          * @access private
    917887         * @var array
    918888         */
    919889        protected $pending_starter_content_settings_ids = array();
     
    922892         * Import theme starter content into the customized state.
    923893         *
    924894         * @since 4.7.0
    925          * @access public
    926895         *
    927896         * @param array $starter_content Starter content. Defaults to `get_theme_starter_content()`.
    928897         */
     
    13151284         * Ensure that the attachments are valid and that they have slugs and file name/path.
    13161285         *
    13171286         * @since 4.7.0
    1318          * @access private
    13191287         *
    13201288         * @param array $attachments Attachments.
    13211289         * @return array Prepared attachments.
     
    13761344         * Save starter content changeset.
    13771345         *
    13781346         * @since 4.7.0
    1379          * @access private
    13801347         */
    13811348        public function _save_starter_content_changeset() {
    13821349
     
    14851452         * @since 3.4.0
    14861453         * @since 4.1.1 Introduced the `$default` parameter.
    14871454         * @since 4.6.0 `$default` is now returned early when the setting post value is invalid.
    1488          * @access public
    14891455         *
    14901456         * @see WP_REST_Server::dispatch()
    14911457         * @see WP_Rest_Request::sanitize_params()
     
    15201486         * exclusively sourced from `$_POST['customized']`.
    15211487         *
    15221488         * @since 4.2.0
    1523          * @access public
    15241489         *
    15251490         * @param string $setting_id ID for the WP_Customize_Setting instance.
    15261491         * @param mixed  $value      Post value.
     
    16181583         * Filter the X-Frame-Options and Content-Security-Policy headers to ensure frontend can load in customizer.
    16191584         *
    16201585         * @since 4.7.0
    1621          * @access public
    16221586         *
    16231587         * @param array $headers Headers.
    16241588         * @return array Headers.
     
    16341598         * Add customize state query params to a given URL if preview is allowed.
    16351599         *
    16361600         * @since 4.7.0
    1637          * @access public
    16381601         * @see wp_redirect()
    16391602         * @see WP_Customize_Manager::get_allowed_url()
    16401603         *
     
    16801643         *
    16811644         * @since 4.0.0
    16821645         * @deprecated 4.7.0
    1683          * @access public
    16841646         */
    16851647        public function customize_preview_override_404_status() {
    16861648                _deprecated_function( __METHOD__, '4.7.0' );
     
    17101672         * Print CSS for loading indicators for the Customizer preview.
    17111673         *
    17121674         * @since 4.2.0
    1713          * @access public
    17141675         */
    17151676        public function customize_preview_loading_style() {
    17161677                ?><style>
     
    17411702         * work as expected since the parent frame is not being sent the URL to navigate to.
    17421703         *
    17431704         * @since 4.7.0
    1744          * @access public
    17451705         */
    17461706        public function remove_frameless_preview_messenger_channel() {
    17471707                if ( ! $this->messenger_channel ) {
     
    19911951         * after sanitizing are marked invalid.
    19921952         *
    19931953         * @since 4.6.0
    1994          * @access public
    19951954         *
    19961955         * @see WP_REST_Request::has_valid_params()
    19971956         * @see WP_Customize_Setting::validate()
     
    20582017         * `wp.customize.Notification` JS model.
    20592018         *
    20602019         * @since 4.6.0
    2061          * @access public
    20622020         *
    20632021         * @param true|WP_Error $validity Setting validity.
    20642022         * @return true|array If `$validity` was a WP_Error, the error codes will be array-mapped
     
    22252183         * Save the post for the loaded changeset.
    22262184         *
    22272185         * @since 4.7.0
    2228          * @access public
    22292186         *
    22302187         * @param array $args {
    22312188         *     Args for changeset post.
     
    25692526         * Whether a changeset revision should be made.
    25702527         *
    25712528         * @since 4.7.0
    2572          * @access private
    25732529         * @var bool
    25742530         */
    25752531        protected $store_changeset_revision;
     
    25802536         * Note that this will not be called while a changeset post remains in auto-draft status.
    25812537         *
    25822538         * @since 4.7.0
    2583          * @access private
    25842539         *
    25852540         * @param bool    $post_has_changed Whether the post has changed.
    25862541         * @param WP_Post $last_revision    The last revision post object.
     
    26102565         * invoking this method.
    26112566         *
    26122567         * @since 4.7.0
    2613          * @access private
    26142568         * @see _wp_customize_publish_changeset()
    26152569         *
    26162570         * @param int $changeset_post_id ID for customize_changeset post. Defaults to the changeset for the current manager instance.
     
    27612715         * Update stashed theme mod settings.
    27622716         *
    27632717         * @since 4.7.0
    2764          * @access private
    27652718         *
    27662719         * @param array $inactive_theme_mod_settings Mapping of stylesheet to arrays of theme mod settings.
    27672720         * @return array|false Returns array of updated stashed theme mods or false if the update failed or there were no changes.
     
    28652818         * even though they are not directly created statically with code.
    28662819         *
    28672820         * @since 4.2.0
    2868          * @access public
    28692821         *
    28702822         * @param array $setting_ids The setting IDs to add.
    28712823         * @return array The WP_Customize_Setting objects added.
     
    29772929         * Retrieve a customize panel.
    29782930         *
    29792931         * @since 4.0.0
    2980          * @access public
    29812932         *
    29822933         * @param string $id Panel ID to get.
    29832934         * @return WP_Customize_Panel|void Requested panel instance, if set.
     
    29922943         * Remove a customize panel.
    29932944         *
    29942945         * @since 4.0.0
    2995          * @access public
    29962946         *
    29972947         * @param string $id Panel ID to remove.
    29982948         */
     
    30162966         * Registered types are eligible to be rendered via JS and created dynamically.
    30172967         *
    30182968         * @since 4.3.0
    3019          * @access public
    30202969         *
    30212970         * @see WP_Customize_Panel
    30222971         *
     
    30302979         * Render JS templates for all registered panel types.
    30312980         *
    30322981         * @since 4.3.0
    3033          * @access public
    30342982         */
    30352983        public function render_panel_templates() {
    30362984                foreach ( $this->registered_panel_types as $panel_type ) {
     
    30442992         *
    30452993         * @since 3.4.0
    30462994         * @since 4.5.0 Return added WP_Customize_Section instance.
    3047          * @access public
    30482995         *
    30492996         * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
    30502997         * @param array                     $args {
     
    31033050         * Registered types are eligible to be rendered via JS and created dynamically.
    31043051         *
    31053052         * @since 4.3.0
    3106          * @access public
    31073053         *
    31083054         * @see WP_Customize_Section
    31093055         *
     
    31173063         * Render JS templates for all registered section types.
    31183064         *
    31193065         * @since 4.3.0
    3120          * @access public
    31213066         */
    31223067        public function render_section_templates() {
    31233068                foreach ( $this->registered_section_types as $section_type ) {
     
    31313076         *
    31323077         * @since 3.4.0
    31333078         * @since 4.5.0 Return added WP_Customize_Control instance.
    3134          * @access public
    31353079         *
    31363080         * @param WP_Customize_Control|string $id   Customize Control object, or ID.
    31373081         * @param array                       $args {
     
    31973141         * Registered types are eligible to be rendered via JS and created dynamically.
    31983142         *
    31993143         * @since 4.1.0
    3200          * @access public
    32013144         *
    32023145         * @param string $control Name of a custom control which is a subclass of
    32033146         *                        WP_Customize_Control.
     
    32103153         * Render JS templates for all registered control types.
    32113154         *
    32123155         * @since 4.1.0
    3213          * @access public
    32143156         */
    32153157        public function render_control_templates() {
    32163158                foreach ( $this->registered_control_types as $control_type ) {
     
    33503292         * Determine whether the user agent is iOS.
    33513293         *
    33523294         * @since 4.4.0
    3353          * @access public
    33543295         *
    33553296         * @return bool Whether the user agent is iOS.
    33563297         */
     
    33623303         * Get the template string for the Customizer pane document title.
    33633304         *
    33643305         * @since 4.4.0
    3365          * @access public
    33663306         *
    33673307         * @return string The template string for the document title.
    33683308         */
     
    33843324         * URL is validated.
    33853325         *
    33863326         * @since 4.4.0
    3387          * @access public
    33883327         *
    33893328         * @param string $preview_url URL to be previewed.
    33903329         */
     
    33973336         * Get the initial URL to be previewed.
    33983337         *
    33993338         * @since 4.4.0
    3400          * @access public
    34013339         *
    34023340         * @return string URL being previewed.
    34033341         */
     
    34143352         * Determines whether the admin and the frontend are on different domains.
    34153353         *
    34163354         * @since 4.7.0
    3417          * @access public
    34183355         *
    34193356         * @return bool Whether cross-domain.
    34203357         */
     
    34363373         * using the customize_allowed_urls filter.
    34373374         *
    34383375         * @since 4.7.0
    3439          * @access public
    34403376         *
    34413377         * @returns array Allowed URLs.
    34423378         */
     
    34633399         * Get messenger channel.
    34643400         *
    34653401         * @since 4.7.0
    3466          * @access public
    34673402         *
    34683403         * @return string Messenger channel.
    34693404         */
     
    34773412         * URL is validated.
    34783413         *
    34793414         * @since 4.4.0
    3480          * @access public
    34813415         *
    34823416         * @param string $return_url URL for return link.
    34833417         */
     
    34923426         * Get URL to link the user to when closing the Customizer.
    34933427         *
    34943428         * @since 4.4.0
    3495          * @access public
    34963429         *
    34973430         * @return string URL for link to close Customizer.
    34983431         */
     
    35163449         * Set the autofocused constructs.
    35173450         *
    35183451         * @since 4.4.0
    3519          * @access public
    35203452         *
    35213453         * @param array $autofocus {
    35223454         *     Mapping of 'panel', 'section', 'control' to the ID which should be autofocused.
     
    35343466         * Get the autofocused constructs.
    35353467         *
    35363468         * @since 4.4.0
    3537          * @access public
    35383469         *
    35393470         * @return array {
    35403471         *     Mapping of 'panel', 'section', 'control' to the ID which should be autofocused.
     
    42654196         * Add settings from the POST data that were not added with code, e.g. dynamically-created settings for Widgets
    42664197         *
    42674198         * @since 4.2.0
    4268          * @access public
    42694199         *
    42704200         * @see add_dynamic_settings()
    42714201         */
  • src/wp-includes/class-wp-customize-nav-menus.php

     
    2222         * WP_Customize_Manager instance.
    2323         *
    2424         * @since 4.3.0
    25          * @access public
    2625         * @var WP_Customize_Manager
    2726         */
    2827        public $manager;
     
    3130         * Previewed Menus.
    3231         *
    3332         * @since 4.3.0
    34          * @access public
    3533         * @var array
    3634         */
    3735        public $previewed_menus;
     
    4038         * Constructor.
    4139         *
    4240         * @since 4.3.0
    43          * @access public
    4441         *
    4542         * @param object $manager An instance of the WP_Customize_Manager class.
    4643         */
     
    7774         * Adds a nonce for customizing menus.
    7875         *
    7976         * @since 4.5.0
    80          * @access public
    8177         *
    8278         * @param array $nonces Array of nonces.
    8379         * @return array $nonces Modified array of nonces.
     
    9187         * Ajax handler for loading available menu items.
    9288         *
    9389         * @since 4.3.0
    94          * @access public
    9590         */
    9691        public function ajax_load_available_items() {
    9792                check_ajax_referer( 'customize-menus', 'customize-menus-nonce' );
     
    135130         * Performs the post_type and taxonomy queries for loading available menu items.
    136131         *
    137132         * @since 4.3.0
    138          * @access public
    139133         *
    140134         * @param string $type   Optional. Accepts any custom object type and has built-in support for
    141135         *                         'post_type' and 'taxonomy'. Default is 'post_type'.
     
    258252         * Ajax handler for searching available menu items.
    259253         *
    260254         * @since 4.3.0
    261          * @access public
    262255         */
    263256        public function ajax_search_available_items() {
    264257                check_ajax_referer( 'customize-menus', 'customize-menus-nonce' );
     
    292285         * Based on WP_Editor::wp_link_query().
    293286         *
    294287         * @since 4.3.0
    295          * @access public
    296288         *
    297289         * @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
    298290         * @return array Menu items.
     
    395387         * Enqueue scripts and styles for Customizer pane.
    396388         *
    397389         * @since 4.3.0
    398          * @access public
    399390         */
    400391        public function enqueue_scripts() {
    401392                wp_enqueue_style( 'customize-nav-menus' );
     
    480471         * the WP_Customize_Setting constructor.
    481472         *
    482473         * @since 4.3.0
    483          * @access public
    484474         *
    485475         * @param false|array $setting_args The arguments to the WP_Customize_Setting constructor.
    486476         * @param string      $setting_id   ID for dynamic setting, usually coming from `$_POST['customized']`.
     
    505495         * Allow non-statically created settings to be constructed with custom WP_Customize_Setting subclass.
    506496         *
    507497         * @since 4.3.0
    508          * @access public
    509498         *
    510499         * @param string $setting_class WP_Customize_Setting or a subclass.
    511500         * @param string $setting_id    ID for dynamic setting, usually coming from `$_POST['customized']`.
     
    527516         * Add the customizer settings and controls.
    528517         *
    529518         * @since 4.3.0
    530          * @access public
    531519         */
    532520        public function customize_register() {
    533521
     
    708696         * intval because the second argument is not what intval() expects.
    709697         *
    710698         * @since 4.3.0
    711          * @access public
    712699         *
    713700         * @param mixed $value Number to convert.
    714701         * @return int Integer.
     
    722709         *
    723710         * @since 4.3.0
    724711         * @since 4.7.0  Each array item now includes a `$type_label` in in addition to `$title`, `$type`, and `$object`.
    725          * @access public
    726712         *
    727713         * @return array The available menu item types.
    728714         */
     
    772758        /**
    773759         * Add a new `auto-draft` post.
    774760         *
    775          * @access public
    776761         * @since 4.7.0
    777762         *
    778763         * @param array $postarr {
     
    822807        /**
    823808         * Ajax handler for adding a new auto-draft post.
    824809         *
    825          * @access public
    826810         * @since 4.7.0
    827811         */
    828812        public function ajax_insert_auto_draft_post() {
     
    899883         * Templates are imported into the JS use wp.template.
    900884         *
    901885         * @since 4.3.0
    902          * @access public
    903886         */
    904887        public function print_templates() {
    905888                ?>
     
    942925         * Print the html template used to render the add-menu-item frame.
    943926         *
    944927         * @since 4.3.0
    945          * @access public
    946928         */
    947929        public function available_items_template() {
    948930                ?>
     
    1003985         * To be used in the template #available-menu-items.
    1004986         *
    1005987         * @since 4.7.0
    1006          * @access private
    1007988         *
    1008989         * @param array $available_item_type Menu item data to output, including title, type, and label.
    1009990         * @return void
     
    10431024         * Print the markup for available menu item custom links.
    10441025         *
    10451026         * @since 4.7.0
    1046          * @access private
    10471027         *
    10481028         * @return void
    10491029         */
     
    10861066         * Nav menu args used for each instance, keyed by the args HMAC.
    10871067         *
    10881068         * @since 4.3.0
    1089          * @access public
    10901069         * @var array
    10911070         */
    10921071        public $preview_nav_menu_instance_args = array();
     
    10951074         * Filters arguments for dynamic nav_menu selective refresh partials.
    10961075         *
    10971076         * @since 4.5.0
    1098          * @access public
    10991077         *
    11001078         * @param array|false $partial_args Partial args.
    11011079         * @param string      $partial_id   Partial ID.
     
    11261104         * Add hooks for the Customizer preview.
    11271105         *
    11281106         * @since 4.3.0
    1129          * @access public
    11301107         */
    11311108        public function customize_preview_init() {
    11321109                add_action( 'wp_enqueue_scripts', array( $this, 'customize_preview_enqueue_deps' ) );
     
    11401117         * Make the auto-draft status protected so that it can be queried.
    11411118         *
    11421119         * @since 4.7.0
    1143          * @access public
    11441120         *
    11451121         * @global array $wp_post_statuses List of post statuses.
    11461122         */
     
    11531129         * Sanitize post IDs for auto-draft posts created for nav menu items to be published.
    11541130         *
    11551131         * @since 4.7.0
    1156          * @access public
    11571132         *
    11581133         * @param array $value Post IDs.
    11591134         * @returns array Post IDs.
     
    11891164         * post is not an auto-draft.
    11901165         *
    11911166         * @since 4.7.0
    1192          * @access public
    11931167         *
    11941168         * @param WP_Customize_Setting $setting Customizer setting object.
    11951169         */
     
    12191193         * Keep track of the arguments that are being passed to wp_nav_menu().
    12201194         *
    12211195         * @since 4.3.0
    1222          * @access public
    12231196         * @see wp_nav_menu()
    12241197         * @see WP_Customize_Widgets_Partial_Refresh::filter_dynamic_sidebar_params()
    12251198         *
     
    12871260         * Injects attributes into container element.
    12881261         *
    12891262         * @since 4.3.0
    1290          * @access public
    12911263         *
    12921264         * @see wp_nav_menu()
    12931265         *
     
    13121284         * Note that the array is expected to be pre-sorted.
    13131285         *
    13141286         * @since 4.3.0
    1315          * @access public
    13161287         *
    13171288         * @param array $args The arguments to hash.
    13181289         * @return string Hashed nav menu arguments.
     
    13251296         * Enqueue scripts for the Customizer preview.
    13261297         *
    13271298         * @since 4.3.0
    1328          * @access public
    13291299         */
    13301300        public function customize_preview_enqueue_deps() {
    13311301                wp_enqueue_script( 'customize-preview-nav-menus' ); // Note that we have overridden this.
     
    13351305         * Exports data from PHP to JS.
    13361306         *
    13371307         * @since 4.3.0
    1338          * @access public
    13391308         */
    13401309        public function export_preview_data() {
    13411310
     
    13501319         * Export any wp_nav_menu() calls during the rendering of any partials.
    13511320         *
    13521321         * @since 4.5.0
    1353          * @access public
    13541322         *
    13551323         * @param array $response Response.
    13561324         * @return array Response.
     
    13641332         * Render a specific menu via wp_nav_menu() using the supplied arguments.
    13651333         *
    13661334         * @since 4.3.0
    1367          * @access public
    13681335         *
    13691336         * @see wp_nav_menu()
    13701337         *
  • src/wp-includes/class-wp-customize-panel.php

     
    2626         * @since 4.1.0
    2727         *
    2828         * @static
    29          * @access protected
    3029         * @var int
    3130         */
    3231        protected static $instance_count = 0;
     
    3534         * Order in which this instance was created in relation to other instances.
    3635         *
    3736         * @since 4.1.0
    38          * @access public
    3937         * @var int
    4038         */
    4139        public $instance_number;
     
    4442         * WP_Customize_Manager instance.
    4543         *
    4644         * @since 4.0.0
    47          * @access public
    4845         * @var WP_Customize_Manager
    4946         */
    5047        public $manager;
     
    5350         * Unique identifier.
    5451         *
    5552         * @since 4.0.0
    56          * @access public
    5753         * @var string
    5854         */
    5955        public $id;
     
    6258         * Priority of the panel, defining the display order of panels and sections.
    6359         *
    6460         * @since 4.0.0
    65          * @access public
    6661         * @var integer
    6762         */
    6863        public $priority = 160;
     
    7166         * Capability required for the panel.
    7267         *
    7368         * @since 4.0.0
    74          * @access public
    7569         * @var string
    7670         */
    7771        public $capability = 'edit_theme_options';
     
    8074         * Theme feature support for the panel.
    8175         *
    8276         * @since 4.0.0
    83          * @access public
    8477         * @var string|array
    8578         */
    8679        public $theme_supports = '';
     
    8982         * Title of the panel to show in UI.
    9083         *
    9184         * @since 4.0.0
    92          * @access public
    9385         * @var string
    9486         */
    9587        public $title = '';
     
    9890         * Description to show in the UI.
    9991         *
    10092         * @since 4.0.0
    101          * @access public
    10293         * @var string
    10394         */
    10495        public $description = '';
     
    10798         * Auto-expand a section in a panel when the panel is expanded when the panel only has the one section.
    10899         *
    109100         * @since 4.7.4
    110          * @access public
    111101         * @var bool
    112102         */
    113103        public $auto_expand_sole_section = false;
     
    116106         * Customizer sections for this panel.
    117107         *
    118108         * @since 4.0.0
    119          * @access public
    120109         * @var array
    121110         */
    122111        public $sections;
     
    125114         * Type of this panel.
    126115         *
    127116         * @since 4.1.0
    128          * @access public
    129117         * @var string
    130118         */
    131119        public $type = 'default';
     
    134122         * Active callback.
    135123         *
    136124         * @since 4.1.0
    137          * @access public
    138125         *
    139126         * @see WP_Customize_Section::active()
    140127         *
     
    179166         * Check whether panel is active to current Customizer preview.
    180167         *
    181168         * @since 4.1.0
    182          * @access public
    183169         *
    184170         * @return bool Whether the panel is active to the current preview.
    185171         */
     
    207193         * provide an 'active_callback' argument to the constructor.
    208194         *
    209195         * @since 4.1.0
    210          * @access public
    211196         *
    212197         * @return bool Always true.
    213198         */
     
    303288         * Panel containers are now rendered in JS by default, see WP_Customize_Panel::print_template().
    304289         *
    305290         * @since 4.0.0
    306          * @access protected
    307291         */
    308292        protected function render() {}
    309293
     
    313297         * Panel contents are now rendered in JS by default, see WP_Customize_Panel::print_template().
    314298         *
    315299         * @since 4.1.0
    316          * @access protected
    317300         */
    318301        protected function render_content() {}
    319302
     
    347330         * @see WP_Customize_Panel::print_template()
    348331         *
    349332         * @since 4.3.0
    350          * @access protected
    351333         */
    352334        protected function render_template() {
    353335                ?>
     
    370352         * @see WP_Customize_Panel::print_template()
    371353         *
    372354         * @since 4.3.0
    373          * @access protected
    374355         */
    375356        protected function content_template() {
    376357                ?>
  • src/wp-includes/class-wp-customize-section.php

     
    2626         * @since 4.1.0
    2727         *
    2828         * @static
    29          * @access protected
    3029         * @var int
    3130         */
    3231        protected static $instance_count = 0;
     
    3534         * Order in which this instance was created in relation to other instances.
    3635         *
    3736         * @since 4.1.0
    38          * @access public
    3937         * @var int
    4038         */
    4139        public $instance_number;
     
    4442         * WP_Customize_Manager instance.
    4543         *
    4644         * @since 3.4.0
    47          * @access public
    4845         * @var WP_Customize_Manager
    4946         */
    5047        public $manager;
     
    5350         * Unique identifier.
    5451         *
    5552         * @since 3.4.0
    56          * @access public
    5753         * @var string
    5854         */
    5955        public $id;
     
    6258         * Priority of the section which informs load order of sections.
    6359         *
    6460         * @since 3.4.0
    65          * @access public
    6661         * @var integer
    6762         */
    6863        public $priority = 160;
     
    7166         * Panel in which to show the section, making it a sub-section.
    7267         *
    7368         * @since 4.0.0
    74          * @access public
    7569         * @var string
    7670         */
    7771        public $panel = '';
     
    8074         * Capability required for the section.
    8175         *
    8276         * @since 3.4.0
    83          * @access public
    8477         * @var string
    8578         */
    8679        public $capability = 'edit_theme_options';
     
    8982         * Theme feature support for the section.
    9083         *
    9184         * @since 3.4.0
    92          * @access public
    9385         * @var string|array
    9486         */
    9587        public $theme_supports = '';
     
    9890         * Title of the section to show in UI.
    9991         *
    10092         * @since 3.4.0
    101          * @access public
    10293         * @var string
    10394         */
    10495        public $title = '';
     
    10798         * Description to show in the UI.
    10899         *
    109100         * @since 3.4.0
    110          * @access public
    111101         * @var string
    112102         */
    113103        public $description = '';
     
    116106         * Customizer controls for this section.
    117107         *
    118108         * @since 3.4.0
    119          * @access public
    120109         * @var array
    121110         */
    122111        public $controls;
     
    125114         * Type of this section.
    126115         *
    127116         * @since 4.1.0
    128          * @access public
    129117         * @var string
    130118         */
    131119        public $type = 'default';
     
    134122         * Active callback.
    135123         *
    136124         * @since 4.1.0
    137          * @access public
    138125         *
    139126         * @see WP_Customize_Section::active()
    140127         *
     
    149136         * Show the description or hide it behind the help icon.
    150137         *
    151138         * @since 4.7.0
    152          * @access public
    153139         *
    154140         * @var bool Indicates whether the Section's description should be
    155141         *           hidden behind a help icon ("?") in the Section header,
     
    191177         * Check whether section is active to current Customizer preview.
    192178         *
    193179         * @since 4.1.0
    194          * @access public
    195180         *
    196181         * @return bool Whether the section is active to the current preview.
    197182         */
     
    219204         * an 'active_callback' argument to the constructor.
    220205         *
    221206         * @since 4.1.0
    222          * @access public
    223207         *
    224208         * @return true Always true.
    225209         */
     
    331315         * WP_Customize_Manager::register_section_type().
    332316         *
    333317         * @since 4.3.0
    334          * @access public
    335318         *
    336319         * @see WP_Customize_Manager::render_template()
    337320         */
     
    350333         * export custom variables by overriding WP_Customize_Section::json().
    351334         *
    352335         * @since 4.3.0
    353          * @access protected
    354336         *
    355337         * @see WP_Customize_Section::print_template()
    356338         */
  • src/wp-includes/class-wp-customize-setting.php

     
    2121         * Customizer bootstrap instance.
    2222         *
    2323         * @since 3.4.0
    24          * @access public
    2524         * @var WP_Customize_Manager
    2625         */
    2726        public $manager;
     
    3029         * Unique string identifier for the setting.
    3130         *
    3231         * @since 3.4.0
    33          * @access public
    3432         * @var string
    3533         */
    3634        public $id;
     
    3937         * Type of customize settings.
    4038         *
    4139         * @since 3.4.0
    42          * @access public
    4340         * @var string
    4441         */
    4542        public $type = 'theme_mod';
     
    4845         * Capability required to edit this setting.
    4946         *
    5047         * @since 3.4.0
    51          * @access public
    5248         * @var string|array
    5349         */
    5450        public $capability = 'edit_theme_options';
     
    5753         * Feature a theme is required to support to enable this setting.
    5854         *
    5955         * @since 3.4.0
    60          * @access public
    6156         * @var string
    6257         */
    6358        public $theme_supports = '';
     
    6661         * The default value for the setting.
    6762         *
    6863         * @since 3.4.0
    69          * @access public
    7064         * @var string
    7165         */
    7266        public $default = '';
     
    8074         * @link https://developer.wordpress.org/themes/customize-api
    8175         *
    8276         * @since 3.4.0
    83          * @access public
    8477         * @var string
    8578         */
    8679        public $transport = 'refresh';
     
    8982         * Server-side validation callback for the setting's value.
    9083         *
    9184         * @since 4.6.0
    92          * @access public
    9385         * @var callable
    9486         */
    9587        public $validate_callback = '';
     
    9890         * Callback to filter a Customize setting value in un-slashed form.
    9991         *
    10092         * @since 3.4.0
    101          * @access public
    10293         * @var callable
    10394         */
    10495        public $sanitize_callback = '';
     
    10798         * Callback to convert a Customize PHP setting value to a value that is JSON serializable.
    10899         *
    109100         * @since 3.4.0
    110          * @access public
    111101         * @var string
    112102         */
    113103        public $sanitize_js_callback = '';
     
    121111         * from the start.
    122112         *
    123113         * @since 4.2.0
    124          * @access public
    125114         * @var bool
    126115         */
    127116        public $dirty = false;
     
    130119         * ID Data.
    131120         *
    132121         * @since 3.4.0
    133          * @access protected
    134122         * @var array
    135123         */
    136124        protected $id_data = array();
     
    139127         * Whether or not preview() was called.
    140128         *
    141129         * @since 4.4.0
    142          * @access protected
    143130         * @var bool
    144131         */
    145132        protected $is_previewed = false;
     
    149136         *
    150137         * @since 4.4.0
    151138         * @static
    152          * @access protected
    153139         * @var array
    154140         */
    155141        protected static $aggregated_multidimensionals = array();
     
    158144         * Whether the multidimensional setting is aggregated.
    159145         *
    160146         * @since 4.4.0
    161          * @access protected
    162147         * @var bool
    163148         */
    164149        protected $is_multidimensional_aggregated = false;
     
    277262         * The ID for the current site when the preview() method was called.
    278263         *
    279264         * @since 4.2.0
    280          * @access protected
    281265         * @var int
    282266         */
    283267        protected $_previewed_blog_id;
     
    301285         *
    302286         * @see WP_Customize_Setting::preview()
    303287         * @since 4.1.1
    304          * @access protected
    305288         * @var mixed
    306289         */
    307290        protected $_original_value;
  • src/wp-includes/class-wp-customize-widgets.php

     
    2222         * WP_Customize_Manager instance.
    2323         *
    2424         * @since 3.9.0
    25          * @access public
    2625         * @var WP_Customize_Manager
    2726         */
    2827        public $manager;
     
    3130         * All id_bases for widgets defined in core.
    3231         *
    3332         * @since 3.9.0
    34          * @access protected
    3533         * @var array
    3634         */
    3735        protected $core_widget_id_bases = array(
     
    5654
    5755        /**
    5856         * @since 3.9.0
    59          * @access protected
    6057         * @var array
    6158         */
    6259        protected $rendered_sidebars = array();
    6360
    6461        /**
    6562         * @since 3.9.0
    66          * @access protected
    6763         * @var array
    6864         */
    6965        protected $rendered_widgets = array();
    7066
    7167        /**
    7268         * @since 3.9.0
    73          * @access protected
    7469         * @var array
    7570         */
    7671        protected $old_sidebars_widgets = array();
     
    7974         * Mapping of widget ID base to whether it supports selective refresh.
    8075         *
    8176         * @since 4.5.0
    82          * @access protected
    8377         * @var array
    8478         */
    8579        protected $selective_refreshable_widgets;
     
    8882         * Mapping of setting type to setting ID pattern.
    8983         *
    9084         * @since 4.2.0
    91          * @access protected
    9285         * @var array
    9386         */
    9487        protected $setting_id_patterns = array(
     
    10093         * Initial loader.
    10194         *
    10295         * @since 3.9.0
    103          * @access public
    10496         *
    10597         * @param WP_Customize_Manager $manager Customize manager bootstrap instance.
    10698         */
     
    143135         * then this will always return an empty array.
    144136         *
    145137         * @since 4.5.0
    146          * @access public
    147138         *
    148139         * @global WP_Widget_Factory $wp_widget_factory
    149140         *
     
    168159         * Determines if a widget supports selective refresh.
    169160         *
    170161         * @since 4.5.0
    171          * @access public
    172162         *
    173163         * @param string $id_base Widget ID Base.
    174164         * @return bool Whether the widget can be selective refreshed.
     
    182172         * Retrieves the widget setting type given a setting ID.
    183173         *
    184174         * @since 4.2.0
    185          * @access protected
    186175         *
    187176         * @staticvar array $cache
    188177         *
     
    207196         * them up-front so widgets will be initialized properly.
    208197         *
    209198         * @since 4.2.0
    210          * @access public
    211199         */
    212200        public function register_settings() {
    213201                $widget_setting_ids = array();
     
    239227         * Determines the arguments for a dynamically-created setting.
    240228         *
    241229         * @since 4.2.0
    242          * @access public
    243230         *
    244231         * @param false|array $args       The arguments to the WP_Customize_Setting constructor.
    245232         * @param string      $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`.
     
    256243         * Retrieves an unslashed post value or return a default.
    257244         *
    258245         * @since 3.9.0
    259          * @access protected
    260246         *
    261247         * @param string $name    Post value.
    262248         * @param mixed  $default Default post value.
     
    280266         * theme gets switched.
    281267         *
    282268         * @since 3.9.0
    283          * @access public
    284269         *
    285270         * @global array $sidebars_widgets
    286271         * @global array $_wp_sidebars_widgets
     
    313298         * theme_mod.
    314299         *
    315300         * @since 3.9.0
    316          * @access public
    317301         *
    318302         * @see WP_Customize_Widgets::handle_theme_switch()
    319303         *
     
    332316         * option.
    333317         *
    334318         * @since 3.9.0
    335          * @access public
    336319         *
    337320         * @see WP_Customize_Widgets::handle_theme_switch()
    338321         * @global array $sidebars_widgets
     
    352335         * Note: these actions are also fired in wp_ajax_update_widget().
    353336         *
    354337         * @since 3.9.0
    355          * @access public
    356338         */
    357339        public function customize_controls_init() {
    358340                /** This action is documented in wp-admin/includes/ajax-actions.php */
     
    372354         * so that all filters have been initialized (e.g. Widget Visibility).
    373355         *
    374356         * @since 3.9.0
    375          * @access public
    376357         */
    377358        public function schedule_customize_register() {
    378359                if ( is_admin() ) {
     
    386367         * Registers Customizer settings and controls for all sidebars and widgets.
    387368         *
    388369         * @since 3.9.0
    389          * @access public
    390370         *
    391371         * @global array $wp_registered_widgets
    392372         * @global array $wp_registered_widget_controls
     
    537517         * Determines whether the widgets panel is active, based on whether there are sidebars registered.
    538518         *
    539519         * @since 4.4.0
    540          * @access public
    541520         *
    542521         * @see WP_Customize_Panel::$active_callback
    543522         *
     
    553532         * Converts a widget_id into its corresponding Customizer setting ID (option name).
    554533         *
    555534         * @since 3.9.0
    556          * @access public
    557535         *
    558536         * @param string $widget_id Widget ID.
    559537         * @return string Maybe-parsed widget ID.
     
    579557         * overridden with the {@see 'is_wide_widget_in_customizer'} filter.
    580558         *
    581559         * @since 3.9.0
    582          * @access public
    583560         *
    584561         * @global $wp_registered_widget_controls
    585562         *
     
    609586         * Converts a widget ID into its id_base and number components.
    610587         *
    611588         * @since 3.9.0
    612          * @access public
    613589         *
    614590         * @param string $widget_id Widget ID.
    615591         * @return array Array containing a widget's id_base and number components.
     
    634610         * Converts a widget setting ID (option path) to its id_base and number components.
    635611         *
    636612         * @since 3.9.0
    637          * @access public
    638613         *
    639614         * @param string $setting_id Widget setting ID.
    640615         * @return WP_Error|array Array containing a widget's id_base and number components,
     
    656631         * allow custom styles from plugins.
    657632         *
    658633         * @since 3.9.0
    659          * @access public
    660634         */
    661635        public function print_styles() {
    662636                /** This action is documented in wp-admin/admin-header.php */
     
    671645         * allow custom scripts from plugins.
    672646         *
    673647         * @since 3.9.0
    674          * @access public
    675648         */
    676649        public function print_scripts() {
    677650                /** This action is documented in wp-admin/admin-header.php */
     
    685658         * Enqueues scripts and styles for Customizer panel and export data to JavaScript.
    686659         *
    687660         * @since 3.9.0
    688          * @access public
    689661         *
    690662         * @global WP_Scripts $wp_scripts
    691663         * @global array $wp_registered_sidebars
     
    822794         * Renders the widget form control templates into the DOM.
    823795         *
    824796         * @since 3.9.0
    825          * @access public
    826797         */
    827798        public function output_widget_control_templates() {
    828799                ?>
     
    865836         * allow custom scripts from plugins.
    866837         *
    867838         * @since 3.9.0
    868          * @access public
    869839         */
    870840        public function print_footer_scripts() {
    871841                /** This action is documented in wp-admin/admin-footer.php */
     
    882852         * Retrieves common arguments to supply when constructing a Customizer setting.
    883853         *
    884854         * @since 3.9.0
    885          * @access public
    886855         *
    887856         * @param string $id        Widget setting ID.
    888857         * @param array  $overrides Array of setting overrides.
     
    926895         * Used as the 'sanitize_callback' for each $sidebars_widgets setting.
    927896         *
    928897         * @since 3.9.0
    929          * @access public
    930898         *
    931899         * @param array $widget_ids Array of widget IDs.
    932900         * @return array Array of sanitized widget IDs.
     
    944912         * Builds up an index of all available widgets for use in Backbone models.
    945913         *
    946914         * @since 3.9.0
    947          * @access public
    948915         *
    949916         * @global array $wp_registered_widgets
    950917         * @global array $wp_registered_widget_controls
     
    1031998         * Naturally orders available widgets by name.
    1032999         *
    10331000         * @since 3.9.0
    1034          * @access protected
    10351001         *
    10361002         * @param array $widget_a The first widget to compare.
    10371003         * @param array $widget_b The second widget to compare.
     
    10451011         * Retrieves the widget control markup.
    10461012         *
    10471013         * @since 3.9.0
    1048          * @access public
    10491014         *
    10501015         * @param array $args Widget control arguments.
    10511016         * @return string Widget control form HTML markup.
     
    10651030         * Retrieves the widget control markup parts.
    10661031         *
    10671032         * @since 4.4.0
    1068          * @access public
    10691033         *
    10701034         * @param array $args Widget control arguments.
    10711035         * @return array {
     
    10961060         * Adds hooks for the Customizer preview.
    10971061         *
    10981062         * @since 3.9.0
    1099          * @access public
    11001063         */
    11011064        public function customize_preview_init() {
    11021065                add_action( 'wp_enqueue_scripts', array( $this, 'customize_preview_enqueue' ) );
     
    11081071         * Refreshes the nonce for widget updates.
    11091072         *
    11101073         * @since 4.2.0
    1111          * @access public
    11121074         *
    11131075         * @param  array $nonces Array of nonces.
    11141076         * @return array $nonces Array of nonces.
     
    11271089         * filter is added, it has to be reset after the filter has been added.
    11281090         *
    11291091         * @since 3.9.0
    1130          * @access public
    11311092         *
    11321093         * @param array $sidebars_widgets List of widgets for the current sidebar.
    11331094         * @return array
     
    11431104         * Enqueues scripts for the Customizer preview.
    11441105         *
    11451106         * @since 3.9.0
    1146          * @access public
    11471107         */
    11481108        public function customize_preview_enqueue() {
    11491109                wp_enqueue_script( 'customize-preview-widgets' );
     
    11541114         * stylesheet can override.
    11551115         *
    11561116         * @since 3.9.0
    1157          * @access public
    11581117         */
    11591118        public function print_preview_css() {
    11601119                ?>
     
    12151174         * Tracks the widgets that were rendered.
    12161175         *
    12171176         * @since 3.9.0
    1218          * @access public
    12191177         *
    12201178         * @param array $widget Rendered widget to tally.
    12211179         */
     
    12271185         * Determine if a widget is rendered on the page.
    12281186         *
    12291187         * @since 4.0.0
    1230          * @access public
    12311188         *
    12321189         * @param string $widget_id Widget ID to check.
    12331190         * @return bool Whether the widget is rendered.
     
    12401197         * Determines if a sidebar is rendered on the page.
    12411198         *
    12421199         * @since 4.0.0
    1243          * @access public
    12441200         *
    12451201         * @param string $sidebar_id Sidebar ID to check.
    12461202         * @return bool Whether the sidebar is rendered.
     
    12571213         * if there were widgets populating it.
    12581214         *
    12591215         * @since 3.9.0
    1260          * @access public
    12611216         *
    12621217         * @param bool   $is_active  Whether the sidebar is active.
    12631218         * @param string $sidebar_id Sidebar ID.
     
    12831238         * there were widgets populating it.
    12841239         *
    12851240         * @since 3.9.0
    1286          * @access public
    12871241         *
    12881242         * @param bool   $has_widgets Whether the current sidebar has widgets.
    12891243         * @param string $sidebar_id  Sidebar ID.
     
    13091263         * data has occurred.
    13101264         *
    13111265         * @since 3.9.0
    1312          * @access protected
    13131266         *
    13141267         * @param string $serialized_instance Widget instance.
    13151268         * @return string MAC for serialized widget instance.
     
    13251278         * only get applied to an instance *once*.
    13261279         *
    13271280         * @since 3.9.0
    1328          * @access public
    13291281         *
    13301282         * @param array $value Widget instance to sanitize.
    13311283         * @return array|void Sanitized widget instance.
     
    13631315         * Converts a widget instance into JSON-representable format.
    13641316         *
    13651317         * @since 3.9.0
    1366          * @access public
    13671318         *
    13681319         * @param array $value Widget instance to convert to JSON.
    13691320         * @return array JSON-converted widget instance.
     
    13891340         * in a sidebar upon deactivation.
    13901341         *
    13911342         * @since 3.9.0
    1392          * @access public
    13931343         *
    13941344         * @global array $wp_registered_widgets
    13951345         *
     
    14081358         * Requires that `$_POST` be populated with the instance data.
    14091359         *
    14101360         * @since 3.9.0
    1411          * @access public
    14121361         *
    14131362         * @global array $wp_registered_widget_updates
    14141363         * @global array $wp_registered_widget_controls
     
    15381487         * Most code here copied from wp_ajax_save_widget().
    15391488         *
    15401489         * @since 3.9.0
    1541          * @access public
    15421490         *
    15431491         * @see wp_ajax_save_widget()
    15441492         */
     
    16011549         * Filters arguments for dynamic widget partials.
    16021550         *
    16031551         * @since 4.5.0
    1604          * @access public
    16051552         *
    16061553         * @param array|false $partial_args Partial arguments.
    16071554         * @param string      $partial_id   Partial ID.
     
    16351582         * Adds hooks for selective refresh.
    16361583         *
    16371584         * @since 4.5.0
    1638          * @access public
    16391585         */
    16401586        public function selective_refresh_init() {
    16411587                if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
     
    17111657         * data-* attributes can be whitelisted.
    17121658         *
    17131659         * @since 4.5.0
    1714          * @access protected
    17151660         * @var array
    17161661         */
    17171662        protected $before_widget_tags_seen = array();
     
    17221667         * This is needed in case the `$before_widget` is run through wp_kses() when printed.
    17231668         *
    17241669         * @since 4.5.0
    1725          * @access public
    17261670         *
    17271671         * @param array $allowed_html Allowed HTML.
    17281672         * @return array (Maybe) modified allowed HTML.
     
    17521696         * This helps facilitate the uncommon scenario where a single sidebar is rendered multiple times on a template.
    17531697         *
    17541698         * @since 4.5.0
    1755          * @access protected
    17561699         * @var array
    17571700         */
    17581701        protected $sidebar_instance_count = array();
     
    17611704         * The current request's sidebar_instance_number context.
    17621705         *
    17631706         * @since 4.5.0
    1764          * @access protected
    17651707         * @var int
    17661708         */
    17671709        protected $context_sidebar_instance_number;
     
    17701712         * Current sidebar ID being rendered.
    17711713         *
    17721714         * @since 4.5.0
    1773          * @access protected
    17741715         * @var array
    17751716         */
    17761717        protected $current_dynamic_sidebar_id_stack = array();
     
    17811722         * Insert marker before widgets are rendered in a dynamic sidebar.
    17821723         *
    17831724         * @since 4.5.0
    1784          * @access public
    17851725         *
    17861726         * @param int|string $index Index, name, or ID of the dynamic sidebar.
    17871727         */
     
    18021742         * Inserts a marker after widgets are rendered in a dynamic sidebar.
    18031743         *
    18041744         * @since 4.5.0
    1805          * @access public
    18061745         *
    18071746         * @param int|string $index Index, name, or ID of the dynamic sidebar.
    18081747         */
     
    18171756         * Current sidebar being rendered.
    18181757         *
    18191758         * @since 4.5.0
    1820          * @access protected
    18211759         * @var string
    18221760         */
    18231761        protected $rendering_widget_id;
     
    18261764         * Current widget being rendered.
    18271765         *
    18281766         * @since 4.5.0
    1829          * @access protected
    18301767         * @var string
    18311768         */
    18321769        protected $rendering_sidebar_id;
     
    18351772         * Filters sidebars_widgets to ensure the currently-rendered widget is the only widget in the current sidebar.
    18361773         *
    18371774         * @since 4.5.0
    1838          * @access protected
    18391775         *
    18401776         * @param array $sidebars_widgets Sidebars widgets.
    18411777         * @return array Filtered sidebars widgets.
     
    18491785         * Renders a specific widget using the supplied sidebar arguments.
    18501786         *
    18511787         * @since 4.5.0
    1852          * @access public
    18531788         *
    18541789         * @see dynamic_sidebar()
    18551790         *
     
    19081843         * List of captured widget option updates.
    19091844         *
    19101845         * @since 3.9.0
    1911          * @access protected
    19121846         * @var array $_captured_options Values updated while option capture is happening.
    19131847         */
    19141848        protected $_captured_options = array();
     
    19171851         * Whether option capture is currently happening.
    19181852         *
    19191853         * @since 3.9.0
    1920          * @access protected
    19211854         * @var bool $_is_current Whether option capture is currently happening or not.
    19221855         */
    19231856        protected $_is_capturing_option_updates = false;
     
    19261859         * Determines whether the captured option update should be ignored.
    19271860         *
    19281861         * @since 3.9.0
    1929          * @access protected
    19301862         *
    19311863         * @param string $option_name Option name.
    19321864         * @return bool Whether the option capture is ignored.
     
    19391871         * Retrieves captured widget option updates.
    19401872         *
    19411873         * @since 3.9.0
    1942          * @access protected
    19431874         *
    19441875         * @return array Array of captured options.
    19451876         */
     
    19511882         * Retrieves the option that was captured from being saved.
    19521883         *
    19531884         * @since 4.2.0
    1954          * @access protected
    19551885         *
    19561886         * @param string $option_name Option name.
    19571887         * @param mixed  $default     Optional. Default value to return if the option does not exist. Default false.
     
    19701900         * Retrieves the number of captured widget option updates.
    19711901         *
    19721902         * @since 3.9.0
    1973          * @access protected
    19741903         *
    19751904         * @return int Number of updated options.
    19761905         */
     
    19821911         * Begins keeping track of changes to widget options, caching new values.
    19831912         *
    19841913         * @since 3.9.0
    1985          * @access protected
    19861914         */
    19871915        protected function start_capturing_option_updates() {
    19881916                if ( $this->_is_capturing_option_updates ) {
     
    19981926         * Pre-filters captured option values before updating.
    19991927         *
    20001928         * @since 3.9.0
    2001          * @access public
    20021929         *
    20031930         * @param mixed  $new_value   The new option value.
    20041931         * @param string $option_name Name of the option.
     
    20231950         * Pre-filters captured option values before retrieving.
    20241951         *
    20251952         * @since 3.9.0
    2026          * @access public
    20271953         *
    20281954         * @param mixed $value Value to return instead of the option value.
    20291955         * @return mixed Filtered option value.
     
    20451971         * Undoes any changes to the options since options capture began.
    20461972         *
    20471973         * @since 3.9.0
    2048          * @access protected
    20491974         */
    20501975        protected function stop_capturing_option_updates() {
    20511976                if ( ! $this->_is_capturing_option_updates ) {
  • src/wp-includes/class-wp-dependency.php

     
    2020        /**
    2121         * The handle name.
    2222         *
    23          * @access public
    2423         * @since 2.6.0
    2524         * @var null
    2625         */
     
    2928        /**
    3029         * The handle source.
    3130         *
    32          * @access public
    3331         * @since 2.6.0
    3432         * @var null
    3533         */
     
    3836        /**
    3937         * An array of handle dependencies.
    4038         *
    41          * @access public
    4239         * @since 2.6.0
    4340         * @var array
    4441         */
     
    4946         *
    5047         * Used for cache-busting.
    5148         *
    52          * @access public
    5349         * @since 2.6.0
    5450         * @var bool|string
    5551         */
     
    5854        /**
    5955         * Additional arguments for the handle.
    6056         *
    61          * @access public
    6257         * @since 2.6.0
    6358         * @var null
    6459         */
     
    6762        /**
    6863         * Extra data to supply to the handle.
    6964         *
    70          * @access public
    7165         * @since 2.6.0
    7266         * @var array
    7367         */
     
    8781        /**
    8882         * Add handle data.
    8983         *
    90          * @access public
    9184         * @since 2.6.0
    9285         *
    9386         * @param string $name The data key to add.
  • src/wp-includes/class-wp-embed.php

     
    2020         *
    2121         * Bypasses the {@see 'embed_maybe_make_link'} filter.
    2222         *
    23          * @access public
    2423         * @var bool
    2524         */
    2625        public $return_false_on_fail = false;
  • src/wp-includes/class-wp-error.php

     
    6565         * Retrieve all error codes.
    6666         *
    6767         * @since 2.1.0
    68          * @access public
    6968         *
    7069         * @return array List of error codes, if available.
    7170         */
     
    8079         * Retrieve first error code available.
    8180         *
    8281         * @since 2.1.0
    83          * @access public
    8482         *
    8583         * @return string|int Empty string, if no error codes.
    8684         */
     
    157155         * Add an error or append additional message to an existing error.
    158156         *
    159157         * @since 2.1.0
    160          * @access public
    161158         *
    162159         * @param string|int $code Error code.
    163160         * @param string $message Error message.
  • src/wp-includes/class-wp-feed-cache-transient.php

     
    1818         * Holds the transient name.
    1919         *
    2020         * @since 2.8.0
    21          * @access public
    2221         * @var string
    2322         */
    2423        public $name;
     
    2726         * Holds the transient mod name.
    2827         *
    2928         * @since 2.8.0
    30          * @access public
    3129         * @var string
    3230         */
    3331        public $mod_name;
     
    3836         * Defaults to 43200 seconds (12 hours).
    3937         *
    4038         * @since 2.8.0
    41          * @access public
    4239         * @var int
    4340         */
    4441        public $lifetime = 43200;
     
    4845         *
    4946         * @since 2.8.0
    5047         * @since 3.2.0 Updated to use a PHP5 constructor.
    51          * @access public
    5248         *
    5349         * @param string $location  URL location (scheme is used to determine handler).
    5450         * @param string $filename  Unique identifier for cache object.
     
    7470         * Sets the transient.
    7571         *
    7672         * @since 2.8.0
    77          * @access public
    7873         *
    7974         * @param SimplePie $data Data to save.
    8075         * @return true Always true.
     
    9388         * Gets the transient.
    9489         *
    9590         * @since 2.8.0
    96          * @access public
    9791         *
    9892         * @return mixed Transient value.
    9993         */
     
    10599         * Gets mod transient.
    106100         *
    107101         * @since 2.8.0
    108          * @access public
    109102         *
    110103         * @return mixed Transient value.
    111104         */
     
    117110         * Sets mod transient.
    118111         *
    119112         * @since 2.8.0
    120          * @access public
    121113         *
    122114         * @return bool False if value was not set and true if value was set.
    123115         */
     
    129121         * Deletes transients.
    130122         *
    131123         * @since 2.8.0
    132          * @access public
    133124         *
    134125         * @return true Always true.
    135126         */
  • src/wp-includes/class-wp-feed-cache.php

     
    2020         * Creates a new SimplePie_Cache object.
    2121         *
    2222         * @since 2.8.0
    23          * @access public
    2423         *
    2524         * @param string $location  URL location (scheme is used to determine handler).
    2625         * @param string $filename  Unique identifier for cache object.
  • src/wp-includes/class-wp-hook.php

     
    2121         * Hook callbacks.
    2222         *
    2323         * @since 4.7.0
    24          * @access public
    2524         * @var array
    2625         */
    2726        public $callbacks = array();
     
    3029         * The priority keys of actively running iterations of a hook.
    3130         *
    3231         * @since 4.7.0
    33          * @access private
    3432         * @var array
    3533         */
    3634        private $iterations = array();
     
    3937         * The current priority of actively running iterations of a hook.
    4038         *
    4139         * @since 4.7.0
    42          * @access private
    4340         * @var array
    4441         */
    4542        private $current_priority = array();
     
    4845         * Number of levels this hook can be recursively called.
    4946         *
    5047         * @since 4.7.0
    51          * @access private
    5248         * @var int
    5349         */
    5450        private $nesting_level = 0;
     
    5753         * Flag for if we're current doing an action, rather than a filter.
    5854         *
    5955         * @since 4.7.0
    60          * @access private
    6156         * @var bool
    6257         */
    6358        private $doing_action = false;
     
    6661         * Hooks a function or method to a specific filter action.
    6762         *
    6863         * @since 4.7.0
    69          * @access public
    7064         *
    7165         * @param string   $tag             The name of the filter to hook the $function_to_add callback to.
    7266         * @param callable $function_to_add The callback to be run when the filter is applied.
     
    9993         * Handles reseting callback priority keys mid-iteration.
    10094         *
    10195         * @since 4.7.0
    102          * @access private
    10396         *
    10497         * @param bool|int $new_priority     Optional. The priority of the new filter being added. Default false,
    10598         *                                   for no priority being added.
     
    168161         * Unhooks a function or method from a specific filter action.
    169162         *
    170163         * @since 4.7.0
    171          * @access public
    172164         *
    173165         * @param string   $tag                The filter hook to which the function to be removed is hooked. Used
    174166         *                                     for building the callback ID when SPL is not available.
     
    196188         * Checks if a specific action has been registered for this hook.
    197189         *
    198190         * @since 4.7.0
    199          * @access public
    200191         *
    201192         * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
    202193         * @param string        $tag               Optional. The name of the filter hook. Used for building
     
    226217         * Checks if any callbacks have been registered for this hook.
    227218         *
    228219         * @since 4.7.0
    229          * @access public
    230220         *
    231221         * @return bool True if callbacks have been registered for the current hook, otherwise false.
    232222         */
     
    243233         * Removes all callbacks from the current filter.
    244234         *
    245235         * @since 4.7.0
    246          * @access public
    247236         *
    248237         * @param int|bool $priority Optional. The priority number to remove. Default false.
    249238         */
     
    267256         * Calls the callback functions added to a filter hook.
    268257         *
    269258         * @since 4.7.0
    270          * @access public
    271259         *
    272260         * @param mixed $value The value to filter.
    273261         * @param array $args  Arguments to pass to callbacks.
     
    314302         * Executes the callback functions hooked on a specific action hook.
    315303         *
    316304         * @since 4.7.0
    317          * @access public
    318305         *
    319306         * @param mixed $args Arguments to pass to the hook callbacks.
    320307         */
     
    332319         * Processes the functions hooked into the 'all' hook.
    333320         *
    334321         * @since 4.7.0
    335          * @access public
    336322         *
    337323         * @param array $args Arguments to pass to the hook callbacks. Passed by reference.
    338324         */
     
    355341         * Return the current priority level of the currently running iteration of the hook.
    356342         *
    357343         * @since 4.7.0
    358          * @access public
    359344         *
    360345         * @return int|false If the hook is running, return the current priority level. If it isn't running, return false.
    361346         */
     
    371356         * Normalizes filters set up before WordPress has initialized to WP_Hook objects.
    372357         *
    373358         * @since 4.7.0
    374          * @access public
    375359         * @static
    376360         *
    377361         * @param array $filters Filters to normalize.
     
    405389         * Determines whether an offset value exists.
    406390         *
    407391         * @since 4.7.0
    408          * @access public
    409392         *
    410393         * @link https://secure.php.net/manual/en/arrayaccess.offsetexists.php
    411394         *
     
    420403         * Retrieves a value at a specified offset.
    421404         *
    422405         * @since 4.7.0
    423          * @access public
    424406         *
    425407         * @link https://secure.php.net/manual/en/arrayaccess.offsetget.php
    426408         *
     
    435417         * Sets a value at a specified offset.
    436418         *
    437419         * @since 4.7.0
    438          * @access public
    439420         *
    440421         * @link https://secure.php.net/manual/en/arrayaccess.offsetset.php
    441422         *
     
    454435         * Unsets a specified offset.
    455436         *
    456437         * @since 4.7.0
    457          * @access public
    458438         *
    459439         * @link https://secure.php.net/manual/en/arrayaccess.offsetunset.php
    460440         *
     
    468448         * Returns the current element.
    469449         *
    470450         * @since 4.7.0
    471          * @access public
    472451         *
    473452         * @link https://secure.php.net/manual/en/iterator.current.php
    474453         *
     
    482461         * Moves forward to the next element.
    483462         *
    484463         * @since 4.7.0
    485          * @access public
    486464         *
    487465         * @link https://secure.php.net/manual/en/iterator.next.php
    488466         *
     
    496474         * Returns the key of the current element.
    497475         *
    498476         * @since 4.7.0
    499          * @access public
    500477         *
    501478         * @link https://secure.php.net/manual/en/iterator.key.php
    502479         *
     
    510487         * Checks if current position is valid.
    511488         *
    512489         * @since 4.7.0
    513          * @access public
    514490         *
    515491         * @link https://secure.php.net/manual/en/iterator.valid.php
    516492         *
     
    524500         * Rewinds the Iterator to the first element.
    525501         *
    526502         * @since 4.7.0
    527          * @access public
    528503         *
    529504         * @link https://secure.php.net/manual/en/iterator.rewind.php
    530505         */
  • src/wp-includes/class-wp-http-cookie.php

     
    6767         * or a header string detailing it.
    6868         *
    6969         * @since 2.8.0
    70          * @access public
    7170         *
    7271         * @param string|array $data {
    7372         *     Raw cookie data as header string or data array.
     
    140139         *
    141140         * Decision is based on RFC 2109/2965, so look there for details on validity.
    142141         *
    143          * @access public
    144142         * @since 2.8.0
    145143         *
    146144         * @param string $url URL you intend to send this cookie to
     
    185183        /**
    186184         * Convert cookie name and value back to header string.
    187185         *
    188          * @access public
    189186         * @since 2.8.0
    190187         *
    191188         * @return string Header encoded cookie name and value.
     
    208205        /**
    209206         * Retrieve cookie header for usage in the rest of the WordPress HTTP API.
    210207         *
    211          * @access public
    212208         * @since 2.8.0
    213209         *
    214210         * @return string
     
    221217         * Retrieves cookie attributes.
    222218         *
    223219         * @since 4.6.0
    224          * @access public
    225220         *
    226221         * @return array {
    227222         *    List of attributes.
  • src/wp-includes/class-wp-http-curl.php

     
    2222         * Temporary header storage for during requests.
    2323         *
    2424         * @since 3.2.0
    25          * @access private
    2625         * @var string
    2726         */
    2827        private $headers = '';
     
    3130         * Temporary body storage for during requests.
    3231         *
    3332         * @since 3.6.0
    34          * @access private
    3533         * @var string
    3634         */
    3735        private $body = '';
     
    4038         * The maximum amount of data to receive from the remote server.
    4139         *
    4240         * @since 3.6.0
    43          * @access private
    4441         * @var int
    4542         */
    4643        private $max_body_length = false;
     
    4946         * The file resource used for streaming to file.
    5047         *
    5148         * @since 3.6.0
    52          * @access private
    5349         * @var resource
    5450         */
    5551        private $stream_handle = false;
     
    5854         * The total bytes written in the current request.
    5955         *
    6056         * @since 4.1.0
    61          * @access private
    6257         * @var int
    6358         */
    6459        private $bytes_written_total = 0;
     
    6661        /**
    6762         * Send a HTTP request to a URI using cURL extension.
    6863         *
    69          * @access public
    7064         * @since 2.7.0
    7165         *
    7266         * @param string $url The request URL.
     
    304298         * for temporary storage
    305299         *
    306300         * @since 3.2.0
    307          * @access private
    308301         *
    309302         * @param resource $handle  cURL handle.
    310303         * @param string   $headers cURL request headers.
     
    323316         * `$data` passed in will cause cURL to abort the request with `CURLE_WRITE_ERROR`.
    324317         *
    325318         * @since 3.6.0
    326          * @access private
    327319         *
    328320         * @param resource $handle  cURL handle.
    329321         * @param string   $data    cURL request body.
  • src/wp-includes/class-wp-http-requests-response.php

     
    1919         * Requests Response object.
    2020         *
    2121         * @since 4.6.0
    22          * @access protected
    2322         * @var Requests_Response
    2423         */
    2524        protected $response;
     
    2827         * Filename the response was saved to.
    2928         *
    3029         * @since 4.6.0
    31          * @access protected
    3230         * @var string|null
    3331         */
    3432        protected $filename;
     
    3735         * Constructor.
    3836         *
    3937         * @since 4.6.0
    40          * @access public
    4138         *
    4239         * @param Requests_Response $response HTTP response.
    4340         * @param string            $filename Optional. File name. Default empty.
     
    5148         * Retrieves the response object for the request.
    5249         *
    5350         * @since 4.6.0
    54          * @access public
    5551         *
    5652         * @return Requests_Response HTTP response.
    5753         */
     
    6359         * Retrieves headers associated with the response.
    6460         *
    6561         * @since 4.6.0
    66          * @access public
    6762         *
    6863         * @see \Requests_Utility_CaseInsensitiveDictionary
    6964         *
     
    8883         * Sets all header values.
    8984         *
    9085         * @since 4.6.0
    91          * @access public
    9286         *
    9387         * @param array $headers Map of header name to header value.
    9488         */
     
    10094         * Sets a single HTTP header.
    10195         *
    10296         * @since 4.6.0
    103          * @access public
    10497         *
    10598         * @param string $key     Header name.
    10699         * @param string $value   Header value.
     
    119112         * Retrieves the HTTP return code for the response.
    120113         *
    121114         * @since 4.6.0
    122          * @access public
    123115         *
    124116         * @return int The 3-digit HTTP status code.
    125117         */
     
    131123         * Sets the 3-digit HTTP status code.
    132124         *
    133125         * @since 4.6.0
    134          * @access public
    135126         *
    136127         * @param int $code HTTP status.
    137128         */
     
    143134         * Retrieves the response data.
    144135         *
    145136         * @since 4.6.0
    146          * @access public
    147137         *
    148138         * @return mixed Response data.
    149139         */
     
    155145         * Sets the response data.
    156146         *
    157147         * @since 4.6.0
    158          * @access public
    159148         *
    160149         * @param mixed $data Response data.
    161150         */
     
    167156         * Retrieves cookies from the response.
    168157         *
    169158         * @since 4.6.0
    170          * @access public
    171159         *
    172160         * @return WP_HTTP_Cookie[] List of cookie objects.
    173161         */
     
    190178         * Converts the object to a WP_Http response array.
    191179         *
    192180         * @since 4.6.0
    193          * @access public
    194181         *
    195182         * @return array WP_Http response array, per WP_Http::request().
    196183         */
  • src/wp-includes/class-wp-http-response.php

     
    1818         * Response data.
    1919         *
    2020         * @since 4.4.0
    21          * @access public
    2221         * @var mixed
    2322         */
    2423        public $data;
     
    2726         * Response headers.
    2827         *
    2928         * @since 4.4.0
    30          * @access public
    3129         * @var array
    3230         */
    3331        public $headers;
     
    3634         * Response status.
    3735         *
    3836         * @since 4.4.0
    39          * @access public
    4037         * @var int
    4138         */
    4239        public $status;
     
    4542         * Constructor.
    4643         *
    4744         * @since 4.4.0
    48          * @access public
    4945         *
    5046         * @param mixed $data    Response data. Default null.
    5147         * @param int   $status  Optional. HTTP status code. Default 200.
     
    6157         * Retrieves headers associated with the response.
    6258         *
    6359         * @since 4.4.0
    64          * @access public
    6560         *
    6661         * @return array Map of header name to header value.
    6762         */
     
    7368         * Sets all header values.
    7469         *
    7570         * @since 4.4.0
    76          * @access public
    7771         *
    7872         * @param array $headers Map of header name to header value.
    7973         */
     
    8579         * Sets a single HTTP header.
    8680         *
    8781         * @since 4.4.0
    88          * @access public
    8982         *
    9083         * @param string $key     Header name.
    9184         * @param string $value   Header value.
     
    10497         * Retrieves the HTTP return code for the response.
    10598         *
    10699         * @since 4.4.0
    107          * @access public
    108100         *
    109101         * @return int The 3-digit HTTP status code.
    110102         */
     
    116108         * Sets the 3-digit HTTP status code.
    117109         *
    118110         * @since 4.4.0
    119          * @access public
    120111         *
    121112         * @param int $code HTTP status.
    122113         */
     
    128119         * Retrieves the response data.
    129120         *
    130121         * @since 4.4.0
    131          * @access public
    132122         *
    133123         * @return mixed Response data.
    134124         */
     
    140130         * Sets the response data.
    141131         *
    142132         * @since 4.4.0
    143          * @access public
    144133         *
    145134         * @param mixed $data Response data.
    146135         */
     
    155144         * however this may be different if you want to do custom JSON data handling.
    156145         *
    157146         * @since 4.4.0
    158          * @access public
    159147         *
    160148         * @return mixed Any JSON-serializable value.
    161149         */
  • src/wp-includes/class-wp-http-streams.php

     
    2222         * @since 2.7.0
    2323         * @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client().
    2424         *
    25          * @access public
    2625         * @param string $url The request URL.
    2726         * @param string|array $args Optional. Override the defaults.
    2827         * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
     
    380379         * Determines whether this class can be used for retrieving a URL.
    381380         *
    382381         * @static
    383          * @access public
    384382         * @since 2.7.0
    385383         * @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client().
    386384         *
  • src/wp-includes/class-wp-image-editor-gd.php

     
    1717        /**
    1818         * GD Resource.
    1919         *
    20          * @access protected
    2120         * @var resource
    2221         */
    2322        protected $image;
     
    3534         * @since 3.5.0
    3635         *
    3736         * @static
    38          * @access public
    3937         *
    4038         * @param array $args
    4139         * @return bool
     
    6159         * @since 3.5.0
    6260         *
    6361         * @static
    64          * @access public
    6562         *
    6663         * @param string $mime_type
    6764         * @return bool
     
    8481         * Loads image from $this->file into new GD Resource.
    8582         *
    8683         * @since 3.5.0
    87          * @access public
    8884         *
    8985         * @return bool|WP_Error True if loaded successfully; WP_Error on failure.
    9086         */
     
    122118         * Sets or updates current image size.
    123119         *
    124120         * @since 3.5.0
    125          * @access protected
    126121         *
    127122         * @param int $width
    128123         * @param int $height
     
    147142         * maintain aspect ratio according to the provided dimension.
    148143         *
    149144         * @since 3.5.0
    150          * @access public
    151145         *
    152146         * @param  int|null $max_w Image width.
    153147         * @param  int|null $max_h Image height.
     
    200194         * Resize multiple images from a single source.
    201195         *
    202196         * @since 3.5.0
    203          * @access public
    204197         *
    205198         * @param array $sizes {
    206199         *     An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
     
    263256         * Crops Image.
    264257         *
    265258         * @since 3.5.0
    266          * @access public
    267259         *
    268260         * @param int  $src_x   The start x position to crop from.
    269261         * @param int  $src_y   The start y position to crop from.
     
    309301         * Ported from image-edit.php
    310302         *
    311303         * @since 3.5.0
    312          * @access public
    313304         *
    314305         * @param float $angle
    315306         * @return true|WP_Error
     
    335326         * Flips current image.
    336327         *
    337328         * @since 3.5.0
    338          * @access public
    339329         *
    340330         * @param bool $horz Flip along Horizontal Axis
    341331         * @param bool $vert Flip along Vertical Axis
     
    365355         * Saves current in-memory image to file.
    366356         *
    367357         * @since 3.5.0
    368          * @access public
    369358         *
    370359         * @param string|null $filename
    371360         * @param string|null $mime_type
     
    439428         * Returns stream of current image.
    440429         *
    441430         * @since 3.5.0
    442          * @access public
    443431         *
    444432         * @param string $mime_type
    445433         * @return bool
     
    464452         * Either calls editor's save function or handles file as a stream.
    465453         *
    466454         * @since 3.5.0
    467          * @access protected
    468455         *
    469456         * @param string|stream $filename
    470457         * @param callable $function
  • src/wp-includes/class-wp-image-editor-imagick.php

     
    1717        /**
    1818         * Imagick object.
    1919         *
    20          * @access protected
    2120         * @var Imagick
    2221         */
    2322        protected $image;
     
    3938         * @since 3.5.0
    4039         *
    4140         * @static
    42          * @access public
    4341         *
    4442         * @param array $args
    4543         * @return bool
     
    9896         * @since 3.5.0
    9997         *
    10098         * @static
    101          * @access public
    10299         *
    103100         * @param string $mime_type
    104101         * @return bool
     
    126123         * Loads image from $this->file into new Imagick Object.
    127124         *
    128125         * @since 3.5.0
    129          * @access public
    130126         *
    131127         * @return true|WP_Error True if loaded; WP_Error on failure.
    132128         */
     
    181177         * Sets Image Compression quality on a 1-100% scale.
    182178         *
    183179         * @since 3.5.0
    184          * @access public
    185180         *
    186181         * @param int $quality Compression Quality. Range: [1,100]
    187182         * @return true|WP_Error True if set successfully; WP_Error on failure.
     
    214209         * Sets or updates current image size.
    215210         *
    216211         * @since 3.5.0
    217          * @access protected
    218212         *
    219213         * @param int $width
    220214         * @param int $height
     
    249243         * maintain aspect ratio according to the provided dimension.
    250244         *
    251245         * @since 3.5.0
    252          * @access public
    253246         *
    254247         * @param  int|null $max_w Image width.
    255248         * @param  int|null $max_h Image height.
     
    285278         * which resizes an image to given dimensions and removes any associated profiles.
    286279         *
    287280         * @since 4.5.0
    288          * @access protected
    289281         *
    290282         * @param int    $dst_w       The destination width.
    291283         * @param int    $dst_h       The destination height.
     
    417409         * Resize multiple images from a single source.
    418410         *
    419411         * @since 3.5.0
    420          * @access public
    421412         *
    422413         * @param array $sizes {
    423414         *     An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
     
    488479         * Crops Image.
    489480         *
    490481         * @since 3.5.0
    491          * @access public
    492482         *
    493483         * @param int  $src_x The start x position to crop from.
    494484         * @param int  $src_y The start y position to crop from.
     
    535525         * Rotates current image counter-clockwise by $angle.
    536526         *
    537527         * @since 3.5.0
    538          * @access public
    539528         *
    540529         * @param float $angle
    541530         * @return true|WP_Error
     
    570559         * Flips current image.
    571560         *
    572561         * @since 3.5.0
    573          * @access public
    574562         *
    575563         * @param bool $horz Flip along Horizontal Axis
    576564         * @param bool $vert Flip along Vertical Axis
     
    594582         * Saves current image to file.
    595583         *
    596584         * @since 3.5.0
    597          * @access public
    598585         *
    599586         * @param string $destfilename
    600587         * @param string $mime_type
     
    664651         * Streams current image to browser.
    665652         *
    666653         * @since 3.5.0
    667          * @access public
    668654         *
    669655         * @param string $mime_type
    670656         * @return true|WP_Error
     
    694680         * Strips all image meta except color profiles from an image.
    695681         *
    696682         * @since 4.5.0
    697          * @access protected
    698683         *
    699684         * @return true|WP_Error True if stripping metadata was successful. WP_Error object on error.
    700685         */
     
    747732         * Increases rendering DPI and only loads first page.
    748733         *
    749734         * @since 4.7.0
    750          * @access protected
    751735         *
    752736         * @return string|WP_Error File to load or WP_Error on failure.
    753737         */
  • src/wp-includes/class-wp-image-editor.php

     
    3535         * @since 3.5.0
    3636         *
    3737         * @static
    38          * @access public
    3938         * @abstract
    4039         *
    4140         * @param array $args
     
    5251         * @since 3.5.0
    5352         *
    5453         * @static
    55          * @access public
    5654         * @abstract
    5755         *
    5856         * @param string $mime_type
     
    6664         * Loads image from $this->file into editor.
    6765         *
    6866         * @since 3.5.0
    69          * @access public
    7067         * @abstract
    7168         *
    7269         * @return bool|WP_Error True if loaded; WP_Error on failure.
     
    7774         * Saves current image to file.
    7875         *
    7976         * @since 3.5.0
    80          * @access public
    8177         * @abstract
    8278         *
    8379         * @param string $destfilename
     
    9490         * maintain aspect ratio according to the provided dimension.
    9591         *
    9692         * @since 3.5.0
    97          * @access public
    9893         * @abstract
    9994         *
    10095         * @param  int|null $max_w Image width.
     
    108103         * Resize multiple images from a single source.
    109104         *
    110105         * @since 3.5.0
    111          * @access public
    112106         * @abstract
    113107         *
    114108         * @param array $sizes {
     
    128122         * Crops Image.
    129123         *
    130124         * @since 3.5.0
    131          * @access public
    132125         * @abstract
    133126         *
    134127         * @param int $src_x The start x position to crop from.
     
    146139         * Rotates current image counter-clockwise by $angle.
    147140         *
    148141         * @since 3.5.0
    149          * @access public
    150142         * @abstract
    151143         *
    152144         * @param float $angle
     
    158150         * Flips current image.
    159151         *
    160152         * @since 3.5.0
    161          * @access public
    162153         * @abstract
    163154         *
    164155         * @param bool $horz Flip along Horizontal Axis
     
    171162         * Streams current image to browser.
    172163         *
    173164         * @since 3.5.0
    174          * @access public
    175165         * @abstract
    176166         *
    177167         * @param string $mime_type
     
    183173         * Gets dimensions of image.
    184174         *
    185175         * @since 3.5.0
    186          * @access public
    187176         *
    188177         * @return array {'width'=>int, 'height'=>int}
    189178         */
     
    195184         * Sets current image size.
    196185         *
    197186         * @since 3.5.0
    198          * @access protected
    199187         *
    200188         * @param int $width
    201189         * @param int $height
     
    213201         * Gets the Image Compression quality on a 1-100% scale.
    214202         *
    215203         * @since 4.0.0
    216          * @access public
    217204         *
    218205         * @return int $quality Compression Quality. Range: [1,100]
    219206         */
     
    229216         * Sets Image Compression quality on a 1-100% scale.
    230217         *
    231218         * @since 3.5.0
    232          * @access public
    233219         *
    234220         * @param int $quality Compression Quality. Range: [1,100]
    235221         * @return true|WP_Error True if set successfully; WP_Error on failure.
     
    298284         * Provides corrected filename only if filename is provided.
    299285         *
    300286         * @since 3.5.0
    301          * @access protected
    302287         *
    303288         * @param string $filename
    304289         * @param string $mime_type
     
    359344         * Builds an output filename based on current file, and adding proper suffix
    360345         *
    361346         * @since 3.5.0
    362          * @access public
    363347         *
    364348         * @param string $suffix
    365349         * @param string $dest_path
     
    387371         * Builds and returns proper suffix for file based on height and width.
    388372         *
    389373         * @since 3.5.0
    390          * @access public
    391374         *
    392375         * @return false|string suffix
    393376         */
     
    402385         * Either calls editor's save function or handles file as a stream.
    403386         *
    404387         * @since 3.5.0
    405          * @access protected
    406388         *
    407389         * @param string|stream $filename
    408390         * @param callable $function
     
    445427         * @since 3.5.0
    446428         *
    447429         * @static
    448          * @access protected
    449430         *
    450431         * @param string $extension
    451432         * @return string|false
     
    473454         * @since 3.5.0
    474455         *
    475456         * @static
    476          * @access protected
    477457         *
    478458         * @param string $mime_type
    479459         * @return string|false
  • src/wp-includes/class-wp-list-util.php

     
    1818         * The input array.
    1919         *
    2020         * @since 4.7.0
    21          * @access private
    2221         * @var array
    2322         */
    2423        private $input = array();
     
    2726         * The output array.
    2827         *
    2928         * @since 4.7.0
    30          * @access private
    3129         * @var array
    3230         */
    3331        private $output = array();
     
    3634         * Temporary arguments for sorting.
    3735         *
    3836         * @since 4.7.0
    39          * @access private
    4037         * @var array
    4138         */
    4239        private $orderby = array();
     
    5855         * Returns the original input array.
    5956         *
    6057         * @since 4.7.0
    61          * @access public
    6258         *
    6359         * @return array The input array.
    6460         */
     
    7066         * Returns the output array.
    7167         *
    7268         * @since 4.7.0
    73          * @access public
    7469         *
    7570         * @return array The output array.
    7671         */
     
    228223         * Callback to sort the list by specific fields.
    229224         *
    230225         * @since 4.7.0
    231          * @access private
    232226         *
    233227         * @see WP_List_Util::sort()
    234228         *
  • src/wp-includes/class-wp-locale-switcher.php

     
    1717         * Locale stack.
    1818         *
    1919         * @since 4.7.0
    20          * @access private
    2120         * @var string[]
    2221         */
    2322        private $locales = array();
     
    2625         * Original locale.
    2726         *
    2827         * @since 4.7.0
    29          * @access private
    3028         * @var string
    3129         */
    3230        private $original_locale;
     
    3533         * Holds all available languages.
    3634         *
    3735         * @since 4.7.0
    38          * @access private
    3936         * @var array An array of language codes (file names without the .mo extension).
    4037         */
    4138        private $available_languages = array();
     
    184181         * When switching to a locale, translations for this locale must be loaded from scratch.
    185182         *
    186183         * @since 4.7.0
    187          * @access private
    188184         *
    189185         * @global Mo[] $l10n An array of all currently loaded text domains.
    190186         *
     
    214210         * all post type labels.
    215211         *
    216212         * @since 4.7.0
    217          * @access private
    218213         *
    219214         * @global WP_Locale $wp_locale The WordPress date and time locale object.
    220215         *
  • src/wp-includes/class-wp-locale.php

     
    9999         * The thousands separator and decimal point values used for localizing numbers.
    100100         *
    101101         * @since 2.3.0
    102          * @access public
    103102         * @var array
    104103         */
    105104        public $number_format;
     
    122121         * specific calendar names and text direction.
    123122         *
    124123         * @since 2.1.0
    125          * @access public
    126124         *
    127125         * @global string $text_direction
    128126         */
     
    240238         * Outputs an admin notice if the /build directory must be used for RTL.
    241239         *
    242240         * @since 3.8.0
    243          * @access public
    244241         */
    245242        public function rtl_src_admin_notice() {
    246243                /* translators: %s: Name of the directory (build) */
     
    255252         * and ends on Saturday with is fetched by using 6 (six).
    256253         *
    257254         * @since 2.1.0
    258          * @access public
    259255         *
    260256         * @param int $weekday_number 0 for Sunday through 6 Saturday
    261257         * @return string Full translated weekday
     
    273269         * not conflict.
    274270         *
    275271         * @since 2.1.0
    276          * @access public
    277272         *
    278273         * @param string $weekday_name
    279274         * @return string
     
    289284         * full weekday word.
    290285         *
    291286         * @since 2.1.0
    292          * @access public
    293287         *
    294288         * @param string $weekday_name Full translated weekday word
    295289         * @return string Translated weekday abbreviation
     
    310304         * '0' before the numbers less than 10 for you.
    311305         *
    312306         * @since 2.1.0
    313          * @access public
    314307         *
    315308         * @param string|int $month_number '01' through '12'
    316309         * @return string Translated full month name
     
    326319         * translatable version of the month.
    327320         *
    328321         * @since 2.1.0
    329          * @access public
    330322         *
    331323         * @param string $month_name Translated month to get abbreviated version
    332324         * @return string Translated abbreviated month
     
    341333         * The $meridiem parameter is expected to not be translated.
    342334         *
    343335         * @since 2.1.0
    344          * @access public
    345336         *
    346337         * @param string $meridiem Either 'am', 'pm', 'AM', or 'PM'. Not translated version.
    347338         * @return string Translated version
     
    356347         * For backward compatibility only.
    357348         *
    358349         * @deprecated For backward compatibility only.
    359          * @access public
    360350         *
    361351         * @global array $weekday
    362352         * @global array $weekday_initial
  • src/wp-includes/class-wp-matchesmapregex.php

     
    1515        /**
    1616         * store for matches
    1717         *
    18          * @access private
    1918         * @var array
    2019         */
    2120        private $_matches;
     
    2322        /**
    2423         * store for mapping result
    2524         *
    26          * @access public
    2725         * @var string
    2826         */
    2927        public $output;
     
    3129        /**
    3230         * subject to perform mapping on (query string containing $matches[] references
    3331         *
    34          * @access private
    3532         * @var string
    3633         */
    3734        private $_subject;
     
    6158         * static helper function to ease use
    6259         *
    6360         * @static
    64          * @access public
    6561         *
    6662         * @param string $subject subject
    6763         * @param array  $matches data used for substitution
     
    7571        /**
    7672         * do the actual mapping
    7773         *
    78          * @access private
    7974         * @return string
    8075         */
    8176        private function _map() {
     
    8681        /**
    8782         * preg_replace_callback hook
    8883         *
    89          * @access public
    9084         * @param  array $matches preg_replace regexp matches
    9185         * @return string
    9286         */
  • src/wp-includes/class-wp-meta-query.php

     
    2626         * See WP_Meta_Query::__construct() for information on meta query arguments.
    2727         *
    2828         * @since 3.2.0
    29          * @access public
    3029         * @var array
    3130         */
    3231        public $queries = array();
     
    3534         * The relation between the queries. Can be one of 'AND' or 'OR'.
    3635         *
    3736         * @since 3.2.0
    38          * @access public
    3937         * @var string
    4038         */
    4139        public $relation;
     
    4442         * Database table to query for the metadata.
    4543         *
    4644         * @since 4.1.0
    47          * @access public
    4845         * @var string
    4946         */
    5047        public $meta_table;
     
    5350         * Column in meta_table that represents the ID of the object the metadata belongs to.
    5451         *
    5552         * @since 4.1.0
    56          * @access public
    5753         * @var string
    5854         */
    5955        public $meta_id_column;
     
    6258         * Database table that where the metadata's objects are stored (eg $wpdb->users).
    6359         *
    6460         * @since 4.1.0
    65          * @access public
    6661         * @var string
    6762         */
    6863        public $primary_table;
     
    7166         * Column in primary_table that represents the ID of the object.
    7267         *
    7368         * @since 4.1.0
    74          * @access public
    7569         * @var string
    7670         */
    7771        public $primary_id_column;
     
    8074         * A flat list of table aliases used in JOIN clauses.
    8175         *
    8276         * @since 4.1.0
    83          * @access protected
    8477         * @var array
    8578         */
    8679        protected $table_aliases = array();
     
    8982         * A flat list of clauses, keyed by clause 'name'.
    9083         *
    9184         * @since 4.2.0
    92          * @access protected
    9385         * @var array
    9486         */
    9587        protected $clauses = array();
     
    9890         * Whether the query contains any OR relations.
    9991         *
    10092         * @since 4.3.0
    101          * @access protected
    10293         * @var bool
    10394         */
    10495        protected $has_or_relation = false;
     
    109100         * @since 3.2.0
    110101         * @since 4.2.0 Introduced support for naming query clauses by associative array keys.
    111102         *
    112          * @access public
    113103         *
    114104         * @param array $meta_query {
    115105         *     Array of meta query clauses. When first-order clauses or sub-clauses use strings as
     
    153143         * Eliminates empty items and ensures that a 'relation' is set.
    154144         *
    155145         * @since 4.1.0
    156          * @access public
    157146         *
    158147         * @param array $queries Array of query clauses.
    159148         * @return array Sanitized array of query clauses.
     
    222211         * a 'value' array key.
    223212         *
    224213         * @since 4.1.0
    225          * @access protected
    226214         *
    227215         * @param array $query Meta query arguments.
    228216         * @return bool Whether the query clause is a first-order clause.
     
    235223         * Constructs a meta query based on 'meta_*' query vars
    236224         *
    237225         * @since 3.2.0
    238          * @access public
    239226         *
    240227         * @param array $qv The query variables
    241228         */
     
    283270         * Return the appropriate alias for the given meta type if applicable.
    284271         *
    285272         * @since 3.7.0
    286          * @access public
    287273         *
    288274         * @param string $type MySQL type to cast meta_value.
    289275         * @return string MySQL type.
     
    307293         * Generates SQL clauses to be appended to a main query.
    308294         *
    309295         * @since 3.2.0
    310          * @access public
    311296         *
    312297         * @param string $type              Type of meta, eg 'user', 'post'.
    313298         * @param string $primary_table     Database table where the object being filtered is stored (eg wp_users).
     
    365350         * out to maintain parity with the other Query classes.
    366351         *
    367352         * @since 4.1.0
    368          * @access protected
    369353         *
    370354         * @return array {
    371355         *     Array containing JOIN and WHERE SQL clauses to append to the main query.
     
    396380         * produce the properly nested SQL.
    397381         *
    398382         * @since 4.1.0
    399          * @access protected
    400383         *
    401384         * @param array $query Query to parse, passed by reference.
    402385         * @param int   $depth Optional. Number of tree levels deep we currently are.
     
    480463         * "First-order" means that it's an array with a 'key' or 'value'.
    481464         *
    482465         * @since 4.1.0
    483          * @access public
    484466         *
    485467         * @global wpdb $wpdb WordPress database abstraction object.
    486468         *
     
    658640         * a value of 'orderby' corresponding to a meta clause.
    659641         *
    660642         * @since 4.2.0
    661          * @access public
    662643         *
    663644         * @return array Meta clauses.
    664645         */
     
    681662         * connected by the relation 'OR'.
    682663         *
    683664         * @since 4.1.0
    684          * @access protected
    685665         *
    686666         * @param  array       $clause       Query clause.
    687667         * @param  array       $parent_query Parent query of $clause.
  • src/wp-includes/class-wp-metadata-lazyloader.php

     
    3333         * Pending objects queue.
    3434         *
    3535         * @since 4.5.0
    36          * @access protected
    3736         * @var array
    3837         */
    3938        protected $pending_objects;
     
    4241         * Settings for supported object types.
    4342         *
    4443         * @since 4.5.0
    45          * @access protected
    4644         * @var array
    4745         */
    4846        protected $settings = array();
     
    5149         * Constructor.
    5250         *
    5351         * @since 4.5.0
    54          * @access public
    5552         */
    5653        public function __construct() {
    5754                $this->settings = array(
     
    7067         * Adds objects to the metadata lazy-load queue.
    7168         *
    7269         * @since 4.5.0
    73          * @access public
    7470         *
    7571         * @param string $object_type Type of object whose meta is to be lazy-loaded. Accepts 'term' or 'comment'.
    7672         * @param array  $object_ids  Array of object IDs.
     
    112108         * Resets lazy-load queue for a given object type.
    113109         *
    114110         * @since 4.5.0
    115          * @access public
    116111         *
    117112         * @param string $object_type Object type. Accepts 'comment' or 'term'.
    118113         * @return bool|WP_Error True on success, WP_Error on failure.
     
    135130         * is no need to invoke it directly.
    136131         *
    137132         * @since 4.5.0
    138          * @access public
    139133         *
    140134         * @param mixed $check The `$check` param passed from the 'get_term_metadata' hook.
    141135         * @return mixed In order not to short-circuit `get_metadata()`. Generally, this is `null`, but it could be
  • src/wp-includes/class-wp-network-query.php

     
    2020         * SQL for database query.
    2121         *
    2222         * @since 4.6.0
    23          * @access public
    2423         * @var string
    2524         */
    2625        public $request;
     
    2928         * SQL query clauses.
    3029         *
    3130         * @since 4.6.0
    32          * @access protected
    3331         * @var array
    3432         */
    3533        protected $sql_clauses = array(
     
    4543         * Query vars set by the user.
    4644         *
    4745         * @since 4.6.0
    48          * @access public
    4946         * @var array
    5047         */
    5148        public $query_vars;
     
    5451         * Default values for query vars.
    5552         *
    5653         * @since 4.6.0
    57          * @access public
    5854         * @var array
    5955         */
    6056        public $query_var_defaults;
     
    6359         * List of networks located by the query.
    6460         *
    6561         * @since 4.6.0
    66          * @access public
    6762         * @var array
    6863         */
    6964        public $networks;
     
    7267         * The amount of found networks for the current query.
    7368         *
    7469         * @since 4.6.0
    75          * @access public
    7670         * @var int
    7771         */
    7872        public $found_networks = 0;
     
    8175         * The number of pages.
    8276         *
    8377         * @since 4.6.0
    84          * @access public
    8578         * @var int
    8679         */
    8780        public $max_num_pages = 0;
     
    9285         * Sets up the network query, based on the query vars passed.
    9386         *
    9487         * @since 4.6.0
    95          * @access public
    9688         *
    9789         * @param string|array $query {
    9890         *     Optional. Array or query string of network query parameters. Default empty.
     
    152144         *
    153145         * @since 4.6.0
    154146         *
    155          * @access public
    156147         *
    157148         * @param string|array $query WP_Network_Query arguments. See WP_Network_Query::__construct()
    158149         */
     
    177168         * Sets up the WordPress query for retrieving networks.
    178169         *
    179170         * @since 4.6.0
    180          * @access public
    181171         *
    182172         * @param string|array $query Array or URL query string of parameters.
    183173         * @return array|int List of networks, or number of networks when 'count' is passed as a query var.
     
    191181         * Gets a list of networks matching the query vars.
    192182         *
    193183         * @since 4.6.0
    194          * @access public
    195184         *
    196185         * @return int|array The list of networks.
    197186         */
     
    284273         * Used internally to get a list of network IDs matching the query vars.
    285274         *
    286275         * @since 4.6.0
    287          * @access protected
    288276         *
    289277         * @global wpdb $wpdb WordPress database abstraction object.
    290278         *
     
    461449         * if the limit clause was used.
    462450         *
    463451         * @since 4.6.0
    464          * @access private
    465452         *
    466453         * @global wpdb $wpdb WordPress database abstraction object.
    467454         */
     
    487474         * Used internally to generate an SQL string for searching across multiple columns.
    488475         *
    489476         * @since 4.6.0
    490          * @access protected
    491477         *
    492478         * @global wpdb  $wpdb WordPress database abstraction object.
    493479         *
     
    513499         * Parses and sanitizes 'orderby' keys passed to the network query.
    514500         *
    515501         * @since 4.6.0
    516          * @access protected
    517502         *
    518503         * @global wpdb $wpdb WordPress database abstraction object.
    519504         *
     
    547532         * Parses an 'order' query variable and cast it to 'ASC' or 'DESC' as necessary.
    548533         *
    549534         * @since 4.6.0
    550          * @access protected
    551535         *
    552536         * @param string $order The 'order' query variable.
    553537         * @return string The sanitized 'order' query variable.
  • src/wp-includes/class-wp-network.php

     
    3030         * @since 4.6.0 Converted from public to private to explicitly enable more intuitive
    3131         *              access via magic methods. As part of the access change, the type was
    3232         *              also changed from `string` to `int`.
    33          * @access private
    3433         * @var int
    3534         */
    3635        private $id;
     
    3938         * Domain of the network.
    4039         *
    4140         * @since 4.4.0
    42          * @access public
    4341         * @var string
    4442         */
    4543        public $domain = '';
     
    4846         * Path of the network.
    4947         *
    5048         * @since 4.4.0
    51          * @access public
    5249         * @var string
    5350         */
    5451        public $path = '';
     
    6259         * A numeric string, for compatibility reasons.
    6360         *
    6461         * @since 4.4.0
    65          * @access private
    6662         * @var string
    6763         */
    6864        private $blog_id = '0';
     
    7167         * Domain used to set cookies for this network.
    7268         *
    7369         * @since 4.4.0
    74          * @access public
    7570         * @var string
    7671         */
    7772        public $cookie_domain = '';
     
    8277         * Named "site" vs. "network" for legacy reasons.
    8378         *
    8479         * @since 4.4.0
    85          * @access public
    8680         * @var string
    8781         */
    8882        public $site_name = '';
     
    9185         * Retrieve a network from the database by its ID.
    9286         *
    9387         * @since 4.4.0
    94          * @access public
    9588         *
    9689         * @global wpdb $wpdb WordPress database abstraction object.
    9790         *
     
    128121         * default properties based on that information.
    129122         *
    130123         * @since 4.4.0
    131          * @access public
    132124         *
    133125         * @param WP_Network|object $network A network object.
    134126         */
     
    147139         * Allows current multisite naming conventions when getting properties.
    148140         *
    149141         * @since 4.6.0
    150          * @access public
    151142         *
    152143         * @param string $key Property to get.
    153144         * @return mixed Value of the property. Null if not available.
     
    171162         * Allows current multisite naming conventions when checking for properties.
    172163         *
    173164         * @since 4.6.0
    174          * @access public
    175165         *
    176166         * @param string $key Property to check if set.
    177167         * @return bool Whether the property is set.
     
    193183         * Allows current multisite naming conventions while setting properties.
    194184         *
    195185         * @since 4.6.0
    196          * @access public
    197186         *
    198187         * @param string $key   Property to set.
    199188         * @param mixed  $value Value to assign to the property.
     
    216205         * Set the site name assigned to the network if one has not been populated.
    217206         *
    218207         * @since 4.4.0
    219          * @access private
    220208         */
    221209        private function _set_site_name() {
    222210                if ( ! empty( $this->site_name ) ) {
     
    234222         * @todo What if the domain of the network doesn't match the current site?
    235223         *
    236224         * @since 4.4.0
    237          * @access private
    238225         */
    239226        private function _set_cookie_domain() {
    240227                if ( ! empty( $this->cookie_domain ) ) {
     
    258245         * requested site address.
    259246         *
    260247         * @since 4.4.0
    261          * @access public
    262248         * @static
    263249         *
    264250         * @param string   $domain   Domain to check.
  • src/wp-includes/class-wp-oembed-controller.php

     
    2020         * Register the oEmbed REST API route.
    2121         *
    2222         * @since 4.4.0
    23          * @access public
    2423         */
    2524        public function register_routes() {
    2625                /**
     
    101100         * Returns the JSON object for the post.
    102101         *
    103102         * @since 4.4.0
    104          * @access public
    105103         *
    106104         * @param WP_REST_Request $request Full data about the request.
    107105         * @return WP_Error|array oEmbed response data or WP_Error on failure.
     
    132130         * Checks if current user can make a proxy oEmbed request.
    133131         *
    134132         * @since 4.8.0
    135          * @access public
    136133         *
    137134         * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
    138135         */
     
    149146         * Returns the JSON object for the proxied item.
    150147         *
    151148         * @since 4.8.0
    152          * @access public
    153149         *
    154150         * @see WP_oEmbed::get_html()
    155151         * @param WP_REST_Request $request Full data about the request.
  • src/wp-includes/class-wp-post-type.php

     
    1919         * Post type key.
    2020         *
    2121         * @since 4.6.0
    22          * @access public
    2322         * @var string $name
    2423         */
    2524        public $name;
     
    2827         * Name of the post type shown in the menu. Usually plural.
    2928         *
    3029         * @since 4.6.0
    31          * @access public
    3230         * @var string $label
    3331         */
    3432        public $label;
     
    4240         * @see get_post_type_labels()
    4341         *
    4442         * @since 4.6.0
    45          * @access public
    4643         * @var object $labels
    4744         */
    4845        public $labels;
     
    5350         * Default empty.
    5451         *
    5552         * @since 4.6.0
    56          * @access public
    5753         * @var string $description
    5854         */
    5955        public $description = '';
     
    6763         * Default false.
    6864         *
    6965         * @since 4.6.0
    70          * @access public
    7166         * @var bool $public
    7267         */
    7368        public $public = false;
     
    7873         * Default false.
    7974         *
    8075         * @since 4.6.0
    81          * @access public
    8276         * @var bool $hierarchical
    8377         */
    8478        public $hierarchical = false;
     
    9084         * Default is the opposite value of $public.
    9185         *
    9286         * @since 4.6.0
    93          * @access public
    9487         * @var bool $exclude_from_search
    9588         */
    9689        public $exclude_from_search = null;
     
    10699         * Default is the value of $public.
    107100         *
    108101         * @since 4.6.0
    109          * @access public
    110102         * @var bool $publicly_queryable
    111103         */
    112104        public $publicly_queryable = null;
     
    117109         * Default is the value of $public.
    118110         *
    119111         * @since 4.6.0
    120          * @access public
    121112         * @var bool $show_ui
    122113         */
    123114        public $show_ui = null;
     
    132123         * Default is the value of $show_ui.
    133124         *
    134125         * @since 4.6.0
    135          * @access public
    136126         * @var bool $show_in_menu
    137127         */
    138128        public $show_in_menu = null;
     
    143133         * Default is the value $public.
    144134         *
    145135         * @since 4.6.0
    146          * @access public
    147136         * @var bool $show_in_nav_menus
    148137         */
    149138        public $show_in_nav_menus = null;
     
    154143         * Default is the value of $show_in_menu.
    155144         *
    156145         * @since 4.6.0
    157          * @access public
    158146         * @var bool $show_in_admin_bar
    159147         */
    160148        public $show_in_admin_bar = null;
     
    165153         * To work, $show_in_menu must be true. Default null (at the bottom).
    166154         *
    167155         * @since 4.6.0
    168          * @access public
    169156         * @var int $menu_position
    170157         */
    171158        public $menu_position = null;
     
    181168         * Defaults to use the posts icon.
    182169         *
    183170         * @since 4.6.0
    184          * @access public
    185171         * @var string $menu_icon
    186172         */
    187173        public $menu_icon = null;
     
    194180         * array( 'story', 'stories' ). Default 'post'.
    195181         *
    196182         * @since 4.6.0
    197          * @access public
    198183         * @var string $capability_type
    199184         */
    200185        public $capability_type = 'post';
     
    205190         * Default false.
    206191         *
    207192         * @since 4.6.0
    208          * @access public
    209193         * @var bool $map_meta_cap
    210194         */
    211195        public $map_meta_cap = false;
     
    216200         * Do `remove_meta_box()` and `add_meta_box()` calls in the callback. Default null.
    217201         *
    218202         * @since 4.6.0
    219          * @access public
    220203         * @var string $register_meta_box_cb
    221204         */
    222205        public $register_meta_box_cb = null;
     
    229212         * Default empty array.
    230213         *
    231214         * @since 4.6.0
    232          * @access public
    233215         * @var array $taxonomies
    234216         */
    235217        public $taxonomies = array();
     
    240222         * Will generate the proper rewrite rules if $rewrite is enabled. Default false.
    241223         *
    242224         * @since 4.6.0
    243          * @access public
    244225         * @var bool|string $has_archive