Changeset 1916639
- Timestamp:
- 07/29/2018 10:07:56 PM (7 years ago)
- File:
-
- 1 edited
-
featured-galleries/tags/2.0.0/readme.txt (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
featured-galleries/tags/2.0.0/readme.txt
r1916635 r1916639 26 26 Just like WordPress comes with `get_post_thumbnail_id()` built-in, you can use `get_post_gallery_ids()` to call the Featured Gallery. As long as it is used inside the loop, it doesn't need to be passed any parameters. In that case, by default, it will return a PHP array with the ID's of all images in the post's Featured Gallery. However, you can also customize the returned value to suit your needs, with up to three parameters. 27 27 28 == Parameters: == 28 **Parameters:** 29 29 30 30 $galleryArray = get_post_gallery_ids( $postID, $maxImages, $returnType ); 31 31 32 $postID:33 Type: Integer34 Description: The ID of the post/page that you are loading.35 Default Value: null (which becomes the post ID of the current Post, if the function is called from inside the Loop)36 Possible Values: Any valid post ID, or null.32 * $postID: 33 * Type: Integer 34 * Description: The ID of the post/page that you are loading. 35 * Default Value: null (which becomes the post ID of the current Post, if the function is called from inside the Loop) 36 * Possible Values: Any valid post ID, or null. 37 37 38 $maxImages:39 Type: Integer40 Description: The max number of images to return. If set to -1, all images will be returned.41 Default Value: -142 Possible Values: Any integer from -1 up through infinity.43 44 $returnType:45 Type: String46 Description: The format of the returned image IDs.47 Default Value: 'array'48 Valid Values: 'array', 'string'49 'array' will cause the function to return the image IDs as a PHP array.50 'string' will cause the function to return the image IDs as a comma delimited string.38 * $maxImages: 39 * Type: Integer 40 * Description: The max number of images to return. If set to -1, all images will be returned. 41 * Default Value: -1 42 * Possible Values: Any integer from -1 up through infinity. 43 44 * $returnType: 45 * Type: String 46 * Description: The format of the returned image IDs. 47 * Default Value: 'array' 48 * Valid Values: 'array', 'string' 49 * 'array' will cause the function to return the image IDs as a PHP array. 50 * 'string' will cause the function to return the image IDs as a comma delimited string. 51 51 52 52
Note: See TracChangeset
for help on using the changeset viewer.