-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Try adjusting how Codesniffing is done
- Loading branch information
Showing
19 changed files
with
466 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"namespace": "Simple_Location", | ||
"base_dir": ".", | ||
"wiki_directory": "hook_docs", | ||
"github_blob_url": "https://github.com/dshanske/simple-location/blob/main/", | ||
"ignore_filter": [ | ||
"widget_title", | ||
"wp_read_image_metadata_types", | ||
"wp_date" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
|
||
## class-elevation-provider.php | ||
|
||
- [`sloc_elevation_provider_defaults`](sloc_elevation_provider_defaults) | ||
|
||
## class-geo-base.php | ||
|
||
- [`simple_location_sidebox`](simple_location_sidebox) | ||
- [`sloc_post_types`](sloc_post_types) | ||
|
||
## class-geo-data.php | ||
|
||
- [`simple_location_display_defaults`](simple_location_display_defaults) HTML type to wrap the entire location in | ||
- [`sloc_geo_taxonomies`](sloc_geo_taxonomies) | ||
|
||
## class-geo-provider.php | ||
|
||
- [`location_display_name`](location_display_name) | ||
- [`sloc_geo_provider_defaults`](sloc_geo_provider_defaults) | ||
|
||
## class-loc-config.php | ||
|
||
- [`default_sloc_aspect_ratios`](default_sloc_aspect_ratios) | ||
|
||
## class-location-provider.php | ||
|
||
- [`sloc_location_provider_defaults`](sloc_location_provider_defaults) | ||
|
||
## class-post-venue.php | ||
|
||
- [`pre_at_venue`](pre_at_venue) Short-circuits the checking for a venue if it is not stored as normal. | ||
- [`pre_nearby_venue`](pre_nearby_venue) Short-circuits the checking for a venue if it is not stored as normal. | ||
|
||
## class-venue-provider.php | ||
|
||
- [`sloc_venue_provider_defaults`](sloc_venue_provider_defaults) | ||
|
||
## class-weather-provider.php | ||
|
||
- [`sloc_weather_provider_defaults`](sloc_weather_provider_defaults) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
## Auto-generated Example | ||
|
||
```php | ||
add_filter( | ||
'default_sloc_aspect_ratios', | ||
function ( array $string_list ) { | ||
// Your code here | ||
return $string_list; | ||
} | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- *`array`* `$string_list` | ||
|
||
## Files | ||
|
||
- [includes/class-loc-config.php:773](https://github.com/dshanske/simple-location/blob/main/includes/class-loc-config.php#L773) | ||
```php | ||
apply_filters( | ||
'default_sloc_aspect_ratios', | ||
array( | ||
'1.77777777778' => __( 'Widescreen', 'simple-location' ), | ||
'1' => __( 'Square', 'simple-location' ), | ||
'1.333333333' => __( 'Medium Format', 'simple-location' | ||
// ... | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
## Auto-generated Example | ||
|
||
```php | ||
add_filter( | ||
'location_display_name', | ||
function ( | ||
$display_name, | ||
$reverse | ||
) { | ||
// Your code here | ||
return $display_name; | ||
}, | ||
10, | ||
2 | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- `$display_name` Other variable names: `$return` | ||
- `$reverse` | ||
|
||
## Files | ||
|
||
- [includes/class-geo-provider.php:137](https://github.com/dshanske/simple-location/blob/main/includes/class-geo-provider.php#L137) | ||
```php | ||
apply_filters( 'location_display_name', $reverse['display_name'], $reverse ) | ||
``` | ||
|
||
- [includes/class-geo-provider.php:166](https://github.com/dshanske/simple-location/blob/main/includes/class-geo-provider.php#L166) | ||
```php | ||
apply_filters( 'location_display_name', $return, $reverse ) | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
|
||
Short-circuits the checking for a venue if it is not stored as normal. | ||
|
||
Default null. | ||
|
||
## Auto-generated Example | ||
|
||
```php | ||
add_filter( | ||
'pre_at_venue', | ||
function ( | ||
Simple_Location\mixed $value, | ||
Simple_Location\float $lat, | ||
Simple_Location\float $lnt | ||
) { | ||
// Your code here | ||
return $value; | ||
}, | ||
10, | ||
3 | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- *`Simple_Location\mixed`* `$value` The boolean value as to whether someone is at a venue. | ||
- *`Simple_Location\float`* `$lat` Latitude. | ||
- *`Simple_Location\float`* `$lnt` Longitude. | ||
|
||
## Files | ||
|
||
- [includes/class-post-venue.php:446](https://github.com/dshanske/simple-location/blob/main/includes/class-post-venue.php#L446) | ||
```php | ||
apply_filters( 'pre_at_venue', null, $lat, $lng ) | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
|
||
Short-circuits the checking for a venue if it is not stored as normal. | ||
|
||
Default null. | ||
|
||
## Auto-generated Example | ||
|
||
```php | ||
add_filter( | ||
'pre_nearby_venue', | ||
function ( | ||
Simple_Location\mixed $value, | ||
Simple_Location\float $lat, | ||
Simple_Location\float $lnt, | ||
int $radius | ||
) { | ||
// Your code here | ||
return $value; | ||
}, | ||
10, | ||
4 | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- *`Simple_Location\mixed`* `$value` The boolean value as to whether someone is at a venue. | ||
- *`Simple_Location\float`* `$lat` Latitude. | ||
- *`Simple_Location\float`* `$lnt` Longitude. | ||
- *`int`* `$radius` Radius. | ||
|
||
## Files | ||
|
||
- [includes/class-post-venue.php:377](https://github.com/dshanske/simple-location/blob/main/includes/class-post-venue.php#L377) | ||
```php | ||
apply_filters( 'pre_nearby_venue', null, $lat, $lng, $radius ) | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
|
||
HTML type to wrap the entire location in | ||
|
||
## Auto-generated Example | ||
|
||
```php | ||
add_filter( | ||
'simple_location_display_defaults', | ||
function ( $defaults ) { | ||
// Your code here | ||
return $defaults; | ||
} | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- `$defaults` | ||
|
||
## Files | ||
|
||
- [includes/class-geo-data.php:989](https://github.com/dshanske/simple-location/blob/main/includes/class-geo-data.php#L989) | ||
```php | ||
apply_filters( 'simple_location_display_defaults', $defaults ) | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
## Auto-generated Example | ||
|
||
```php | ||
add_action( | ||
'simple_location_sidebox', | ||
function ( | ||
$current_screen, | ||
$object, | ||
$args | ||
) { | ||
// Your code here | ||
}, | ||
10, | ||
3 | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- `$current_screen` | ||
- `$object` | ||
- `$args` | ||
|
||
## Files | ||
|
||
- [includes/class-geo-base.php:119](https://github.com/dshanske/simple-location/blob/main/includes/class-geo-base.php#L119) | ||
```php | ||
do_action( 'simple_location_sidebox', get_current_screen(), $object, $args ) | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
## Auto-generated Example | ||
|
||
```php | ||
add_filter( | ||
'sloc_elevation_provider_defaults', | ||
function ( $defaults ) { | ||
// Your code here | ||
return $defaults; | ||
} | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- `$defaults` | ||
|
||
## Files | ||
|
||
- [includes/class-elevation-provider.php:37](https://github.com/dshanske/simple-location/blob/main/includes/class-elevation-provider.php#L37) | ||
```php | ||
apply_filters( 'sloc_elevation_provider_defaults', $defaults ) | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
## Auto-generated Example | ||
|
||
```php | ||
add_filter( | ||
'sloc_geo_provider_defaults', | ||
function ( $defaults ) { | ||
// Your code here | ||
return $defaults; | ||
} | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- `$defaults` | ||
|
||
## Files | ||
|
||
- [includes/class-geo-provider.php:72](https://github.com/dshanske/simple-location/blob/main/includes/class-geo-provider.php#L72) | ||
```php | ||
apply_filters( 'sloc_geo_provider_defaults', $defaults ) | ||
``` | ||
|
||
- [includes/class-map-provider.php:136](https://github.com/dshanske/simple-location/blob/main/includes/class-map-provider.php#L136) | ||
```php | ||
apply_filters( 'sloc_geo_provider_defaults', $defaults ) | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
## Auto-generated Example | ||
|
||
```php | ||
add_filter( | ||
'sloc_geo_taxonomies', | ||
function ( array $string_list ) { | ||
// Your code here | ||
return $string_list; | ||
} | ||
); | ||
``` | ||
|
||
## Parameters | ||
|
||
- *`array`* `$string_list` | ||
|
||
## Files | ||
|
||
- [includes/class-geo-data.php:634](https://github.com/dshanske/simple-location/blob/main/includes/class-geo-data.php#L634) | ||
```php | ||
apply_filters( 'sloc_geo_taxonomies', array( 'venue' ) ) | ||
``` | ||
|
||
|
||
|
||
[Hooks](Hooks) |
Oops, something went wrong.