🔞 ADULT: Changeset/ - Full Gallery 2025

Changeset 1916639


Ignore:
Timestamp:
07/29/2018 10:07:56 PM (7 years ago)
Author:
Kelderic
Message:

Tweak readme.txt

File:
1 edited

Legend:

Unmodified
Added
Removed
  • featured-galleries/tags/2.0.0/readme.txt

    r1916635 r1916639  
    2626Just 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.
    2727
    28 == Parameters: ==
     28**Parameters:**
    2929
    3030    $galleryArray = get_post_gallery_ids( $postID, $maxImages, $returnType );
    3131
    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.
     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.
    3737 
    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.
     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.
    5151
    5252
Note: See TracChangeset for help on using the changeset viewer.