mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-08 07:47:00 +02:00
Code Issues Releases Wiki Activity

Update phpdoc related to return value and options for the page preload methods

Browse Source
This commit is contained in:
Ryan Cramer
2024-11-15 15:37:22 -05:00
parent 8a1ba87298
commit a14398b4a3
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
wire/core/Page.php
View File

@@ -1207,8 +1207,9 @@ class Page extends WireData implements \Countable, WireMatchable {
* @param array $fieldNames Names of fields to preload or omit (or blank array)
* to preload all supported fields.
* @param array $options Options to modify default behavior:
* `debug` (bool): Specify true to return array of debug info (default=false).
* @return int|array Number of fields preloaded, or array of details (if debug)
* - `debug` (bool): Specify true to return additional info in returned array (default=false).
* - See the `PagesLoader::preloadFields()` method for additional options.
* @return array Array of details
* @since 3.0.243
*
*/

3
wire/core/PagesLoader.php
View File

@@ -2254,7 +2254,8 @@ class PagesLoader extends Wire {
* @param array $options
* - `debug` (bool): Specify true to return array of debug info (default=false).
* - `skipFieldNames` (array): Optional names of fields to skip over (default=[]).
* @return int|array Number of fields preloaded, or array of details (if debug)
* - See the `PagesLoader::preloadFields()` method for additional options.
* @return array Array of details
* @since 3.0.243
*
*/