regionhalland / region-halland-plugin-navigation
Requires (Dev)
- php-stubs/wordpress-stubs: ^5.7.0
- squizlabs/php_codesniffer: ^3.5
- vimeo/psalm: ^4.7.0
- wp-coding-standards/wpcs: ^2.3
README
Användningsområde
Detta plugin innehåller funktionalitet kring navigation i WordPress.
Användning
Hämta barn
Funktion
Rh\Navigation\Children::get(int $pageId = null) används för att hämta ut barn. Om $pageId är null hämtas barnen för den aktuella sidan
API
Det går även att komma åt datan via API endpointen:
/wp-json/rh/v1/navigation/children/{pageId}
Exempel på data
array(1) {
[0]=>
object(WP_Post)#5469 (26) {
["ID"]=>
int(17321)
["post_author"]=>
string(2) "39"
["post_date"]=>
string(19) "2021-09-06 09:18:11"
["post_date_gmt"]=>
string(19) "2021-09-06 07:18:11"
["post_content"]=>
string(0) ""
["post_title"]=>
string(5) "Barn1"
["post_excerpt"]=>
string(0) ""
["post_status"]=>
string(7) "publish"
["comment_status"]=>
string(6) "closed"
["ping_status"]=>
string(6) "closed"
["post_password"]=>
string(0) ""
["post_name"]=>
string(5) "barn1"
["to_ping"]=>
string(0) ""
["pinged"]=>
string(0) ""
["post_modified"]=>
string(19) "2021-09-06 09:18:11"
["post_modified_gmt"]=>
string(19) "2021-09-06 07:18:11"
["post_content_filtered"]=>
string(0) ""
["post_parent"]=>
int(17258)
["guid"]=>
string(25) "http://rh.test/std/barn1/"
["menu_order"]=>
int(0)
["post_type"]=>
string(4) "page"
["post_mime_type"]=>
string(0) ""
["comment_count"]=>
string(1) "0"
["filter"]=>
string(3) "raw"
["post_url"]=>
string(34) "http://rh.test/foraldersida/barn1/"
["ingress"]=>
NULL
}
}
Hämta syskon
Funktion
Rh\Navigation\Siblings::get(int $pageId = null, bool $hideActive = true) används för att hämta ut barn. Om $pageId är null hämtas syskon för den aktuella sidan. Om $hideActive sätts till false får man även tillbaka den aktuella sidan.
API
Det går även att komma åt datan via API endpointen:
/wp-json/rh/v1/navigation/siblings/{pageId}
Exempel på data
array(1) {
[0]=>
object(WP_Post)#5254 (27) {
["ID"]=>
int(17322)
["post_author"]=>
string(2) "39"
["post_date"]=>
string(19) "2021-09-06 09:18:19"
["post_date_gmt"]=>
string(19) "2021-09-06 07:18:19"
["post_content"]=>
string(0) ""
["post_title"]=>
string(5) "Barn2"
["post_excerpt"]=>
string(0) ""
["post_status"]=>
string(7) "publish"
["comment_status"]=>
string(6) "closed"
["ping_status"]=>
string(6) "closed"
["post_password"]=>
string(0) ""
["post_name"]=>
string(5) "barn2"
["to_ping"]=>
string(0) ""
["pinged"]=>
string(0) ""
["post_modified"]=>
string(19) "2021-09-06 13:14:27"
["post_modified_gmt"]=>
string(19) "2021-09-06 11:14:27"
["post_content_filtered"]=>
string(0) ""
["post_parent"]=>
int(17258)
["guid"]=>
string(25) "http://rh.test/std/barn2/"
["menu_order"]=>
int(1)
["post_type"]=>
string(4) "page"
["post_mime_type"]=>
string(0) ""
["comment_count"]=>
string(1) "0"
["filter"]=>
string(3) "raw"
["post_url"]=>
string(34) "http://rh.test/foraldersida/barn2/"
["ingress"]=>
string(13) "Hejsansvejsan"
["active"]=>
bool(false)
}
}
Hämta förälder
Funktion
Rh\Navigation\Parents::get(int $pageId = null) används för att hämta ut föräldern. Om $pageId är null hämtas föräldern för den aktuella sidan
API
Det går även att komma åt datan via API endpointen:
/wp-json/rh/v1/navigation/parent/{pageId}
Exempel på data
object(WP_Post)#5253 (26) {
["ID"]=>
int(17258)
["post_author"]=>
string(2) "39"
["post_date"]=>
string(19) "2020-12-04 07:50:43"
["post_date_gmt"]=>
string(19) "2020-12-04 06:50:39"
["post_content"]=>
string(56) "<!-- wp:paragraph -->
<p>Hej!</p>
<!-- /wp:paragraph -->"
["post_title"]=>
string(14) "Föräldersida"
["post_excerpt"]=>
string(0) ""
["post_status"]=>
string(7) "publish"
["comment_status"]=>
string(6) "closed"
["ping_status"]=>
string(6) "closed"
["post_password"]=>
string(0) ""
["post_name"]=>
string(12) "foraldersida"
["to_ping"]=>
string(0) ""
["pinged"]=>
string(0) ""
["post_modified"]=>
string(19) "2021-09-17 10:17:52"
["post_modified_gmt"]=>
string(19) "2021-09-17 08:17:52"
["post_content_filtered"]=>
string(0) ""
["post_parent"]=>
int(0)
["guid"]=>
string(29) "http://rh.test/?page_id=17258"
["menu_order"]=>
int(2)
["post_type"]=>
string(4) "page"
["post_mime_type"]=>
string(0) ""
["comment_count"]=>
string(1) "0"
["filter"]=>
string(3) "raw"
["post_url"]=>
string(28) "http://rh.test/foraldersida/"
["ingress"]=>
string(0) ""
}
Hämta brödsmulor
Funktion
Rh\Navigation\Breadcrumbs::get(int $pageId = null) används för att hämta ut brödsmulor. Om $pageId är null hämtas brödsmulor för den aktuella sidan
Exempel på data
array(3) {
[0]=>
array(2) {
["name"]=>
string(12) "Förstasidan"
["url"]=>
string(14) "http://rh.test"
}
[1]=>
array(2) {
["name"]=>
string(14) "Föräldersida"
["url"]=>
string(28) "http://rh.test/foraldersida/"
}
[2]=>
array(2) {
["name"]=>
string(5) "Barn1"
["url"]=>
bool(false)
}
}
Licensmodell
Denna plugin använder licensmodell GPL-3.0. Du kan läsa mer om denna licensmodell via den medföljande filen "LICENSE"
Installation och aktivering
A) Hämta pluginen via Git eller läs in det med Composer
B) Installera Region Hallands plugin i Wordpress plugin folder
C) Aktivera pluginet inifrån Wordpress admin
Hämta hem pluginet via Git
git clone https://regionhalland.visualstudio.com/public.RhWpPlugIns/_git/RhNavigation
Läs in pluginen via composer
OBS! Justera så att du hämtar aktuell version.
"require": {
"regionhalland/region-halland-plugin-navigation": "1.0.0"
},
Versionhistorik
Se CHANGELOG.md