WPCasa

https://docs.wpcasa.com/
Admin
WPCasa is a WordPress real estate plugin and framework designed for creating professional real...
Tokens:157,202
Snippets:1,619
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example with id, orientation, and reset parameters

Source: https://docs.wpcasa.com/article/shortcode-wpsight_listings_search?id=145&rating=5&wpkb_action=rate

Example with parameters: sets a custom HTML ID, vertical orientation (e.g., for sidebars), and disables the reset button. The 'advanced' parameter only applies when the WPCasa Advanced Search add-on is active.

```text
[wpsight_listings_search id="supersearch" orientation="vertical" reset="false"]
```

--------------------------------

### Example with show_panel parameter

Source: https://docs.wpcasa.com/article/shortcode-wpsight_favorites

Example that hides the listings panel by setting show_panel to false. Other parameters include nr, show_paging, before, after, and wrap.

```plaintext
[wpsight_favorites show_panel="false"]
```

--------------------------------

### Example with id and vertical orientation

Source: https://docs.wpcasa.com/article/shortcode-wpsight_listing_teaser

Example with the required id parameter and the orientation parameter set to vertical, suitable for sidebars.

```text
[wpsight_listing_teaser id="ID-30" orientation="vertical"]
```

--------------------------------

### Regular listing URL example

Source: https://docs.wpcasa.com/article/wpcasa-listing-pdf?id=58&rating=5&wpkb-rated=1&wpkb_action=rate

Example URL for a regular listing page before any PDF parameters are added.

```url
http://domain.com/listing/my-example-listing
```

--------------------------------

### Example with id and full parameters

Source: https://docs.wpcasa.com/article/shortcode-wpsight_listing

Displays a listing with ID 'ID-30' and sets 'full' to 'false' to show only the teaser instead of the full listing.

```shortcode
[wpsight_listing id="ID-30" full="false"]
```

--------------------------------

### Example with parameters for [wpsight_listing_teasers]

Source: https://docs.wpcasa.com/article/shortcode-wpsight_listing_teasers

Shows 6 listings per page with the listings panel and pagination displayed. The 'nr' parameter overrides the default of 10, and 'show_panel' and 'show_paging' are set to true.

```shortcode
[wpsight_listing_teasers nr="6" show_panel="true" show_paging="true"]
```

--------------------------------

### Example: [wpsight_listings] with nr, show_panel, orderby, and order

Source: https://docs.wpcasa.com/article/shortcode-wpsight_listings

Shows 6 listings on the same page, hides the panel bar before the listings, and orders the listings by price in descending order.

```text
[wpsight_listings nr="6" show_panel="false" orderby="price" order="desc"]
```

--------------------------------

### Example: [wpsight_listings] with offer and location

Source: https://docs.wpcasa.com/article/shortcode-wpsight_listings

Displays the latest listings from multiple locations by setting the offer parameter to "rent" and the location parameter to "marbella,madrid".

```text
[wpsight_listings offer="rent" location="marbella,madrid"]
```

--------------------------------

### Example with exclude and show_archive parameters

Source: https://docs.wpcasa.com/article/shortcode-wpsight_list_agents?id=268&rating=5&wpkb-rated=1&wpkb_action=rate

Excludes user IDs 2 and 5 and hides the 'My Listings' link by setting show_archive to false.

```shortcode
[wpsight_list_agents exclude="2,5" show_archive="false"]
```

--------------------------------

### Example with custom currencies and ID

Source: https://docs.wpcasa.com/article/shortcode-wpsight_currency_converter

Example with custom currencies and ID. The currencies parameter accepts a comma-separated list of three-letter currency codes, and the id parameter sets the HTML ID for the select dropdown.

```text
[wpsight_currency_converter currencies="eur,usd,gbp" id="my-custom-select"]
```

--------------------------------

### WPCasa Currency Converter shortcode

Source: https://docs.wpcasa.com/article/wpcasa-currency-converter

Use the shortcode to display the currency converter dropdown. The first example shows the default shortcode with no parameters. The second example adds the currencies parameter with a comma-separated list of three-letter currency codes to change the available options.

```text
[wpsight_currency_converter]
```

```text
[wpsight_currency_converter currencies="eur,usd,gbp"]
```

--------------------------------

### Add custom listing offer and color

Source: https://docs.wpcasa.com/article/snippet-add-custom-listing-offer?id=461&rating=5&wpkb-rated=1&wpkb_action=rate

Use the wpsight_offers filter to register a new offer type and the wpsight_get_offer_color filter to define its display color.

```php
<?php  
/**  
 * Add custom listing offer to default  
 * set sale and rent.  
 */  
add_filter( 'wpsight_offers', 'wpsight_offers_foreclosure' );  
  
function wpsight_offers_foreclosure( $offers ) {  
  
 $offers['foreclosure'] = __( 'Foreclosure', 'wpcasa' );  
  
 return $offers;  
  
}  
  
/**  
 * Add new offer color for forclosure  
 */  
add_filter( 'wpsight_get_offer_color', 'wpsight_get_offer_color_foreclosure' );  
  
function wpsight_get_offer_color_foreclosure( $color ) {  
  
 $offer = wpsight_get_listing_offer( get_the_id(), false );  
  
 if( 'foreclosure' == $offer )  
 $color = '#d9534f';  
  
 return $color;  
  
}
```

--------------------------------

### Register custom layout via wpsight_listing_pdf_layouts

Source: https://docs.wpcasa.com/article/wpcasa-listing-pdf?id=58&rating=5&wpkb_action=rate

Example of using the wpsight_listing_pdf_layouts filter to register a new layout called 'layout-custom'. The function wpsight_listing_pdf_layout_custom adds the layout to the $layouts array and returns it.

```php
<?php  
/**  
 * Add custom listing PDF layout  
 *  
 * @param array $layouts  
 * @return array  
 */  
add_filter( 'wpsight_listing_pdf_layouts', 'wpsight_listing_pdf_layout_custom' );  
  
function wpsight_listing_pdf_layout_custom( $layouts ) {  
  
 $layouts['layout-custom'] = __( 'Custom Layout', 'wpcasa-listing-pdf' );  
  
 return $layouts;  
  
}  
```

--------------------------------

### Basic usage of [wpsight_listing] shortcode

Source: https://docs.wpcasa.com/article/shortcode-wpsight_listing

Displays a single listing using the shortcode with no parameters. The listing ID must be provided via the 'id' parameter.

```shortcode
[wpsight_listing]
```
Tokens:
Raw